class KeyListBuilder in Key 8

Provides a listing of keys.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
  - class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
    class \Drupal\key\Controller\KeyListBuilder

Expanded class hierarchy of KeyListBuilder

File

src/Controller/KeyListBuilder.php, line 18

Namespace

Drupal\key\Controller

View source

class KeyListBuilder extends ConfigEntityListBuilder {

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

  /**
   * Overrides.
   *
   * @var array
   */
  protected $overrides;

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entity_type_manager, EntityStorageInterface $storage) {
    parent::__construct($entity_type, $storage);
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Key');
    $header['type'] = [
      'data' => $this
        ->t('Type'),
      'class' => [
        RESPONSIVE_PRIORITY_MEDIUM,
      ],
    ];
    $header['provider'] = [
      'data' => $this
        ->t('Provider'),
      'class' => [
        RESPONSIVE_PRIORITY_MEDIUM,
      ],
    ];
    $header['overrides'] = [
      'data' => $this
        ->t('Overrides'),
      'class' => [
        RESPONSIVE_PRIORITY_MEDIUM,
      ],
    ];
    return $header + parent::buildHeader();
  }

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

    /* @var $key \Drupal\key\Entity\Key */
    $key = $entity;
    $row['label'] = $key
      ->label();
    $row['type'] = $key
      ->getKeyType()
      ->getPluginDefinition()['label'];
    $row['provider'] = $key
      ->getKeyProvider()
      ->getPluginDefinition()['label'];
    $overrides = $this
      ->getOverridesByKeyId($key
      ->id());
    $row['overrides']['data'] = [
      '#theme' => 'item_list',
      '#items' => $overrides,
    ];
    return $row + parent::buildRow($entity);
  }

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

    /* @var $key \Drupal\key\Entity\Key */
    $key = $entity;
    $operations = parent::getOperations($key);
    $key_collection = Url::fromRoute('entity.key.collection')
      ->toString();
    $operations['add_override'] = [
      'title' => $this
        ->t('Add Config Override'),
      'weight' => 50,
      'url' => Url::fromRoute('entity.key_config_override.add_form', [], [
        'query' => [
          'destination' => $key_collection,
          'key' => $key
            ->id(),
        ],
      ]),
    ];
    uasort($operations, '\\Drupal\\Component\\Utility\\SortArray::sortByWeightElement');
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $build['table']['#empty'] = $this
      ->t('No keys are available. <a href=":link">Add a key</a>.', [
      ':link' => Url::fromRoute('entity.key.add_form')
        ->toString(),
    ]);
    return $build;
  }

  /**
   * Get any overrides associated with a key.
   *
   * @param string $key_id
   *   The ID of the key.
   *
   * @return array
   *   The overrides associated with a key.
   */
  protected function getOverridesByKeyId($key_id) {
    if (!$this->overrides) {
      $entities = $this->entityTypeManager
        ->getStorage('key_config_override')
        ->loadMultiple();
      foreach ($entities as $entity) {

        // Build the complete configuration ID.
        $config_id = '';
        $config_type = $entity
          ->getConfigType();
        if ($config_type != 'system.simple') {
          $definition = $this->entityTypeManager
            ->getDefinition($config_type);
          $config_id .= $definition
            ->getConfigPrefix() . '.';
        }
        $config_id .= $entity
          ->getConfigName();
        $config_id .= ':' . $entity
          ->getConfigItem();
        $this->overrides[$entity
          ->getKeyId()][] = $config_id;
      }
    }
    return isset($this->overrides[$key_id]) ? $this->overrides[$key_id] : [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations	15
ConfigEntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilder::load	7
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::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::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
KeyListBuilder::$entityTypeManager	protected	property	The entity type manager.
KeyListBuilder::$overrides	protected	property	Overrides.
KeyListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
KeyListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
KeyListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
KeyListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilder::getOperations
KeyListBuilder::getOverridesByKeyId	protected	function	Get any overrides associated with a key.
KeyListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
KeyListBuilder::__construct	public	function	Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct
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.

You are here

class KeyListBuilder in Key 8

Hierarchy

See also

File

Namespace

Members

API Navigation