You are here

Home » API reference » Media Bulk Upload 8 » MediaBulkUploadController.php

class MediaBulkUploadController in Media Bulk Upload 8

Class MediaUploadController.

@package Drupal\media_upload\Controller

Hierarchy

Expanded class hierarchy of MediaBulkUploadController

File

src/Controller/MediaBulkUploadController.php, line 20

Namespace

Drupal\media_bulk_upload\Controller
View source 
class MediaBulkUploadController extends ControllerBase {

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

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Constructs a new MediaBulkUploadController.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, RendererInterface $renderer) {
    $this->entityTypeManager = $entity_type_manager;
    $this->renderer = $renderer;
  }

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

  /**
   * Displays add links for the available bundles.
   *
   * Redirects to the add form if there's only one bundle available.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse|array
   *   If there's only one available bundle, a redirect response.
   *   Otherwise, a render array with the add links for each bundle.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public function addLinksList() {
    $build = [
      '#theme' => 'entity_add_list',
      '#bundles' => [],
    ];
    $entity_type = $this->entityTypeManager
      ->getDefinition('media_bulk_config');
    $entity_type_label = $entity_type
      ->getSingularLabel();
    $build['#cache']['tags'] = $entity_type
      ->getListCacheTags();
    $link_text = $this
      ->t('Add a new @entity_type.', [
      '@entity_type' => $entity_type_label,
    ]);
    $link_route_name = 'entity.' . $entity_type
      ->id() . '.add_form';
    $build['#add_bundle_message'] = $this
      ->t('There is no @entity_type yet. @add_link', [
      '@entity_type' => $entity_type_label,
      '@add_link' => Link::createFromRoute($link_text, $link_route_name)
        ->toString(),
    ]);
    $mediaBulkConfigStorage = $this->entityTypeManager
      ->getStorage('media_bulk_config');
    $mediaBulkConfigEntities = $mediaBulkConfigStorage
      ->loadMultiple();
    $form_route_name = 'media_bulk_upload.upload_form';
    if (count($mediaBulkConfigEntities) == 1) {
      $mediaBulkConfigEntity = reset($mediaBulkConfigEntities);
      return $this
        ->redirect($form_route_name, [
        'media_bulk_config' => $mediaBulkConfigEntity
          ->id(),
      ]);
    }
    foreach ($mediaBulkConfigEntities as $mediaBulkConfigEntity) {
      $link = Link::createFromRoute($mediaBulkConfigEntity
        ->label(), $form_route_name, [
        'media_bulk_config' => $mediaBulkConfigEntity
          ->id(),
      ]);
      if (!$link
        ->getUrl()
        ->access()) {
        continue;
      }
      $build['#bundles'][$mediaBulkConfigEntity
        ->id()] = [
        'label' => $mediaBulkConfigEntity
          ->label(),
        'description' => '',
        'add_link' => Link::createFromRoute($mediaBulkConfigEntity
          ->label(), $form_route_name, [
          'media_bulk_config' => $mediaBulkConfigEntity
            ->id(),
        ]),
      ];
    }
    return $build;
  }

  /**
   * Access callback to validate if the user has access to the upload form list.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   User to validate access on.
   *
   * @return \Drupal\Core\Access\AccessResultAllowed|\Drupal\Core\Access\AccessResultForbidden
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public function accessList(AccountInterface $account) {
    if ($account
      ->hasPermission('administer media_bulk_upload configuration')) {
      return AccessResult::allowed();
    }
    $mediaBulkConfigStorage = $this->entityTypeManager
      ->getStorage('media_bulk_config');
    $mediaBulkConfigEntities = $mediaBulkConfigStorage
      ->loadMultiple();
    foreach ($mediaBulkConfigEntities as $mediaBulkConfig) {
      $url = Url::fromRoute('media_bulk_upload.upload_form', [
        'media_bulk_config' => $mediaBulkConfig
          ->id(),
      ]);
      if ($url
        ->access()) {
        return AccessResult::allowed();
      }
    }
    return AccessResult::forbidden('No media bulk config entity accessible for the user.');
  }

  /**
   * Access callback to validate if the user has access to a bulk upload form.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   User to validate access on.
   * @param \Drupal\media_bulk_upload\Entity\MediaBulkConfigInterface $media_bulk_config
   *   The media bulk config entity the upload form belongs to.
   *
   * @return \Drupal\Core\Access\AccessResultAllowed|\Drupal\Core\Access\AccessResultForbidden
   */
  public function accessForm(AccountInterface $account, MediaBulkConfigInterface $media_bulk_config) {
    $mediaBulkConfigId = $media_bulk_config
      ->id();
    if (!$account
      ->hasPermission("use {$mediaBulkConfigId} bulk upload form")) {
      return AccessResult::forbidden('Media Bulk Upload form is not accessible for the user.');
    }
    return AccessResult::allowed();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
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.
MediaBulkUploadController::$entityTypeManager protected property The entity type manager. Overrides ControllerBase::$entityTypeManager
MediaBulkUploadController::$renderer protected property The renderer.
MediaBulkUploadController::accessForm public function Access callback to validate if the user has access to a bulk upload form.
MediaBulkUploadController::accessList public function Access callback to validate if the user has access to the upload form list.
MediaBulkUploadController::addLinksList public function Displays add links for the available bundles.
MediaBulkUploadController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
MediaBulkUploadController::__construct public function Constructs a new MediaBulkUploadController.
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.