class LanguageReference
Same name in other branches
- 9 core/lib/Drupal/Core/TypedData/Plugin/DataType/LanguageReference.php \Drupal\Core\TypedData\Plugin\DataType\LanguageReference
- 8.9.x core/lib/Drupal/Core/TypedData/Plugin/DataType/LanguageReference.php \Drupal\Core\TypedData\Plugin\DataType\LanguageReference
- 11.x core/lib/Drupal/Core/TypedData/Plugin/DataType/LanguageReference.php \Drupal\Core\TypedData\Plugin\DataType\LanguageReference
Defines the 'language_reference' data type.
This serves as 'language' property of language field items and gets its value set from the parent, i.e. LanguageItem.
The plain value is the language object, i.e. an instance of \Drupal\Core\Language\Language. For setting the value the language object or the language code as string may be passed.
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\TypedDataInterface, \Drupal\Component\Plugin\PluginInspectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\TypedData\TypedDataTrait
- class \Drupal\Core\TypedData\DataReferenceBase extends \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\DataReferenceInterface
- class \Drupal\Core\TypedData\Plugin\DataType\LanguageReference extends \Drupal\Core\TypedData\DataReferenceBase
- class \Drupal\Core\TypedData\DataReferenceBase extends \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\DataReferenceInterface
Expanded class hierarchy of LanguageReference
1 file declares its use of LanguageReference
- ConfigEntityValidationTestBase.php in core/
tests/ Drupal/ KernelTests/ Core/ Config/ ConfigEntityValidationTestBase.php
File
-
core/
lib/ Drupal/ Core/ TypedData/ Plugin/ DataType/ LanguageReference.php, line 21
Namespace
Drupal\Core\TypedData\Plugin\DataTypeView source
class LanguageReference extends DataReferenceBase {
/**
* {@inheritdoc}
*/
public function getTargetIdentifier() {
$language = $this->getTarget();
return isset($language) ? $language->id() : NULL;
}
/**
* Returns all valid values for a `langcode` config value.
*
* @return string[]
* All possible valid langcodes. This includes all langcodes in the standard
* list of human languages, along with special langcodes like `und`, `zxx`,
* and `site_default`, which Drupal uses internally. If any custom languages
* are defined, they will be included as well.
*
* @see \Drupal\Core\Language\LanguageManagerInterface::getLanguages()
* @see \Drupal\Core\Language\LanguageManagerInterface::getStandardLanguageList()
*/
public static function getAllValidLangcodes() : array {
$language_manager = \Drupal::languageManager();
return array_unique([
array_keys($language_manager::getStandardLanguageList()),
// We can't use LanguageInterface::STATE_ALL because it will exclude the
// site default language in certain situations.
// @see \Drupal\Core\Language\LanguageManager::filterLanguages()
array_keys($language_manager->getLanguages(LanguageInterface::STATE_LOCKED | LanguageInterface::STATE_CONFIGURABLE | LanguageInterface::STATE_SITE_DEFAULT)),
// Include special language codes used internally.
LanguageInterface::LANGCODE_NOT_APPLICABLE,
LanguageInterface::LANGCODE_SITE_DEFAULT,
LanguageInterface::LANGCODE_DEFAULT,
LanguageInterface::LANGCODE_SYSTEM,
LanguageInterface::LANGCODE_NOT_SPECIFIED,
]);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DataReferenceBase::$target | protected | property | The referenced data. | ||
DataReferenceBase::getString | public | function | Returns a string representation of the data. | Overrides TypedData::getString | 1 |
DataReferenceBase::getTarget | public | function | Gets the referenced data. | Overrides DataReferenceInterface::getTarget | 1 |
DataReferenceBase::getValue | public | function | Gets the data value. | Overrides TypedData::getValue | |
DataReferenceBase::setValue | public | function | Sets the data value. | Overrides TypedData::setValue | 1 |
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
LanguageReference::getAllValidLangcodes | public static | function | Returns all valid values for a `langcode` config value. | ||
LanguageReference::getTargetIdentifier | public | function | Gets the identifier of the referenced data. | Overrides DataReferenceInterface::getTargetIdentifier | |
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. | ||
TypedData::$definition | protected | property | The data definition. | 1 | |
TypedData::$name | protected | property | The property name. | ||
TypedData::$parent | protected | property | The parent typed data object. | ||
TypedData::applyDefaultValue | public | function | Applies the default value. | Overrides TypedDataInterface::applyDefaultValue | 3 |
TypedData::createInstance | public static | function | Constructs a TypedData object given its definition and context. | Overrides TypedDataInterface::createInstance | |
TypedData::getConstraints | public | function | Gets a list of validation constraints. | Overrides TypedDataInterface::getConstraints | 8 |
TypedData::getDataDefinition | public | function | Gets the data definition. | Overrides TypedDataInterface::getDataDefinition | |
TypedData::getName | public | function | Returns the name of a property or item. | Overrides TypedDataInterface::getName | |
TypedData::getParent | public | function | Returns the parent data structure; i.e. either complex data or a list. | Overrides TypedDataInterface::getParent | |
TypedData::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | |
TypedData::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
TypedData::getPropertyPath | public | function | Returns the property path of the data. | Overrides TypedDataInterface::getPropertyPath | |
TypedData::getRoot | public | function | Returns the root of the typed data tree. | Overrides TypedDataInterface::getRoot | |
TypedData::setContext | public | function | Sets the context of a property or item via a context aware parent. | Overrides TypedDataInterface::setContext | |
TypedData::validate | public | function | Validates the currently set data value. | Overrides TypedDataInterface::validate | |
TypedData::__construct | public | function | Constructs a TypedData object given its definition and context. | 4 | |
TypedDataTrait::$typedDataManager | protected | property | The typed data manager used for creating the data types. | ||
TypedDataTrait::getTypedDataManager | public | function | Gets the typed data manager. | 2 | |
TypedDataTrait::setTypedDataManager | public | function | Sets the typed data manager. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.