You are here

Home » API reference » Access unpublished 8 » AccessTokenListBuilder.php

class AccessTokenListBuilder in Access unpublished 8

Defines a class to build a listing of access token entities.

Hierarchy

Expanded class hierarchy of AccessTokenListBuilder

File

src/AccessTokenListBuilder.php, line 16

Namespace

Drupal\access_unpublished
View source 
class AccessTokenListBuilder extends EntityListBuilder {

  /**
   * The date formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * The Access Token Manager.
   *
   * @var \Drupal\access_unpublished\AccessTokenManager
   */
  protected $accessTokenManager;

  /**
   * Name of the list builder.
   *
   * @var string
   */
  protected $handlerName = 'list_builder';

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    $builder = parent::createInstance($container, $entity_type);
    $builder
      ->setDateFormatter($container
      ->get('date.formatter'));
    $builder
      ->setAccessTokenManager($container
      ->get('access_unpublished.access_token_manager'));
    return $builder;
  }

  /**
   * Sets the date formatter service.
   *
   * @param \Drupal\Core\Datetime\DateFormatterInterface $dateFormatter
   *   The date formatter service.
   */
  protected function setDateFormatter(DateFormatterInterface $dateFormatter) {
    $this->dateFormatter = $dateFormatter;
  }

  /**
   * Sets the access token manager.
   *
   * @param \Drupal\access_unpublished\AccessTokenManager $accessTokenManager
   *   The access manager.
   */
  protected function setAccessTokenManager(AccessTokenManager $accessTokenManager) {
    $this->accessTokenManager = $accessTokenManager;
  }

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

    // Enable language column and filter if multiple languages are added.
    $header = [
      'expire_date' => $this
        ->t('Expire date'),
      'host' => $this
        ->t('Parent entity'),
    ];
    return $header + parent::buildHeader();
  }

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

    /** @var \Drupal\access_unpublished\Entity\AccessToken $entity */
    $row['expire_date']['data'] = [
      '#plain_text' => $entity
        ->get('expire')->value > 0 ? $this->dateFormatter
        ->format($entity
        ->get('expire')->value, 'short') : $this
        ->t('Unlimited'),
    ];
    if ($entity
      ->isExpired()) {
      $row['expire_date']['data'] = [
        '#markup' => 'Expired token',
        '#prefix' => '<div class="access-unpublished-expired">',
        '#suffix' => '</div>',
      ];
    }
    $row['host']['data'] = [
      '#type' => 'link',
      '#title' => $entity
        ->getHost()
        ->label(),
      '#url' => $entity
        ->getHost()
        ->toUrl(),
    ];
    $row['operations']['data'] = $this
      ->buildOperations($entity);
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function buildOperations(EntityInterface $entity) {
    $build = [
      '#type' => 'operations',
      '#links' => $this
        ->getOperations($entity),
      '#attached' => [
        'library' => [
          'access_unpublished/drupal.access_unpublished.admin',
        ],
      ],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultOperations(EntityInterface $token) {

    /** @var \Drupal\access_unpublished\AccessTokenInterface $token */
    $operations = parent::getDefaultOperations($token);
    if ($token
      ->access('delete') && $token
      ->hasLinkTemplate('delete')) {
      $operations['delete'] = [
        'title' => $this
          ->t('Delete'),
        'weight' => 100,
        'url' => $this
          ->ensureDestination($token
          ->toUrl('delete', [
          'query' => [
            'handler' => $this->handlerName,
          ],
        ])),
        'attributes' => [
          'class' => [
            'use-ajax',
          ],
        ],
      ];
    }
    if ($token
      ->access('renew') && $token
      ->isExpired()) {
      $operations['renew'] = [
        'title' => $this
          ->t('Renew'),
        'url' => $this
          ->ensureDestination($token
          ->toUrl('renew', [
          'query' => [
            'handler' => $this->handlerName,
          ],
        ])),
        'weight' => 50,
        'attributes' => [
          'class' => [
            'use-ajax',
          ],
        ],
      ];
    }
    else {
      $url = $this->accessTokenManager
        ->getAccessTokenUrl($token, $token
        ->getHost()
        ->language());
      $operations['copy'] = [
        'title' => $this
          ->t('Copy'),
        'url' => Url::fromUserInput('#'),
        'attributes' => [
          'data-unpublished-access-url' => $url,
          'class' => [
            'clipboard-button',
          ],
        ],
        'weight' => 50,
      ];
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $build['table']['#id'] = Html::getUniqueId('access-token-list');
    $build['table']['#attributes']['data-drupal-selector'] = Html::getId('access-token-list');
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AccessTokenListBuilder::$accessTokenManager protected property The Access Token Manager.
AccessTokenListBuilder::$dateFormatter protected property The date formatter service.
AccessTokenListBuilder::$handlerName protected property Name of the list builder. 1
AccessTokenListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader 1
AccessTokenListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. Overrides EntityListBuilder::buildOperations
AccessTokenListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow 1
AccessTokenListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
AccessTokenListBuilder::getDefaultOperations protected function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 1
AccessTokenListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render 1
AccessTokenListBuilder::setAccessTokenManager protected function Sets the access token manager.
AccessTokenListBuilder::setDateFormatter protected function Sets the date formatter service.
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
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
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. 3
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
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::__construct public function Constructs a new EntityListBuilder object. 16
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.