Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides FormInterface::buildForm

File

modules/file_example/src/Form/FileExampleReadWriteForm.php, line 63

Class

FileExampleReadWriteForm

File test form class.

Namespace

Drupal\file_example\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $default_file = $this->stateHelper
    ->getDefaultFile();
  $default_directory = $this->stateHelper
    ->getDefaultDirectory();
  $form['description'] = [
    '#markup' => $this->t('This form demonstrates the Drupal file API. Experiment with the form, and then look at the submit handlers in the code to understand the file API.'),
  ];
  $form['write_file'] = [
    '#type' => 'fieldset',
    '#title' => $this->t('Write to a file'),
  ];
  $form['write_file']['write_contents'] = [
    '#type' => 'textfield',
    '#title' => $this->t('Enter something you would like to write to a file'),
    '#default_value' => $this->t('Put some text here or just use this text'),
  ];
  $form['write_file']['destination'] = [
    '#type' => 'textfield',
    '#default_value' => $default_file,
    '#title' => $this->t('Optional: Enter the streamwrapper saying where it should be written'),
    '#description' => $this->t('This may be public://some_dir/test_file.txt or private://another_dir/some_file.txt, for example. If you include a directory, it must already exist. The default is "public://". Since this example supports session://, you can also use something like session://somefile.txt.'),
  ];
  $form['write_file']['managed_submit'] = [
    '#type' => 'submit',
    '#value' => $this->t('Write managed file'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleManagedFile',
      ],
    ],
  ];
  $form['write_file']['unmanaged_submit'] = [
    '#type' => 'submit',
    '#value' => $this->t('Write unmanaged file'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleUnmanagedFile',
      ],
    ],
  ];
  $form['write_file']['unmanaged_php'] = [
    '#type' => 'submit',
    '#value' => $this->t('Unmanaged using PHP'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleUnmanagedPhp',
      ],
    ],
  ];
  $form['fileops'] = [
    '#type' => 'fieldset',
    '#title' => $this->t('Read from a file'),
  ];
  $form['fileops']['fileops_file'] = [
    '#type' => 'textfield',
    '#default_value' => $default_file,
    '#title' => $this->t('Enter the URI of a file'),
    '#description' => $this->t('This must be a stream-type description like public://some_file.txt or http://drupal.org or private://another_file.txt or (for this example) session://yet_another_file.txt.'),
  ];
  $form['fileops']['read_submit'] = [
    '#type' => 'submit',
    '#value' => $this->t('Read the file and store it locally'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleFileRead',
      ],
    ],
  ];
  $form['fileops']['delete_submit'] = [
    '#type' => 'submit',
    '#value' => $this->t('Delete file'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleFileDelete',
      ],
    ],
  ];
  $form['fileops']['check_submit'] = [
    '#type' => 'submit',
    '#value' => $this->t('Check to see if file exists'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleFileExists',
      ],
    ],
  ];
  $form['directory'] = [
    '#type' => 'fieldset',
    '#title' => $this->t('Create or prepare a directory'),
  ];
  $form['directory']['directory_name'] = [
    '#type' => 'textfield',
    '#title' => $this->t('Directory to create/prepare/delete'),
    '#default_value' => $default_directory,
    '#description' => $this->t('This is a directory as in public://some/directory or private://another/dir.'),
  ];
  $form['directory']['create_directory'] = [
    '#type' => 'submit',
    '#value' => $this->t('Create directory'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleDirectoryCreate',
      ],
    ],
  ];
  $form['directory']['delete_directory'] = [
    '#type' => 'submit',
    '#value' => $this->t('Delete directory'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleDirectoryDelete',
      ],
    ],
  ];
  $form['directory']['check_directory'] = [
    '#type' => 'submit',
    '#value' => $this->t('Check to see if directory exists'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleDirectoryExists',
      ],
    ],
  ];
  $form['debug'] = [
    '#type' => 'fieldset',
    '#title' => $this->t('Debugging'),
  ];
  $form['debug']['show_raw_session'] = [
    '#type' => 'submit',
    '#value' => $this->t('Show raw $_SESSION contents'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleShowSession',
      ],
    ],
  ];
  $form['debug']['reset_session'] = [
    '#type' => 'submit',
    '#value' => $this->t('Reset the Session'),
    '#submit' => [
      [
        $this->submitHandlerHelper,
        'handleResetSession',
      ],
    ],
  ];
  return $form;
}