3 namespace Drupal\language\Entity;
5 use Drupal\Core\Config\Entity\ConfigEntityBase;
6 use Drupal\Core\Entity\EntityStorageInterface;
7 use Drupal\Core\Language\LanguageManager;
8 use Drupal\language\ConfigurableLanguageManager;
9 use Drupal\language\ConfigurableLanguageManagerInterface;
10 use Drupal\language\Exception\DeleteDefaultLanguageException;
11 use Drupal\language\ConfigurableLanguageInterface;
14 * Defines the ConfigurableLanguage entity.
17 * id = "configurable_language",
18 * label = @Translation("Language"),
20 * "list_builder" = "Drupal\language\LanguageListBuilder",
21 * "access" = "Drupal\language\LanguageAccessControlHandler",
23 * "add" = "Drupal\language\Form\LanguageAddForm",
24 * "edit" = "Drupal\language\Form\LanguageEditForm",
25 * "delete" = "Drupal\language\Form\LanguageDeleteForm"
28 * admin_permission = "administer languages",
29 * config_prefix = "entity",
36 * "delete-form" = "/admin/config/regional/language/delete/{configurable_language}",
37 * "edit-form" = "/admin/config/regional/language/edit/{configurable_language}",
38 * "collection" = "/admin/config/regional/language",
42 class ConfigurableLanguage extends ConfigEntityBase implements ConfigurableLanguageInterface {
45 * The language ID (machine name).
52 * The human-readable label for the language.
59 * The direction of language, either DIRECTION_LTR or DIRECTION_RTL.
63 protected $direction = self::DIRECTION_LTR;
66 * The weight of the language, used in lists of languages.
70 protected $weight = 0;
73 * Locked languages cannot be edited.
77 protected $locked = FALSE;
80 * Used during saving to detect when the site becomes multilingual.
82 * This property is not saved to the language entity, but is needed for
83 * detecting when to rebuild the services.
85 * @see \Drupal\language\Entity\ConfigurableLanguage::preSave()
86 * @see \Drupal\language\Entity\ConfigurableLanguage::postSave()
90 protected $preSaveMultilingual;
95 public function isDefault() {
96 return static::getDefaultLangcode() == $this->id();
102 public function isLocked() {
103 return (bool) $this->locked;
109 public function preSave(EntityStorageInterface $storage) {
110 parent::preSave($storage);
111 // Store whether or not the site is already multilingual so that we can
112 // rebuild services if necessary during
113 // \Drupal\language\Entity\ConfigurableLanguage::postSave().
114 $this->preSaveMultilingual = \Drupal::languageManager()->isMultilingual();
120 public function postSave(EntityStorageInterface $storage, $update = TRUE) {
121 parent::postSave($storage, $update);
123 $language_manager = \Drupal::languageManager();
124 $language_manager->reset();
125 if (!$this->isLocked() && $language_manager instanceof ConfigurableLanguageManagerInterface && !$this->isSyncing()) {
126 $language_manager->updateLockedLanguageWeights();
129 // Update URL Prefixes for all languages after the
130 // LanguageManagerInterface::getLanguages() cache is flushed.
131 language_negotiation_url_prefixes_update();
133 // If after adding this language the site will become multilingual, we need
134 // to rebuild language services.
135 if (!$this->preSaveMultilingual && !$update && $language_manager instanceof ConfigurableLanguageManagerInterface) {
136 $language_manager::rebuildServices();
139 // Install any available language configuration overrides for the language.
140 \Drupal::service('language.config_factory_override')->installLanguageOverrides($this->id());
147 * @throws \DeleteDefaultLanguageException
148 * Exception thrown if we're trying to delete the default language entity.
149 * This is not allowed as a site must have a default language.
151 public static function preDelete(EntityStorageInterface $storage, array $entities) {
152 $default_langcode = static::getDefaultLangcode();
153 foreach ($entities as $entity) {
154 if ($entity->id() == $default_langcode && !$entity->isUninstalling()) {
155 throw new DeleteDefaultLanguageException('Can not delete the default language');
163 public static function postDelete(EntityStorageInterface $storage, array $entities) {
164 parent::postDelete($storage, $entities);
165 $language_manager = \Drupal::languageManager();
166 $language_manager->reset();
167 $entity = reset($entities);
168 if ($language_manager instanceof ConfigurableLanguageManagerInterface && !$entity->isUninstalling() && !$entity->isSyncing()) {
169 $language_manager->updateLockedLanguageWeights();
171 // If after deleting this language the site will become monolingual, we need
172 // to rebuild language services.
173 if (!\Drupal::languageManager()->isMultilingual()) {
174 ConfigurableLanguageManager::rebuildServices();
179 * Gets the default langcode.
182 * The current default langcode.
184 protected static function getDefaultLangcode() {
185 $language = \Drupal::service('language.default')->get();
186 return $language->getId();
192 public function getName() {
193 return $this->label();
199 public function setName($name) {
200 $this->label = $name;
208 public function getId() {
215 public function getDirection() {
216 return $this->direction;
222 public function getWeight() {
223 return $this->weight;
229 public function setWeight($weight) {
230 $this->weight = $weight;
235 * Creates a configurable language object from a langcode.
237 * @param string $langcode
238 * The language code to use to create the object.
242 * @see \Drupal\Core\Language\LanguageManager::getStandardLanguageList()
244 public static function createFromLangcode($langcode) {
245 $standard_languages = LanguageManager::getStandardLanguageList();
246 if (!isset($standard_languages[$langcode])) {
247 // Drupal does not know about this language, so we set its values with the
248 // best guess. The user will be able to edit afterwards.
249 return static::create([
251 'label' => $langcode,
255 // A known predefined language, details will be filled in properly.
256 return static::create([
258 'label' => $standard_languages[$langcode][0],
259 'direction' => isset($standard_languages[$langcode][2]) ? $standard_languages[$langcode][2] : static::DIRECTION_LTR,