class Upload in Lightning Media 8

A form element to handle file uploads.

Plugin annotation

@FormElement("upload");

Hierarchy

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

4 string references to 'Upload'

entity_browser.browser.image_browser.yml in modules/lightning_media_image/config/install/entity_browser.browser.image_browser.yml

modules/lightning_media_image/config/install/entity_browser.browser.image_browser.yml

entity_browser.browser.media_browser.yml in config/install/entity_browser.browser.media_browser.yml

config/install/entity_browser.browser.media_browser.yml

InteractiveUpload::process in src/Element/InteractiveUpload.php

Processes the element.

MediaBrowserContext::upload in tests/contexts/MediaBrowserContext.behat.inc

Uploads a file in the media browser.

1 #type use of Upload

InteractiveUpload::process in src/Element/InteractiveUpload.php

Processes the element.

File

src/Element/Upload.php, line 15

Namespace

Drupal\lightning_media\Element

class Upload extends FileElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo();
    $info['#upload_location'] = 'public://';
    $info['#upload_validators'] = [];
    $info['#element_validate'] = [
      [
        static::class,
        'validate',
      ],
    ];
    return $info;
  }

  /**
   * Validates the uploaded file.
   *
   * @param array $element
   *   The element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current form state.
   */
  public static function validate(array &$element, FormStateInterface $form_state) {
    if ($element['#value']) {
      $file = File::load($element['#value']);
      $errors = file_validate($file, $element['#upload_validators']);
      if ($errors) {
        foreach ($errors as $error) {
          $form_state
            ->setError($element, (string) $error);
        }
        static::delete($element);
      }
    }
  }

  /**
   * Deletes the file referenced by the element.
   *
   * @param array $element
   *   The element. If set, its value should be a file entity ID.
   */
  public static function delete(array $element) {
    if ($element['#value']) {
      $file = File::load($element['#value']);
      $file
        ->delete();

      // Clean up the file system if needed.
      $uri = $file
        ->getFileUri();
      if (file_exists($uri)) {
        \Drupal::service('file_system')
          ->unlink($uri);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function processFile(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['#name'] = implode('_', $element['#parents']);
    $form_state
      ->setHasFileElement();
    return parent::processFile($element, $form_state, $complete_form);
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    $id = implode('_', $element['#parents']);
    $upload = \Drupal::request()->files
      ->get($id);
    if ($upload instanceof UploadedFile) {
      $destination = \Drupal::service('file_system')
        ->realPath($element['#upload_location']);
      $name = file_munge_filename($upload
        ->getClientOriginalName(), NULL);
      $name = file_create_filename($name, $destination);
      $name = $upload
        ->move($destination, $name)
        ->getFilename();
      $uri = $element['#upload_location'];
      if (substr($uri, -1) != '/') {
        $uri .= '/';
      }
      $uri .= $name;
      $file = File::create([
        'uri' => $uri,
        'uid' => \Drupal::currentUser()
          ->id(),
      ]);
      $file
        ->setTemporary();
      $file
        ->save();
      \Drupal::request()->files
        ->remove($id);
      return $file
        ->id();
    }
    else {
      return NULL;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
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::preRenderFile	public static	function	Prepares a #type 'file' render element for input.html.twig.
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.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
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	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.	1
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.	1
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.
Upload::delete	public static	function	Deletes the file referenced by the element.
Upload::getInfo	public	function	Returns the element properties for this element. Overrides File::getInfo
Upload::processFile	public static	function	Processes a file upload element, make use of #multiple if present. Overrides File::processFile
Upload::validate	public static	function	Validates the uploaded file.
Upload::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback