class ShortcutSetListBuilder

Same name and namespace in other branches
  1. 11.x core/modules/shortcut/src/ShortcutSetListBuilder.php \Drupal\shortcut\ShortcutSetListBuilder
  2. 10 core/modules/shortcut/src/ShortcutSetListBuilder.php \Drupal\shortcut\ShortcutSetListBuilder
  3. 9 core/modules/shortcut/src/ShortcutSetListBuilder.php \Drupal\shortcut\ShortcutSetListBuilder
  4. 8.9.x core/modules/shortcut/src/ShortcutSetListBuilder.php \Drupal\shortcut\ShortcutSetListBuilder

Defines a class to build a listing of shortcut set entities.

Hierarchy

Expanded class hierarchy of ShortcutSetListBuilder

See also

\Drupal\shortcut\Entity\ShortcutSet

1 file declares its use of ShortcutSetListBuilder
ShortcutSet.php in core/modules/shortcut/src/Entity/ShortcutSet.php

File

View on git.drupalcode.org

core/modules/shortcut/src/ShortcutSetListBuilder.php, line 14

Namespace

Drupal\shortcut
View source 
class ShortcutSetListBuilder extends ConfigEntityListBuilder {
  
  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['name'] = $this->t('Name');
    return $header + parent::buildHeader();
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getDefaultOperations(EntityInterface $entity) {
    $args = func_get_args();
    $cacheability = $args[1] ?? new CacheableMetadata();
    $operations = parent::getDefaultOperations($entity, $cacheability);
    if (isset($operations['edit'])) {
      $operations['edit']['title'] = $this->t('Edit shortcut set');
    }
    $operations['list'] = [
      'title' => $this->t('List links'),
      'url' => $entity->toUrl('customize-form'),
    ];
    return $operations;
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['name'] = $entity->label();
    return $row + parent::buildRow($entity);
  }

}

Members

Title Modifiers Object type Summary Overriden Title
ConfigEntityListBuilder::$storage protected property The config entity storage class.
ConfigEntityListBuilder::getStorage public function Gets the config entity storage.
ConfigEntityListBuilder::load public function
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
DependencySerializationTrait::__wakeup public function
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on.
EntityHandlerBase::moduleHandler protected function Gets the module handler.
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::buildOperations public function Builds a renderable list of operation links for the entity.
EntityListBuilder::createInstance public static function
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.
EntityListBuilder::getEntityListQuery protected function Returns a query object for loading entity IDs from the storage.
EntityListBuilder::getOperations public function
EntityListBuilder::getTitle protected function Gets the title of the page.
EntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig.
EntityListBuilder::SORT_KEY protected constant The entity key to sort the list by.
EntityListBuilder::__construct public function Constructs a new EntityListBuilder object.
MessengerTrait::$messenger protected property The messenger.
MessengerTrait::messenger public function Gets the messenger.
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
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.
ShortcutSetListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
ShortcutSetListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
ShortcutSetListBuilder::getDefaultOperations protected function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.