You are here

class BulkUploadForm in Lightning Media 8.4

Same name and namespace in other branches
  1. 8 modules/lightning_media_bulk_upload/src/Form/BulkUploadForm.php \Drupal\lightning_media_bulk_upload\Form\BulkUploadForm
  2. 8.2 modules/lightning_media_bulk_upload/src/Form/BulkUploadForm.php \Drupal\lightning_media_bulk_upload\Form\BulkUploadForm
  3. 8.3 modules/lightning_media_bulk_upload/src/Form/BulkUploadForm.php \Drupal\lightning_media_bulk_upload\Form\BulkUploadForm

A form for uploading multiple media assets at once.

Hierarchy

Expanded class hierarchy of BulkUploadForm

1 string reference to 'BulkUploadForm'
lightning_media_bulk_upload.routing.yml in modules/lightning_media_bulk_upload/lightning_media_bulk_upload.routing.yml
modules/lightning_media_bulk_upload/lightning_media_bulk_upload.routing.yml

File

modules/lightning_media_bulk_upload/src/Form/BulkUploadForm.php, line 18

Namespace

Drupal\lightning_media_bulk_upload\Form
View source
class BulkUploadForm extends FormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The media helper service.
   *
   * @var \Drupal\lightning_media\MediaHelper
   */
  protected $helper;

  /**
   * BulkUploadForm constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\lightning_media\MediaHelper $helper
   *   The media helper service.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $translator
   *   The string translation service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, MediaHelper $helper, TranslationInterface $translator) {
    $this->entityTypeManager = $entity_type_manager;
    $this->helper = $helper;
    $this
      ->setStringTranslation($translator);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('lightning.media_helper'), $container
      ->get('string_translation'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'bulk_upload_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $extensions = $this->helper
      ->getFileExtensions(TRUE);
    $form['dropzone'] = [
      '#type' => 'dropzonejs',
      '#dropzone_description' => $this
        ->t('Drag files here to upload them'),
      '#extensions' => implode(' ', $extensions),
    ];
    $form['continue'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Continue'),
    ];

    // Support both Drupal 8.7's API and its antecedents. We need to call
    // file_upload_max_size() as a string in order to prevent deprecation
    // testing failures.
    $max_size = version_compare(\Drupal::VERSION, '8.7.0', '>=') ? Environment::getUploadMaxSize() : call_user_func('file_upload_max_size');
    $variables = [
      '@max_size' => static::bytesToString($max_size),
      '@extensions' => Element::oxford($extensions, $this
        ->t('and')),
    ];
    $form['dropzone']['#description'] = $this
      ->t('You can upload as many files as you like. Each file can be up to @max_size in size. The following file extensions are accepted: @extensions', $variables);
    return $form;
  }

  /**
   * Converts a number of bytes into a human-readable string.
   *
   * @param int $bytes
   *   A number of bytes.
   *
   * @return string
   *   The human-readable measurement, like '2 MB' or '10 GB'.
   */
  public static function bytesToString($bytes) {
    $units = array_map('t', [
      'bytes',
      'KB',
      'MB',
      'GB',
      'TB',
    ]);
    while ($bytes > 1024) {
      $bytes /= 1024;
      array_shift($units);
    }
    return $bytes . ' ' . reset($units);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $bulk_create = [];
    $uploads = $form_state
      ->getValue([
      'dropzone',
      'uploaded_files',
    ]);
    foreach ($uploads as $upload) {

      // Create a file entity for the temporary file.

      /** @var \Drupal\file\FileInterface $file */
      $file = $this->entityTypeManager
        ->getStorage('file')
        ->create([
        'uri' => $upload['path'],
        'uid' => $this
          ->currentUser()
          ->id(),
      ]);
      $file
        ->setTemporary();
      $file
        ->save();
      try {
        $entity = $this->helper
          ->createFromInput($file);
      } catch (IndeterminateBundleException $e) {
        $this
          ->messenger()
          ->addError((string) $e);
        continue;
      }
      $file = MediaHelper::useFile($entity, $file);
      $file
        ->setPermanent();
      $file
        ->save();
      $entity
        ->save();
      array_push($bulk_create, $bulk_create ? $entity
        ->id() : $entity);
    }
    if ($bulk_create) {

      /** @var \Drupal\media\MediaInterface $entity */
      $redirect = array_shift($bulk_create)
        ->toUrl('edit-form', [
        'query' => [
          'bulk_create' => $bulk_create,
        ],
      ]);
      $form_state
        ->setRedirectUrl($redirect);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BulkUploadForm::$entityTypeManager protected property The entity type manager.
BulkUploadForm::$helper protected property The media helper service.
BulkUploadForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
BulkUploadForm::bytesToString public static function Converts a number of bytes into a human-readable string.
BulkUploadForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
BulkUploadForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
BulkUploadForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
BulkUploadForm::__construct public function BulkUploadForm constructor.
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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.