class File in Zircon Profile 8

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:

• #multiple: A Boolean indicating whether multiple files may be uploaded.
• #size: The size of the file input element in characters.

Plugin annotation

@FormElement("file");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
        • class \Drupal\Core\Render\Element\File

23 string references to 'File'

DirectoryTest::testFileCheckDirectoryHandling in core/modules/system/src/Tests/File/DirectoryTest.php

Test directory handling functions.

DirectoryTest::testFileCheckLocalDirectoryHandling in core/modules/system/src/Tests/File/DirectoryTest.php

Test local directory handling functions.

DirectoryTest::testFileCreateNewFilepath in core/modules/system/src/Tests/File/DirectoryTest.php

This will take a directory and path, and find a valid filepath that is not taken by another file.

DirectoryTest::testFileDestination in core/modules/system/src/Tests/File/DirectoryTest.php

This will test the filepath for a destination based on passed flags and whether or not the file exists.

file.destination.schema.yml in core/modules/file/config/schema/file.destination.schema.yml

core/modules/file/config/schema/file.destination.schema.yml

... See full list

10 #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.

FormTest::testRequiredFields in core/modules/system/src/Tests/Form/FormTest.php

Check several empty values for required forms elements.

FormTestDisabledElementsForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestDisabledElementsForm.php

Form constructor.

ImportForm::buildForm in core/modules/locale/src/Form/ImportForm.php

Form constructor for the translation import screen.

... See full list

File

core/lib/Drupal/Core/Render/Element/File.php, line 25

Contains \Drupal\Core\Render\Element\File.

Namespace

Drupal\Core\Render\Element

class File extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return array(
      '#input' => TRUE,
      '#multiple' => FALSE,
      '#process' => array(
        array(
          $class,
          'processFile',
        ),
      ),
      '#size' => 60,
      '#pre_render' => array(
        array(
          $class,
          'preRenderFile',
        ),
      ),
      '#theme' => 'input__file',
      '#theme_wrappers' => array(
        'form_element',
      ),
    );
  }

  /**
   * 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'] = array(
        '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.inc.
   *
   * @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, array(
      'id',
      'name',
      'size',
    ));
    static::setAttributes($element, array(
      'js-form-file',
      'form-file',
    ));
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
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.
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	69
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.