class ConfigTranslationBlockListBuilder

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

Defines the config translation list builder for blocks.

Hierarchy

Expanded class hierarchy of ConfigTranslationBlockListBuilder

File

core/modules/config_translation/src/Controller/ConfigTranslationBlockListBuilder.php, line 14

Namespace

Drupal\config_translation\Controller
View source
class ConfigTranslationBlockListBuilder extends ConfigTranslationEntityListBuilder {
    
    /**
     * An array of theme info keyed by theme name.
     *
     * @var array
     */
    protected $themes = [];
    
    /**
     * {@inheritdoc}
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, ThemeHandlerInterface $theme_handler) {
        parent::__construct($entity_type, $storage);
        $this->themes = $theme_handler->listInfo();
    }
    
    /**
     * {@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('theme_handler'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFilterLabels() {
        $info = parent::getFilterLabels();
        $info['placeholder'] = $this->t('Enter block, theme or category');
        $info['description'] = $this->t('Enter a part of the block, theme or category to filter by.');
        return $info;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        $theme = $entity->getTheme();
        $plugin_definition = $entity->getPlugin()
            ->getPluginDefinition();
        $row['label'] = [
            'data' => $entity->label(),
            'class' => 'table-filter-text-source',
        ];
        $row['theme'] = [
            'data' => $this->themes[$theme]->info['name'],
            'class' => 'table-filter-text-source',
        ];
        $row['category'] = [
            'data' => $plugin_definition['category'],
            'class' => 'table-filter-text-source',
        ];
        $row['operations']['data'] = $this->buildOperations($entity);
        return $row;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header['label'] = $this->t('Block');
        $header['theme'] = $this->t('Theme');
        $header['category'] = $this->t('Category');
        $header['operations'] = $this->t('Operations');
        return $header;
    }
    
    /**
     * {@inheritdoc}
     */
    public function sortRows($a, $b) {
        return $this->sortRowsMultiple($a, $b, [
            'theme',
            'category',
            'label',
        ]);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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
ConfigTranslationBlockListBuilder::$themes protected property An array of theme info keyed by theme name.
ConfigTranslationBlockListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides ConfigTranslationEntityListBuilder::buildHeader
ConfigTranslationBlockListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides ConfigTranslationEntityListBuilder::buildRow
ConfigTranslationBlockListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
ConfigTranslationBlockListBuilder::getFilterLabels public function Provides user facing strings for the filter element. Overrides ConfigTranslationEntityListBuilder::getFilterLabels
ConfigTranslationBlockListBuilder::sortRows public function Sorts an array by value. Overrides ConfigTranslationEntityListBuilder::sortRows
ConfigTranslationBlockListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct
ConfigTranslationEntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilder::getOperations
ConfigTranslationEntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
ConfigTranslationEntityListBuilder::setMapperDefinition public function Sets the config translation mapper definition. Overrides ConfigTranslationEntityListBuilderInterface::setMapperDefinition 1
ConfigTranslationEntityListBuilder::sortRowsMultiple protected function Sorts an array by multiple criteria.
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
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 '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.
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.