class CustomContextualLinkListBuilder in Custom Contextual Links 8.2

Provides a listing of Custom Contextual Link entities.

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\ccl\CustomContextualLinkListBuilder

File

src/CustomContextualLinkListBuilder.php, line 12

Namespace

Drupal\ccl

class CustomContextualLinkListBuilder extends ConfigEntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Label');
    $header['title'] = $this
      ->t('Link Title');
    $header['url'] = $this
      ->t('URL');
    $header['type'] = $this
      ->t('Type');
    $header['options'] = $this
      ->t('Options');
    return $header + parent::buildHeader();
  }

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

    /** @var \Drupal\ccl\Entity\CustomContextualLink $entity */
    $row['label'] = $entity
      ->label();
    $row['title'] = $entity
      ->get('title');
    $row['link'] = $entity
      ->get('link');
    $row['type'] = $entity
      ->get('type');
    $row['options'] = '';

    // Prepare the options display.
    if ($entity
      ->get('type') == 'node') {

      // Get content type names.
      $cts = node_type_get_names();
      switch ($entity
        ->getLinkOption('node_option')) {
        case 'global':
          $row['options'] = $this
            ->t('Attached to all nodes.');
          break;
        case 'ct':
          $row['options'] = $this
            ->t('Attached to all nodes of the content type %ct.', [
            '%ct' => $cts[$entity
              ->getLinkOption('node_type')],
          ]);
          break;
        case 'node':
          $nid = $entity
            ->getLinkOption('node_id');
          $node = $nid ? Node::load($nid) : NULL;
          if ($node) {
            $row['options'] = $this
              ->t('Attached to %node_title [NID: :nid].', [
              '%node_title' => $node
                ->label(),
              ':nid' => $node
                ->id(),
            ]);
          }
          break;
      }
    }
    else {
      foreach ($this
        ->moduleHandler()
        ->getImplementations('ccl_link_info') as $implementation) {
        $options = $this
          ->moduleHandler()
          ->invoke($implementation, 'ccl_link_info', [
          $entity,
        ]);
        if (!empty($options)) {
          $row['options'] = $options;
          break;
        }
      }
    }
    return $row + parent::buildRow($entity);
  }

}

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
CustomContextualLinkListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
CustomContextualLinkListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
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::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::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render	16
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.