class LanguageListBuilder

Same name and namespace in other branches
  1. 9 core/modules/language/src/LanguageListBuilder.php \Drupal\language\LanguageListBuilder
  2. 8.9.x core/modules/language/src/LanguageListBuilder.php \Drupal\language\LanguageListBuilder
  3. 10 core/modules/language/src/LanguageListBuilder.php \Drupal\language\LanguageListBuilder

Defines a class to build a listing of language entities.

Hierarchy

Expanded class hierarchy of LanguageListBuilder

See also

\Drupal\language\Entity\ConfigurableLanguage

File

core/modules/language/src/LanguageListBuilder.php, line 20

Namespace

Drupal\language
View source
class LanguageListBuilder extends DraggableListBuilder {
    
    /**
     * {@inheritdoc}
     */
    protected $entitiesKey = 'languages';
    
    /**
     * The language manager.
     *
     * @var \Drupal\Core\Language\LanguageManagerInterface
     */
    protected $languageManager;
    
    /**
     * The configuration factory.
     *
     * @var \Drupal\Core\Config\ConfigFactoryInterface
     */
    protected $configFactory;
    
    /**
     * The messenger.
     *
     * @var \Drupal\Core\Messenger\MessengerInterface
     */
    protected $messenger;
    
    /**
     * {@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('language_manager'), $container->get('config.factory'), $container->get('messenger'));
    }
    
    /**
     * Constructs a new LanguageListBuilder object.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     * @param \Drupal\Core\Entity\EntityStorageInterface $storage
     *   The entity storage handler class.
     * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
     *   The language manager.
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The factory for configuration objects.
     * @param \Drupal\Core\Messenger\MessengerInterface $messenger
     *   The messenger.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, LanguageManagerInterface $language_manager, ConfigFactoryInterface $config_factory, MessengerInterface $messenger) {
        parent::__construct($entity_type, $storage);
        $this->languageManager = $language_manager;
        $this->configFactory = $config_factory;
        $this->messenger = $messenger;
    }
    
    /**
     * {@inheritdoc}
     */
    public function load() {
        $entities = $this->storage
            ->loadByProperties([
            'locked' => FALSE,
        ]);
        // Sort the entities using the entity class's sort() method.
        // See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().
        uasort($entities, [
            $this->entityType
                ->getClass(),
            'sort',
        ]);
        return $entities;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'language_admin_overview_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header = [
            'label' => t('Name'),
            'default' => t('Default'),
        ] + parent::buildHeader();
        return $header;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        $row['label'] = $entity->label();
        $row['default'] = [
            '#type' => 'radio',
            '#parents' => [
                'site_default_language',
            ],
            '#title' => t('Set @title as default', [
                '@title' => $entity->label(),
            ]),
            '#title_display' => 'invisible',
            '#return_value' => $entity->id(),
            '#id' => 'edit-site-default-language-' . $entity->id(),
        ];
        // Mark the right language as default in the form.
        if ($entity->id() == $this->languageManager
            ->getDefaultLanguage()
            ->getId()) {
            $row['default']['#default_value'] = $entity->id();
        }
        return $row + parent::buildRow($entity);
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form = parent::buildForm($form, $form_state);
        $form[$this->entitiesKey]['#languages'] = $this->entities;
        $form['actions']['submit']['#value'] = t('Save configuration');
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        if (!isset($this->entities[$form_state->getValue('site_default_language')])) {
            $form_state->setErrorByName('site_default_language', $this->t('Selected default language no longer exists.'));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        parent::submitForm($form, $form_state);
        // Save the default language if changed.
        $new_id = $form_state->getValue('site_default_language');
        if ($new_id != $this->languageManager
            ->getDefaultLanguage()
            ->getId()) {
            $this->configFactory
                ->getEditable('system.site')
                ->set('default_langcode', $new_id)
                ->save();
            $this->languageManager
                ->reset();
        }
        if ($this->languageManager instanceof ConfigurableLanguageManagerInterface) {
            $this->languageManager
                ->updateLockedLanguageWeights();
        }
        $this->messenger
            ->addStatus($this->t('Configuration saved.'));
        // Force the redirection to the page with the language we have just
        // selected as default.
        $form_state->setRedirectUrl($this->entities[$new_id]
            ->toUrl('collection', [
            'language' => $this->entities[$new_id],
        ]));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigEntityListBuilder::$storage protected property The config entity storage class. Overrides EntityListBuilder::$storage
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 15
ConfigEntityListBuilder::getStorage public function Gets the config entity storage. Overrides EntityListBuilder::getStorage
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DraggableListBuilder::getWeight protected function Gets the weight of the given entity. Overrides DraggableListBuilderTrait::getWeight
DraggableListBuilder::setWeight protected function Sets the weight of an entity. Overrides DraggableListBuilderTrait::setWeight
DraggableListBuilderTrait::$entities protected property The entities being listed. 1
DraggableListBuilderTrait::$formBuilder protected property The form builder.
DraggableListBuilderTrait::$weightKey protected property Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilderTrait::render public function Builds a listing of entities for the given entity type. 1
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
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. 2
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL. 1
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 5
EntityListBuilder::getEntityListQuery protected function Returns a query object for loading entity IDs from the storage.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 3
EntityListBuilder::getTitle protected function Gets the title of the page. 1
LanguageListBuilder::$configFactory protected property The configuration factory.
LanguageListBuilder::$entitiesKey protected property The key to use for the form element containing the entities. Overrides DraggableListBuilderTrait::$entitiesKey
LanguageListBuilder::$languageManager protected property The language manager.
LanguageListBuilder::$messenger protected property The messenger. Overrides MessengerTrait::$messenger
LanguageListBuilder::buildForm public function Form constructor. Overrides DraggableListBuilderTrait::buildForm
LanguageListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides DraggableListBuilderTrait::buildHeader
LanguageListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides DraggableListBuilderTrait::buildRow
LanguageListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
LanguageListBuilder::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LanguageListBuilder::load public function Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder::load
LanguageListBuilder::submitForm public function Form submission handler. Overrides DraggableListBuilderTrait::submitForm
LanguageListBuilder::validateForm public function Form validation handler. Overrides DraggableListBuilderTrait::validateForm
LanguageListBuilder::__construct public function Constructs a new LanguageListBuilder object. Overrides DraggableListBuilder::__construct
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.