class ConfigTranslationListController

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

Defines the configuration translation list controller.

Hierarchy

Expanded class hierarchy of ConfigTranslationListController

File

core/modules/config_translation/src/Controller/ConfigTranslationListController.php, line 13

Namespace

Drupal\config_translation\Controller
View source
class ConfigTranslationListController extends ControllerBase {
    
    /**
     * The mapper manager.
     *
     * @var \Drupal\config_translation\ConfigMapperManagerInterface
     */
    protected $mapperManager;
    
    /**
     * Constructs a new ConfigTranslationListController object.
     *
     * @param \Drupal\config_translation\ConfigMapperManagerInterface $mapper_manager
     *   The config mapper manager.
     */
    public function __construct(ConfigMapperManagerInterface $mapper_manager) {
        $this->mapperManager = $mapper_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('plugin.manager.config_translation.mapper'));
    }
    
    /**
     * Provides the listing page for any entity type.
     *
     * @param string $mapper_id
     *   The name of the mapper.
     *
     * @return array
     *   A render array as expected by
     *   \Drupal\Core\Render\RendererInterface::render().
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     *   Throws an exception if a mapper plugin could not be instantiated from the
     *   mapper definition in the constructor.
     */
    public function listing($mapper_id) {
        $mapper_definition = $this->mapperManager
            ->getDefinition($mapper_id);
        $mapper = $this->mapperManager
            ->createInstance($mapper_id, $mapper_definition);
        if (!$mapper) {
            throw new NotFoundHttpException();
        }
        $entity_type = $mapper->getType();
        // If the mapper, for example the mapper for fields, has a custom list
        // controller defined, use it. Other mappers, for examples the ones for
        // node_type and block, fallback to the generic configuration translation
        // list controller.
        $build = $this->entityTypeManager()
            ->getHandler($entity_type, 'config_translation_list')
            ->setMapperDefinition($mapper_definition)
            ->render();
        $build['#title'] = $mapper->getTypeLabel();
        return $build;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigTranslationListController::$mapperManager protected property The mapper manager.
ConfigTranslationListController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ConfigTranslationListController::listing public function Provides the listing page for any entity type.
ConfigTranslationListController::__construct public function Constructs a new ConfigTranslationListController object.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 3
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. 3
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. 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. 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.