You are here

class BynderMediaUsage in Bynder 4.0.x

Same name and namespace in other branches
  1. 8.3 src/Controller/BynderMediaUsage.php \Drupal\bynder\Controller\BynderMediaUsage
  2. 8 src/Controller/BynderMediaUsage.php \Drupal\bynder\Controller\BynderMediaUsage
  3. 8.2 src/Controller/BynderMediaUsage.php \Drupal\bynder\Controller\BynderMediaUsage

Controller contains methods for displaying Bynder media usage info.

Hierarchy

Expanded class hierarchy of BynderMediaUsage

File

src/Controller/BynderMediaUsage.php, line 18

Namespace

Drupal\bynder\Controller
View source
class BynderMediaUsage extends ControllerBase {

  /**
   * The Bynder API service.
   *
   * @var \Drupal\bynder\BynderApiInterface
   */
  protected $bynder;

  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

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

  /**
   * Constructs a BynderMediaUsage class instance.
   *
   * @param \Drupal\bynder\BynderApiInterface $bynder
   *   The Bynder API service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config factory.
   * @param \Drupal\Core\Render\RendererInterface $renderer_object
   *   Renderer object.
   */
  public function __construct(BynderApiInterface $bynder, ConfigFactoryInterface $config_factory, RendererInterface $renderer_object) {
    $this->bynder = $bynder;
    $this->configFactory = $config_factory;
    $this->renderer = $renderer_object;
  }

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

  /**
   * The Bynder media usage info.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Represents an HTTP request.
   *
   * @return mixed
   *   Bynder media usage list.
   */
  public function bynderMediaInfo(Request $request) {

    /** @var \Drupal\node\NodeInterface $node */
    $node = $this
      ->entityTypeManager()
      ->getStorage('node')
      ->load($request->attributes
      ->get('node'));
    $media_types = $this
      ->entityTypeManager()
      ->getStorage('media_type')
      ->loadMultiple();
    $bynder_types = array_filter($media_types, function ($type) {

      /** @var \Drupal\media\MediaTypeInterface $type */
      return $type
        ->getSource() instanceof Bynder;
    });
    $entity_reference_fields = array_filter($node
      ->getFields(), function ($field) {
      return $field instanceof EntityReferenceFieldItemList;
    });
    $header = [
      [
        'data' => $this
          ->t('Name'),
      ],
      [
        'data' => $this
          ->t('Type'),
      ],
      [
        'data' => $this
          ->t('Usage Restriction'),
      ],
      [
        'data' => $this
          ->t('Action'),
      ],
    ];
    $rows = [];
    $entities = [];

    /** @var \Drupal\Core\Field\EntityReferenceFieldItemListInterface $field */
    foreach ($entity_reference_fields as $field) {

      /** @var \Drupal\media\Entity\Media $entity */
      foreach ($field
        ->referencedEntities() as $entity) {
        if (in_array($entity
          ->bundle(), array_keys($bynder_types))) {
          $entities[] = $entity;
          $name = $entity
            ->getSource()
            ->getMetadata($entity, 'name');
          $type = $entity
            ->getSource()
            ->getMetadata($entity, 'type');
          $bynder_id = $entity
            ->getSource()
            ->getMetadata($entity, 'uuid');
          $row['name'] = $name ?: $bynder_id;
          $row['type'] = $type ?: $this
            ->t('N/A');
          $row['restriction'] = get_media_restriction($entity
            ->getSource()
            ->getMetadata($entity, 'propertyOptions'));
          $links['edit'] = [
            'title' => $this
              ->t('Edit'),
            'url' => $entity
              ->toUrl('edit-form'),
          ];
          $links['edit_on_bynder'] = [
            'title' => $this
              ->t('Edit on Bynder'),
            'url' => \bynder_media_url($entity),
          ];
          $row['actions']['data'] = [
            '#type' => 'operations',
            '#links' => $links,
          ];
          $rows[] = [
            'data' => $row,
          ];
        }
      }
    }
    $table = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t("There are no Bynder media found on the page."),
    ];
    $this->renderer
      ->addCacheableDependency($table, $node);
    $this->renderer
      ->addCacheableDependency($table, $this->configFactory
      ->get('bynder.settings'));
    foreach ($entities as $entity) {
      $this->renderer
        ->addCacheableDependency($table, $entity);
    }
    return $table;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BynderMediaUsage::$bynder protected property The Bynder API service.
BynderMediaUsage::$configFactory protected property The configuration factory. Overrides ControllerBase::$configFactory
BynderMediaUsage::$renderer protected property Renderer object.
BynderMediaUsage::bynderMediaInfo public function The Bynder media usage info.
BynderMediaUsage::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
BynderMediaUsage::__construct public function Constructs a BynderMediaUsage class instance.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type 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::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.
ControllerBase::state protected function Returns the state storage 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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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.