class BrightcoveVideoListBuilder in Brightcove Video Connect 3.x

Defines a class to build a listing of Brightcove Videos.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\brightcove\BrightcoveVideoListBuilder uses \Drupal\Core\Routing\LinkGeneratorTrait

File

src/BrightcoveVideoListBuilder.php, line 22

Namespace

Drupal\brightcove

class BrightcoveVideoListBuilder extends EntityListBuilder {
  use LinkGeneratorTrait;

  /**
   * Account proxy.
   *
   * @var \Drupal\Core\Session\AccountProxy
   */
  protected $accountProxy;

  /**
   * Date formatter.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   Entity type.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   Entity storage.
   * @param \Drupal\Core\Session\AccountProxy $account_proxy
   *   Account proxy.
   * @param \Drupal\Core\Datetime\DateFormatter $date_formatter
   *   Date formatter.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, AccountProxy $account_proxy, DateFormatter $date_formatter) {
    parent::__construct($entity_type, $storage);
    $this->accountProxy = $account_proxy;
    $this->dateFormatter = $date_formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('current_user'), $container
      ->get('date.formatter'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityIds() {
    $query = $this
      ->getStorage()
      ->getQuery()
      ->sort('changed', 'DESC');

    // Only add the pager if a limit is specified.
    if ($this->limit) {
      $query
        ->pager($this->limit);
    }
    return $query
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {

    // Assemble header columns.
    $header = [
      'video' => $this
        ->t('Video'),
      'name' => $this
        ->t('Name'),
      'status' => $this
        ->t('Status'),
      'updated' => $this
        ->t('Updated'),
      'reference_id' => $this
        ->t('Reference ID'),
      'created' => $this
        ->t('Created'),
    ];

    // Add operations header column only if the user has access.
    if ($this->accountProxy
      ->hasPermission('edit brightcove videos') || $this->accountProxy
      ->hasPermission('delete brightcove videos')) {
      $header += parent::buildHeader();
    }
    return $header;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /* @var $entity \Drupal\brightcove\Entity\BrightcoveVideo */
    if ($entity
      ->isPublished() && $this->accountProxy
      ->hasPermission('view published brightcove videos') || !$entity
      ->isPublished() && $this->accountProxy
      ->hasPermission('view unpublished brightcove videos')) {
      $name = $this
        ->l($entity
        ->label(), new Url('entity.brightcove_video.canonical', [
        'brightcove_video' => $entity
          ->id(),
      ]));
    }
    else {
      $name = $entity
        ->label();
    }

    // Get thumbnail image style and render it.
    $thumbnail = $entity
      ->getThumbnail();
    $thumbnail_image = '';
    if (!empty($thumbnail['target_id'])) {

      /** @var \Drupal\file\Entity\File $thumbnail_file */
      $thumbnail_file = File::load($thumbnail['target_id']);

      /** @var \Drupal\image\Entity\ImageStyle $image_style */
      $image_style = ImageStyle::load('brightcove_videos_list_thumbnail');
      if (!empty($thumbnail_file) && !is_null($image_style)) {
        $image_uri = $image_style
          ->buildUrl($thumbnail_file
          ->getFileUri());
        $thumbnail_image = "<img src='{$image_uri}' alt='{$entity->getName()}'>";
      }
    }

    // Assemble row.
    $row = [
      'video' => [
        'data' => [
          '#markup' => $thumbnail_image,
        ],
      ],
      'name' => $name,
      'status' => $entity
        ->isPublished() ? $this
        ->t('Active') : $this
        ->t('Inactive'),
      'updated' => $this->dateFormatter
        ->format($entity
        ->getChangedTime(), 'short'),
      'reference_id' => $entity
        ->getReferenceId(),
      'created' => $this->dateFormatter
        ->format($entity
        ->getCreatedTime(), 'short'),
    ];

    // Add operations column only if the user has access.
    if ($this->accountProxy
      ->hasPermission('edit brightcove videos') || $this->accountProxy
      ->hasPermission('delete brightcove videos')) {
      $row += parent::buildRow($entity);
    }
    return $row;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BrightcoveVideoListBuilder::$accountProxy	protected	property	Account proxy.
BrightcoveVideoListBuilder::$dateFormatter	protected	property	Date formatter.
BrightcoveVideoListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
BrightcoveVideoListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
BrightcoveVideoListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
BrightcoveVideoListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
BrightcoveVideoListBuilder::__construct	public	function	Constructor. Overrides EntityListBuilder::__construct
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	5
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	5
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityListBuilder::$entityType	protected	property	Information about the entity type.
EntityListBuilder::$entityTypeId	protected	property	The entity type ID.
EntityListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities.
EntityListBuilder::$storage	protected	property	The entity storage class.	1
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getDefaultOperations	protected	function	Gets this list's default operations.	2
EntityListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations	2
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
EntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load	4
EntityListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render	16
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.