class ActionListBuilder

Same name in other branches
  1. 9 core/modules/action/src/ActionListBuilder.php \Drupal\action\ActionListBuilder
  2. 10 core/modules/action/src/ActionListBuilder.php \Drupal\action\ActionListBuilder
  3. 11.x core/modules/action/src/ActionListBuilder.php \Drupal\action\ActionListBuilder

Defines a class to build a listing of action entities.

Hierarchy

Expanded class hierarchy of ActionListBuilder

See also

\Drupal\system\Entity\Action

action_entity_type_build()

File

core/modules/action/src/ActionListBuilder.php, line 18

Namespace

Drupal\action
View source
class ActionListBuilder extends ConfigEntityListBuilder {
    
    /**
     * @var bool
     */
    protected $hasConfigurableActions = FALSE;
    
    /**
     * The action plugin manager.
     *
     * @var \Drupal\Core\Action\ActionManager
     */
    protected $actionManager;
    
    /**
     * Constructs a new ActionListBuilder object.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     * @param \Drupal\Core\Entity\EntityStorageInterface $storage
     *   The action storage.
     * @param \Drupal\Core\Action\ActionManager $action_manager
     *   The action plugin manager.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, ActionManager $action_manager) {
        parent::__construct($entity_type, $storage);
        $this->actionManager = $action_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        return new static($entity_type, $container->get('entity_type.manager')
            ->getStorage($entity_type->id()), $container->get('plugin.manager.action'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function load() {
        $entities = parent::load();
        foreach ($entities as $entity) {
            if ($entity->isConfigurable()) {
                $this->hasConfigurableActions = TRUE;
                continue;
            }
        }
        return $entities;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        $row['type'] = $entity->getType();
        $row['label'] = $entity->label();
        if ($this->hasConfigurableActions) {
            $row += parent::buildRow($entity);
        }
        return $row;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header = [
            'type' => t('Action type'),
            'label' => t('Label'),
        ] + parent::buildHeader();
        return $header;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOperations(EntityInterface $entity) {
        $operations = $entity->isConfigurable() ? parent::getDefaultOperations($entity) : [];
        if (isset($operations['edit'])) {
            $operations['edit']['title'] = t('Configure');
        }
        return $operations;
    }
    
    /**
     * {@inheritdoc}
     */
    public function render() {
        $build['action_admin_manage_form'] = \Drupal::formBuilder()->getForm('Drupal\\action\\Form\\ActionAdminManageForm');
        $build['action_header']['#markup'] = '<h3>' . $this->t('Available actions:') . '</h3>';
        $build['action_table'] = parent::render();
        if (!$this->hasConfigurableActions) {
            unset($build['action_table']['table']['#header']['operations']);
        }
        return $build;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
ActionListBuilder::$actionManager protected property The action plugin manager.
ActionListBuilder::$hasConfigurableActions protected property
ActionListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
ActionListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
ActionListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
ActionListBuilder::getDefaultOperations public function Gets this list&#039;s default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
ActionListBuilder::load public function Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder::load
ActionListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
ActionListBuilder::__construct public function Constructs a new ActionListBuilder object. Overrides EntityListBuilder::__construct
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::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
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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.
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.

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