class LtiToolProviderConsumerListBuilder in LTI Tool Provider 8

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\lti_tool_provider\LtiToolProviderConsumerListBuilder

File

src/LtiToolProviderConsumerListBuilder.php, line 12

Namespace

Drupal\lti_tool_provider

class LtiToolProviderConsumerListBuilder extends EntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() : array {
    $header = [
      'id' => [
        'data' => $this
          ->t('ID'),
        'field' => 'id',
        'specifier' => 'id',
      ],
      'consumer' => [
        'data' => $this
          ->t('Label'),
        'field' => 'consumer',
        'specifier' => 'consumer',
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
      'consumer_key' => [
        'data' => $this
          ->t('Consumer Key'),
        'field' => 'consumer_key',
        'specifier' => 'consumer_key',
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
      'consumer_secret' => [
        'data' => $this
          ->t('Consumer Secret'),
        'field' => 'consumer_secret',
        'specifier' => 'consumer_secret',
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
      'created' => [
        'data' => $this
          ->t('Created'),
        'field' => 'created',
        'specifier' => 'created',
        'sort' => 'desc',
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
    ];
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) : array {
    $row = [];
    if ($entity instanceof LtiToolProviderConsumer) {
      $row = [
        'id' => $entity
          ->id(),
        'consumer' => $link = Link::fromTextAndUrl($entity
          ->label(), Url::fromRoute('entity.lti_tool_provider_consumer.canonical', [
          'lti_tool_provider_consumer' => $entity
            ->id(),
        ])),
        'consumer_key' => $entity
          ->get('consumer_key')->value,
        'consumer_secret' => $entity
          ->get('consumer_secret')->value,
        'created' => Drupal::service('date.formatter')
          ->format($entity
          ->get('created')->value, 'short'),
      ];
    }
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function render() : array {
    $build = parent::render();
    $build['table']['#empty'] = $this
      ->t('No consumers found.');
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance	20
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::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
LtiToolProviderConsumerListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
LtiToolProviderConsumerListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
LtiToolProviderConsumerListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
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.