class ConfigurableLanguage

Same name in other branches
  1. 8.9.x core/modules/language/src/Entity/ConfigurableLanguage.php \Drupal\language\Entity\ConfigurableLanguage
  2. 10 core/modules/language/src/Entity/ConfigurableLanguage.php \Drupal\language\Entity\ConfigurableLanguage
  3. 11.x core/modules/language/src/Entity/ConfigurableLanguage.php \Drupal\language\Entity\ConfigurableLanguage

Defines the ConfigurableLanguage entity.

Plugin annotation


@ConfigEntityType(
  id = "configurable_language",
  label = @Translation("Language"),
  label_collection = @Translation("Languages"),
  label_singular = @Translation("language"),
  label_plural = @Translation("languages"),
  label_count = @PluralTranslation(
    singular = "@count language",
    plural = "@count languages",
  ),
  handlers = {
    "list_builder" = "Drupal\language\LanguageListBuilder",
    "access" = "Drupal\language\LanguageAccessControlHandler",
    "form" = {
      "add" = "Drupal\language\Form\LanguageAddForm",
      "edit" = "Drupal\language\Form\LanguageEditForm",
      "delete" = "Drupal\language\Form\LanguageDeleteForm"
    }
  },
  admin_permission = "administer languages",
  config_prefix = "entity",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "weight" = "weight"
  },
  config_export = {
    "id",
    "label",
    "direction",
    "weight",
    "locked"
  },
  links = {
    "delete-form" = "/admin/config/regional/language/delete/{configurable_language}",
    "edit-form" = "/admin/config/regional/language/edit/{configurable_language}",
    "collection" = "/admin/config/regional/language",
  }
)

Hierarchy

Expanded class hierarchy of ConfigurableLanguage

205 files declare their use of ConfigurableLanguage
AdminPathEntityConverterLanguageTest.php in core/modules/language/tests/src/Functional/AdminPathEntityConverterLanguageTest.php
BasicAuthTest.php in core/modules/basic_auth/tests/src/Functional/BasicAuthTest.php
BlockContentFieldFilterTest.php in core/modules/block_content/tests/src/Functional/Views/BlockContentFieldFilterTest.php
BlockLanguageCacheTest.php in core/modules/block/tests/src/Functional/BlockLanguageCacheTest.php
BlockUiTest.php in core/modules/block/tests/src/Functional/BlockUiTest.php

... See full list

File

core/modules/language/src/Entity/ConfigurableLanguage.php, line 56

Namespace

Drupal\language\Entity
View source
class ConfigurableLanguage extends ConfigEntityBase implements ConfigurableLanguageInterface {
    
    /**
     * The language ID (machine name).
     *
     * @var string
     */
    protected $id;
    
    /**
     * The human-readable label for the language.
     *
     * @var string
     */
    protected $label;
    
    /**
     * The direction of language, either DIRECTION_LTR or DIRECTION_RTL.
     *
     * @var int
     */
    protected $direction = self::DIRECTION_LTR;
    
    /**
     * The weight of the language, used in lists of languages.
     *
     * @var int
     */
    protected $weight = 0;
    
    /**
     * Locked languages cannot be edited.
     *
     * @var bool
     */
    protected $locked = FALSE;
    
    /**
     * Used during saving to detect when the site becomes multilingual.
     *
     * This property is not saved to the language entity, but is needed for
     * detecting when to rebuild the services.
     *
     * @see \Drupal\language\Entity\ConfigurableLanguage::preSave()
     * @see \Drupal\language\Entity\ConfigurableLanguage::postSave()
     *
     * @var bool
     */
    protected $preSaveMultilingual;
    
    /**
     * {@inheritdoc}
     */
    public function isDefault() {
        return static::getDefaultLangcode() == $this->id();
    }
    
    /**
     * {@inheritdoc}
     */
    public function isLocked() {
        return (bool) $this->locked;
    }
    
    /**
     * {@inheritdoc}
     */
    public function preSave(EntityStorageInterface $storage) {
        parent::preSave($storage);
        // Store whether or not the site is already multilingual so that we can
        // rebuild services if necessary during
        // \Drupal\language\Entity\ConfigurableLanguage::postSave().
        $this->preSaveMultilingual = \Drupal::languageManager()->isMultilingual();
    }
    
    /**
     * {@inheritdoc}
     */
    public function postSave(EntityStorageInterface $storage, $update = TRUE) {
        parent::postSave($storage, $update);
        $language_manager = \Drupal::languageManager();
        $language_manager->reset();
        if (!$this->isLocked() && $language_manager instanceof ConfigurableLanguageManagerInterface && !$this->isSyncing()) {
            $language_manager->updateLockedLanguageWeights();
        }
        // Update URL Prefixes for all languages after the
        // LanguageManagerInterface::getLanguages() cache is flushed.
        language_negotiation_url_prefixes_update();
        // If after adding this language the site will become multilingual, we need
        // to rebuild language services.
        if (!$this->preSaveMultilingual && !$update && $language_manager instanceof ConfigurableLanguageManagerInterface) {
            $language_manager::rebuildServices();
        }
        if (!$update) {
            // Install any available language configuration overrides for the language.
            \Drupal::service('language.config_factory_override')->installLanguageOverrides($this->id());
        }
        if (!$this->isLocked() && !$update) {
            // Add language to the list of language domains.
            $config = \Drupal::configFactory()->getEditable('language.negotiation');
            $domains = $config->get('url.domains');
            $domains[$this->id()] = '';
            $config->set('url.domains', $domains)
                ->save(TRUE);
        }
    }
    
    /**
     * {@inheritdoc}
     *
     * @throws \Drupal\language\Exception\DeleteDefaultLanguageException
     *   Exception thrown if we're trying to delete the default language entity.
     *   This is not allowed as a site must have a default language.
     */
    public static function preDelete(EntityStorageInterface $storage, array $entities) {
        $default_langcode = static::getDefaultLangcode();
        foreach ($entities as $entity) {
            if ($entity->id() == $default_langcode && !$entity->isUninstalling()) {
                throw new DeleteDefaultLanguageException('Can not delete the default language');
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function postDelete(EntityStorageInterface $storage, array $entities) {
        parent::postDelete($storage, $entities);
        $language_manager = \Drupal::languageManager();
        $language_manager->reset();
        $entity = reset($entities);
        if ($language_manager instanceof ConfigurableLanguageManagerInterface && !$entity->isUninstalling() && !$entity->isSyncing()) {
            $language_manager->updateLockedLanguageWeights();
        }
        // If after deleting this language the site will become monolingual, we need
        // to rebuild language services.
        if (!\Drupal::languageManager()->isMultilingual()) {
            ConfigurableLanguageManager::rebuildServices();
        }
        // Remove language from language prefix and domain list.
        $config = \Drupal::configFactory()->getEditable('language.negotiation');
        $config->clear('url.prefixes.' . $entity->id());
        $config->clear('url.domains.' . $entity->id());
        $config->save(TRUE);
    }
    
    /**
     * Gets the default langcode.
     *
     * @return string
     *   The current default langcode.
     */
    protected static function getDefaultLangcode() {
        $language = \Drupal::service('language.default')->get();
        return $language->getId();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getName() {
        return $this->label();
    }
    
    /**
     * {@inheritdoc}
     */
    public function setName($name) {
        $this->label = $name;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getId() {
        return $this->id();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDirection() {
        return $this->direction;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getWeight() {
        return $this->weight;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setWeight($weight) {
        $this->weight = $weight;
        return $this;
    }
    
    /**
     * Creates a configurable language object from a langcode.
     *
     * @param string $langcode
     *   The language code to use to create the object.
     *
     * @return $this
     *
     * @see \Drupal\Core\Language\LanguageManager::getStandardLanguageList()
     */
    public static function createFromLangcode($langcode) {
        $standard_languages = LanguageManager::getStandardLanguageList();
        if (!isset($standard_languages[$langcode])) {
            // Drupal does not know about this language, so we set its values with the
            // best guess. The user will be able to edit afterwards.
            return static::create([
                'id' => $langcode,
                'label' => $langcode,
            ]);
        }
        else {
            // A known predefined language, details will be filled in properly.
            return static::create([
                'id' => $langcode,
                'label' => $standard_languages[$langcode][0],
                'direction' => $standard_languages[$langcode][2] ?? static::DIRECTION_LTR,
            ]);
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 14
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the
config system already invalidates them.
Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system
already invalidates it.
Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
ConfigurableLanguage::$direction protected property The direction of language, either DIRECTION_LTR or DIRECTION_RTL.
ConfigurableLanguage::$id protected property The language ID (machine name).
ConfigurableLanguage::$label protected property The human-readable label for the language.
ConfigurableLanguage::$locked protected property Locked languages cannot be edited.
ConfigurableLanguage::$preSaveMultilingual protected property Used during saving to detect when the site becomes multilingual.
ConfigurableLanguage::$weight protected property The weight of the language, used in lists of languages.
ConfigurableLanguage::createFromLangcode public static function Creates a configurable language object from a langcode.
ConfigurableLanguage::getDefaultLangcode protected static function Gets the default langcode.
ConfigurableLanguage::getDirection public function Gets the text direction (left-to-right or right-to-left). Overrides LanguageInterface::getDirection
ConfigurableLanguage::getId public function Gets the ID (language code). Overrides LanguageInterface::getId
ConfigurableLanguage::getName public function Gets the name of the language. Overrides LanguageInterface::getName
ConfigurableLanguage::getWeight public function Gets the weight of the language. Overrides LanguageInterface::getWeight
ConfigurableLanguage::isDefault public function Returns whether this language is the default language. Overrides LanguageInterface::isDefault
ConfigurableLanguage::isLocked public function Returns whether this language is locked. Overrides LanguageInterface::isLocked
ConfigurableLanguage::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete
ConfigurableLanguage::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
ConfigurableLanguage::preDelete public static function Overrides ConfigEntityBase::preDelete
ConfigurableLanguage::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
ConfigurableLanguage::setName public function Sets the name of the language. Overrides ConfigurableLanguageInterface::setName
ConfigurableLanguage::setWeight public function Sets the weight of the language. Overrides ConfigurableLanguageInterface::setWeight
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create 1
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
LanguageInterface::DIRECTION_LTR constant Language written left to right. Possible value of $language->direction.
LanguageInterface::DIRECTION_RTL constant Language written right to left. Possible value of $language->direction.
LanguageInterface::LANGCODE_DEFAULT constant Language code referring to the default language of data, e.g. of an entity.
LanguageInterface::LANGCODE_NOT_APPLICABLE constant The language code used when the marked object has no linguistic content.
LanguageInterface::LANGCODE_NOT_SPECIFIED constant The language code used when no language is explicitly assigned (yet).
LanguageInterface::LANGCODE_SITE_DEFAULT constant Language code referring to site's default language.
LanguageInterface::LANGCODE_SYSTEM constant Special system language code (only applicable to UI language).
LanguageInterface::STATE_ALL constant The language state used when referring to all languages.
LanguageInterface::STATE_CONFIGURABLE constant The language state when referring to configurable languages.
LanguageInterface::STATE_LOCKED constant The language state when referring to locked languages.
LanguageInterface::STATE_SITE_DEFAULT constant The language state used when referring to the site's default language.
LanguageInterface::TYPE_CONTENT constant The type of language used to define the content language.
LanguageInterface::TYPE_INTERFACE constant The type of language used to select the user interface.
LanguageInterface::TYPE_URL constant The type of language used for URLs.
LanguageInterface::VALID_LANGCODE_REGEX constant A regex for validating language codes according to W3C specifications.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function

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