class FileTestForm
Same name in other branches
- 9 core/modules/file/tests/file_test/src/Form/FileTestForm.php \Drupal\file_test\Form\FileTestForm
- 8.9.x core/modules/file/tests/file_test/src/Form/FileTestForm.php \Drupal\file_test\Form\FileTestForm
- 11.x core/modules/file/tests/file_test/src/Form/FileTestForm.php \Drupal\file_test\Form\FileTestForm
File test form class.
Hierarchy
- class \Drupal\file_test\Form\FileTestForm implements \Drupal\Core\Form\FormInterface
Expanded class hierarchy of FileTestForm
1 string reference to 'FileTestForm'
- file_test.routing.yml in core/
modules/ file/ tests/ file_test/ file_test.routing.yml - core/modules/file/tests/file_test/file_test.routing.yml
File
-
core/
modules/ file/ tests/ file_test/ src/ Form/ FileTestForm.php, line 14
Namespace
Drupal\file_test\FormView source
class FileTestForm implements FormInterface {
/**
* {@inheritdoc}
*/
public function getFormId() {
return '_file_test_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form['file_test_upload'] = [
'#type' => 'file',
'#title' => t('Upload a file'),
];
$form['file_test_replace'] = [
'#type' => 'select',
'#title' => t('Replace existing image'),
'#options' => [
FileExists::Rename->name => new TranslatableMarkup('Appends number until name is unique'),
FileExists::Replace->name => new TranslatableMarkup('Replace the existing file'),
FileExists::Error->name => new TranslatableMarkup('Fail with an error'),
],
'#default_value' => FileExists::Rename->name,
];
$form['file_subdir'] = [
'#type' => 'textfield',
'#title' => t('Subdirectory for test file'),
'#default_value' => '',
];
$form['extensions'] = [
'#type' => 'textfield',
'#title' => t('Allowed extensions.'),
'#default_value' => '',
];
$form['allow_all_extensions'] = [
'#title' => t('Allow all extensions?'),
'#type' => 'radios',
'#options' => [
'false' => 'No',
'empty_array' => 'Empty array',
'empty_string' => 'Empty string',
],
'#default_value' => 'false',
];
$form['is_image_file'] = [
'#type' => 'checkbox',
'#title' => t('Is this an image file?'),
'#default_value' => TRUE,
];
$form['submit'] = [
'#type' => 'submit',
'#value' => t('Submit'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Process the upload and perform validation. Note: we're using the
// form value for the $replace parameter.
if (!$form_state->isValueEmpty('file_subdir')) {
$destination = 'temporary://' . $form_state->getValue('file_subdir');
\Drupal::service('file_system')->prepareDirectory($destination, FileSystemInterface::CREATE_DIRECTORY);
}
else {
$destination = FALSE;
}
// Setup validators.
$validators = [];
if ($form_state->getValue('is_image_file')) {
$validators['FileIsImage'] = [];
}
$allow = $form_state->getValue('allow_all_extensions');
if ($allow === 'empty_array') {
$validators['FileExtension'] = [];
}
elseif ($allow === 'empty_string') {
$validators['FileExtension'] = [
'extensions' => '',
];
}
elseif (!$form_state->isValueEmpty('extensions')) {
$validators['FileExtension'] = [
'extensions' => $form_state->getValue('extensions'),
];
}
// The test for \Drupal::service('file_system')->moveUploadedFile()
// triggering a warning is unavoidable. We're interested in what happens
// afterwards in file_save_upload().
if (\Drupal::state()->get('file_test.disable_error_collection')) {
define('SIMPLETEST_COLLECT_ERRORS', FALSE);
}
$file = file_save_upload('file_test_upload', $validators, $destination, 0, static::fileExistsFromName($form_state->getValue('file_test_replace')));
if ($file) {
$form_state->setValue('file_test_upload', $file);
\Drupal::messenger()->addStatus(t('File @filepath was uploaded.', [
'@filepath' => $file->getFileUri(),
]));
\Drupal::messenger()->addStatus(t('File name is @filename.', [
'@filename' => $file->getFilename(),
]));
\Drupal::messenger()->addStatus(t('File MIME type is @mimetype.', [
'@mimetype' => $file->getMimeType(),
]));
\Drupal::messenger()->addStatus(t('You WIN!'));
}
elseif ($file === FALSE) {
\Drupal::messenger()->addError(t('Epic upload FAIL!'));
}
}
/**
* Get a FileExists enum from its name.
*/
protected static function fileExistsFromName(string $name) : FileExists {
return match ($name) { FileExists::Replace->name => FileExists::Replace,
FileExists::Error->name => FileExists::Error,
default => FileExists::Rename,
};
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
FileTestForm::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | 1 |
FileTestForm::fileExistsFromName | protected static | function | Get a FileExists enum from its name. | ||
FileTestForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | 1 |
FileTestForm::submitForm | public | function | Form submission handler. | Overrides FormInterface::submitForm | |
FileTestForm::validateForm | public | function | Form validation handler. | Overrides FormInterface::validateForm |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.