class FileUpload in Lightning Media 8

An Entity Browser widget for creating media entities from uploaded files.

Plugin annotation

@EntityBrowserWidget(
  id = "file_upload",
  label = @Translation("File Upload"),
  description = @Translation("Allows creation of media entities from file uploads."),
)

Hierarchy

• class \Drupal\lightning_media\Plugin\EntityBrowser\Widget\EntityFormProxy extends \Drupal\entity_browser\WidgetBase
  • class \Drupal\lightning_media\Plugin\EntityBrowser\Widget\FileUpload

File

src/Plugin/EntityBrowser/Widget/FileUpload.php, line 21

Namespace

Drupal\lightning_media\Plugin\EntityBrowser\Widget

class FileUpload extends EntityFormProxy {

  /**
   * {@inheritdoc}
   */
  protected function getInputValue(FormStateInterface $form_state) {
    return $form_state
      ->getValue([
      'input',
      'fid',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareEntities(array $form, FormStateInterface $form_state) {
    $entities = parent::prepareEntities($form, $form_state);
    $get_file = function (MediaInterface $entity) {
      return MediaHelper::getSourceField($entity)->entity;
    };
    if ($this->configuration['return_file']) {
      return array_map($get_file, $entities);
    }
    else {
      return $entities;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getForm(array &$original_form, FormStateInterface $form_state, array $additional_widget_parameters) {
    $form = parent::getForm($original_form, $form_state, $additional_widget_parameters);
    $form['input'] = [
      '#type' => 'ajax_upload',
      '#title' => $this
        ->t('File'),
      '#process' => [
        [
          $this,
          'processUploadElement',
        ],
      ],
    ];
    $validators = $form_state
      ->get([
      'entity_browser',
      'widget_context',
      'upload_validators',
    ]) ?: [];

    // If the widget context didn't specify any file extension validation, add
    // it as the first validator, allowing it to accept only file extensions
    // associated with existing media bundles.
    if (empty($validators['file_validate_extensions'])) {
      $allowed_bundles = $this
        ->getAllowedBundles($form_state);
      $validators = array_merge([
        'file_validate_extensions' => [
          implode(' ', $this->helper
            ->getFileExtensions(TRUE, $allowed_bundles)),
        ],
        // This must be a function because file_validate() still thinks that
        // function_exists() is a good way to ensure callability.
        'lightning_media_validate_upload' => [
          $allowed_bundles,
        ],
      ], $validators);
    }
    $form['input']['#upload_validators'] = $validators;
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validate(array &$form, FormStateInterface $form_state) {
    $value = $this
      ->getInputValue($form_state);
    if ($value) {
      parent::validate($form, $form_state);
    }
    else {
      $form_state
        ->setError($form['widget'], $this
        ->t('You must upload a file.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submit(array &$element, array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\media\MediaInterface $entity */
    $entity = $element['entity']['#entity'];
    $file = MediaHelper::useFile($entity, MediaHelper::getSourceField($entity)->entity);
    $file
      ->setPermanent();
    $file
      ->save();
    $entity
      ->save();
    $selection = [
      $this->configuration['return_file'] ? $file : $entity,
    ];
    $this
      ->selectEntities($selection, $form_state);
  }

  /**
   * Processes the upload element.
   *
   * @param array $element
   *   The upload element.
   * @param FormStateInterface $form_state
   *   The current form state.
   *
   * @return array
   *   The processed upload element.
   */
  public function processUploadElement(array $element, FormStateInterface $form_state) {
    $element = AjaxUpload::process($element, $form_state);
    $element['upload']['#ajax']['callback'] = $element['remove']['#ajax']['callback'] = [
      static::class,
      'ajax',
    ];
    $element['remove']['#value'] = $this
      ->t('Cancel');
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function ajax(array &$form, FormStateInterface $form_state) {
    $el = AjaxUpload::el($form, $form_state);
    $wrapper = '#' . $el['#ajax']['wrapper'];
    return parent::ajax($form, $form_state)
      ->addCommand(new ReplaceCommand($wrapper, $el))
      ->addCommand(new PrependCommand($wrapper, [
      '#type' => 'status_messages',
    ]));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $configuration = parent::defaultConfiguration();
    $configuration['return_file'] = FALSE;
    return $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['return_file'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Return source file entity'),
      '#default_value' => $this->configuration['return_file'],
      '#description' => $this
        ->t('If checked, the source file(s) of the media entity will be returned from this widget.'),
    ];
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityFormProxy::$helper	protected	property	The media helper service.
EntityFormProxy::create	public static	function
EntityFormProxy::getAllowedBundles	protected	function	Returns the bundles that this widget may use.
EntityFormProxy::__construct	public	function	EntityFormProxy constructor.
FileUpload::ajax	public static	function	AJAX callback. Returns the rebuilt inline entity form. Overrides EntityFormProxy::ajax
FileUpload::buildConfigurationForm	public	function
FileUpload::defaultConfiguration	public	function	Overrides EntityFormProxy::defaultConfiguration
FileUpload::getForm	public	function	Overrides EntityFormProxy::getForm
FileUpload::getInputValue	protected	function	Returns the current input value, if any. Overrides EntityFormProxy::getInputValue
FileUpload::prepareEntities	protected	function	Overrides EntityFormProxy::prepareEntities
FileUpload::processUploadElement	public	function	Processes the upload element.
FileUpload::submit	public	function	Overrides EntityFormProxy::submit
FileUpload::validate	public	function	Overrides EntityFormProxy::validate