class File
Same name in this branch
- 11.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 11.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 11.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 11.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 11.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 11.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
Same name and namespace in other branches
- 9 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 9 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 9 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 9 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 9 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 9 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 9 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
- 8.9.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 8.9.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 8.9.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 8.9.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 8.9.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 8.9.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 8.9.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
- 10 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 10 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 10 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 10 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 10 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 10 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 10 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
Provides a form element for uploading a file.
If you add this element to a form the enctype="multipart/form-data" attribute will automatically be added to the form element.
Properties:
@property $multiple A Boolean indicating whether multiple files may be uploaded. @property $size The size of the file input element in characters.
The value of this form element will always be an array of \Symfony\Component\HttpFoundation\File\UploadedFile objects, regardless of whether #multiple is TRUE or FALSE
Attributes
#[FormElement('file')]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\File implements \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of File
350 string references to 'File'
- 23a7f61f-1db3-407d-a6dd-eb4731995c9f.yml in core/
tests/ fixtures/ default_content/ file/ 23a7f61f-1db3-407d-a6dd-eb4731995c9f.yml - core/tests/fixtures/default_content/file/23a7f61f-1db3-407d-a6dd-eb4731995c9f.yml
- 2b8e0616-3ef0-4a91-8cfb-b31d9128f9f8.yml in core/
tests/ fixtures/ default_content/ file/ 2b8e0616-3ef0-4a91-8cfb-b31d9128f9f8.yml - core/tests/fixtures/default_content/file/2b8e0616-3ef0-4a91-8cfb-b31d9128f9f8.yml
- 344b943c-b231-4d73-9669-0b0a2be12aa5.yml in core/
tests/ fixtures/ default_content/ media/ 344b943c-b231-4d73-9669-0b0a2be12aa5.yml - core/tests/fixtures/default_content/media/344b943c-b231-4d73-9669-0b0a2be12aa5.yml
- 7fb09f9f-ba5f-4db4-82ed-aa5ccf7d425d.yml in core/
tests/ fixtures/ default_content/ file/ 7fb09f9f-ba5f-4db4-82ed-aa5ccf7d425d.yml - core/tests/fixtures/default_content/file/7fb09f9f-ba5f-4db4-82ed-aa5ccf7d425d.yml
- a6b79928-838f-44bd-a8f0-44c2fff9e4cc.yml in core/
tests/ fixtures/ default_content/ a6b79928-838f-44bd-a8f0-44c2fff9e4cc.yml - core/tests/fixtures/default_content/a6b79928-838f-44bd-a8f0-44c2fff9e4cc.yml
12 #type uses of File
- ConfigImportForm::buildForm in core/
modules/ config/ src/ Form/ ConfigImportForm.php - Form constructor.
- FileTestForm::buildForm in core/
modules/ file/ tests/ file_test/ src/ Form/ FileTestForm.php - Form constructor.
- FileTestSaveUploadFromForm::buildForm in core/
modules/ file/ tests/ file_test/ src/ Form/ FileTestSaveUploadFromForm.php - Form constructor.
- FormElementsRenderTest::testDrupalRenderFormElements in core/
modules/ system/ tests/ src/ Kernel/ Common/ FormElementsRenderTest.php - Tests rendering form elements without using doBuildForm().
- FormTest::testRequiredFields in core/
modules/ system/ tests/ src/ Functional/ Form/ FormTest.php - Check several empty values for required forms elements.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ File.php, line 26
Namespace
Drupal\Core\Render\ElementView source
class File extends FormElementBase {
/**
* {@inheritdoc}
*/
public function getInfo() {
return [
'#input' => TRUE,
'#multiple' => FALSE,
'#process' => [
[
static::class,
'processFile',
],
],
'#size' => 60,
'#pre_render' => [
[
static::class,
'preRenderFile',
],
],
'#theme' => 'input__file',
'#theme_wrappers' => [
'form_element',
],
'#value_callback' => [
[
static::class,
'valueCallback',
],
],
];
}
/**
* Processes a file upload element, make use of #multiple if present.
*/
public static function processFile(&$element, FormStateInterface $form_state, &$complete_form) {
if ($element['#multiple']) {
$element['#attributes']['multiple'] = 'multiple';
$element['#name'] .= '[]';
}
return $element;
}
/**
* Prepares a #type 'file' render element for input.html.twig.
*
* For assistance with handling the uploaded file correctly, see the API
* provided by file.api.php.
*
* @param array $element
* An associative array containing the properties of the element.
* Properties used: #title, #name, #size, #description, #required,
* #attributes.
*
* @return array
* The $element with prepared variables ready for input.html.twig.
*/
public static function preRenderFile($element) {
$element['#attributes']['type'] = 'file';
Element::setAttributes($element, [
'id',
'name',
'size',
]);
static::setAttributes($element, [
'js-form-file',
'form-file',
]);
return $element;
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
if ($input === FALSE) {
return NULL;
}
$parents = $element['#parents'];
$element_name = array_shift($parents);
$uploaded_files = \Drupal::request()->files
->get('files', []);
$uploaded_file = $uploaded_files[$element_name] ?? NULL;
if ($uploaded_file) {
// Cast this to an array so that the structure is consistent regardless of
// whether #value is set or not.
return (array) $uploaded_file;
}
return NULL;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
File::getInfo | public | function | Returns the element properties for this element. | Overrides ElementInterface::getInfo | |
File::preRenderFile | public static | function | Prepares a #type 'file' render element for input.html.twig. | ||
File::processFile | public static | function | Processes a file upload element, make use of #multiple if present. | ||
File::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. | Overrides FormElementBase::valueCallback | |
FormElementBase::processAutocomplete | public static | function | Adds autocomplete functionality to elements. | 1 | |
FormElementBase::processPattern | public static | function | Render API callback: Handles the #pattern form element property. | 1 | |
FormElementBase::validatePattern | public static | function | Render API callback: Handles the #pattern form element property.. | 1 | |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 | |
RenderElementBase::$renderParent | protected | property | The parent element. | ||
RenderElementBase::$renderParentName | protected | property | The parent key. | ||
RenderElementBase::$storage | protected | property | The storage. | ||
RenderElementBase::addChild | public | function | Adds a child render element. | Overrides ElementInterface::addChild | |
RenderElementBase::changeType | public | function | Change the type of the element. | Overrides ElementInterface::changeType | |
RenderElementBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 2 |
RenderElementBase::createChild | public | function | Creates a render object and attaches it to the current render object. | Overrides ElementInterface::createChild | |
RenderElementBase::elementInfoManager | protected | function | Returns the element info manager. | ||
RenderElementBase::getChild | public | function | Gets a child. | Overrides ElementInterface::getChild | |
RenderElementBase::getChildren | public | function | Returns child elements. | Overrides ElementInterface::getChildren | |
RenderElementBase::initializeInternalStorage | public | function | Initialize storage. | Overrides ElementInterface::initializeInternalStorage | |
RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | |
RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | |
RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | |
RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | |
RenderElementBase::removeChild | public | function | Removes a child. | Overrides ElementInterface::removeChild | |
RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 |
RenderElementBase::setType | protected | function | Set type on initialize. | 1 | |
RenderElementBase::toRenderable | public | function | Returns a render array. | Overrides ElementInterface::toRenderable | |
RenderElementBase::__construct | public | function | Constructs a new render element object. | 6 | |
RenderElementBase::__get | public | function | Magic method: gets a property value. | ||
RenderElementBase::__isset | public | function | Magic method: checks if a property value is set. | ||
RenderElementBase::__set | public | function | Magic method: Sets a property value. | ||
RenderElementBase::__sleep | public | function | |||
RenderElementBase::__unset | public | function | Magic method: unsets a property value. | ||
RenderElementBase::__wakeup | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.