class ConfigTranslationMapperList

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

Defines the configuration translation mapper list.

Groups all defined configuration mapper instances by weight.

Hierarchy

Expanded class hierarchy of ConfigTranslationMapperList

File

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

Namespace

Drupal\config_translation\Controller
View source
class ConfigTranslationMapperList extends ControllerBase {
    
    /**
     * An array of configuration mapper instances.
     *
     * @var \Drupal\config_translation\ConfigMapperInterface[]
     */
    protected $mappers;
    
    /**
     * Constructs a new ConfigTranslationMapperList object.
     *
     * @param \Drupal\config_translation\ConfigMapperInterface[] $mappers
     *   The configuration mapper manager.
     */
    public function __construct(array $mappers) {
        $this->mappers = $mappers;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('plugin.manager.config_translation.mapper')
            ->getMappers());
    }
    
    /**
     * Builds the mappers as a renderable array for table.html.twig.
     *
     * @return array
     *   Renderable array with config translation mappers.
     */
    public function render() {
        $build = [
            '#type' => 'table',
            '#header' => $this->buildHeader(),
            '#rows' => [],
        ];
        $mappers = [];
        foreach ($this->mappers as $mapper) {
            if ($row = $this->buildRow($mapper)) {
                $mappers[$mapper->getWeight()][] = $row;
            }
        }
        // Group by mapper weight and sort by label.
        ksort($mappers);
        foreach ($mappers as $weight => $mapper) {
            usort($mapper, function ($a, $b) {
                $a_title = isset($a['label']) ? $a['label'] : '';
                $b_title = isset($b['label']) ? $b['label'] : '';
                return strnatcasecmp($a_title, $b_title);
            });
            $mappers[$weight] = $mapper;
        }
        $build['#rows'] = array_merge(...$mappers);
        return $build;
    }
    
    /**
     * Builds a row for a mapper in the mapper listing.
     *
     * @param \Drupal\config_translation\ConfigMapperInterface $mapper
     *   The mapper.
     *
     * @return array
     *   A render array structure of fields for this mapper.
     */
    public function buildRow(ConfigMapperInterface $mapper) {
        $row['label'] = $mapper->getTypeLabel();
        $row['operations']['data'] = $this->buildOperations($mapper);
        return $row;
    }
    
    /**
     * Builds the header row for the mapper listing.
     *
     * @return array
     *   A render array structure of header strings.
     */
    public function buildHeader() {
        $row['Label'] = $this->t('Label');
        $row['operations'] = $this->t('Operations');
        return $row;
    }
    
    /**
     * Builds a renderable list of operation links for the entity.
     *
     * @param \Drupal\config_translation\ConfigMapperInterface $mapper
     *   The mapper.
     *
     * @return array
     *   A renderable array of operation links.
     *
     * @see \Drupal\Core\Entity\EntityList::buildOperations()
     */
    protected function buildOperations(ConfigMapperInterface $mapper) {
        // Retrieve and sort operations.
        $operations = $mapper->getOperations();
        uasort($operations, 'Drupal\\Component\\Utility\\SortArray::sortByWeightElement');
        $build = [
            '#type' => 'operations',
            '#links' => $operations,
        ];
        return $build;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigTranslationMapperList::$mappers protected property An array of configuration mapper instances.
ConfigTranslationMapperList::buildHeader public function Builds the header row for the mapper listing.
ConfigTranslationMapperList::buildOperations protected function Builds a renderable list of operation links for the entity.
ConfigTranslationMapperList::buildRow public function Builds a row for a mapper in the mapper listing.
ConfigTranslationMapperList::create public static function Instantiates a new instance of the implementing class using autowiring. Overrides AutowireTrait::create
ConfigTranslationMapperList::render public function Builds the mappers as a renderable array for table.html.twig.
ConfigTranslationMapperList::__construct public function Constructs a new ConfigTranslationMapperList object.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 2
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 2
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 3
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.