Documentation & API reference
class Language
Same name in this branch
- 8.x drupal/core/lib/Drupal/Core/Language/Language.php \Drupal\Core\Language\Language
- 8.x drupal/core/lib/Drupal/Core/TypedData/Type/Language.php \Drupal\Core\TypedData\Type\Language
- 8.x drupal/core/modules/language/lib/Drupal/language/Plugin/Condition/Language.php \Drupal\language\Plugin\Condition\Language
- 8.x drupal/core/vendor/symfony/validator/Symfony/Component/Validator/Constraints/Language.php \Symfony\Component\Validator\Constraints\Language
- 8.x drupal/core/modules/node/lib/Drupal/node/Plugin/views/field/Language.php \Drupal\node\Plugin\views\field\Language
- 8.x drupal/core/modules/user/lib/Drupal/user/Plugin/views/field/Language.php \Drupal\user\Plugin\views\field\Language
- 8.x drupal/core/modules/taxonomy/lib/Drupal/taxonomy/Plugin/views/field/Language.php \Drupal\taxonomy\Plugin\views\field\Language
Defines the 'language' data type.
The plain value of a language 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.
Optionally, this class may be used as computed property, see the supported settings below. E.g., it is used as 'language' property of language items.
Supported settings (below the definition's 'settings' key) are:
- langcode source: If used as computed property, the langcode property used to load the language object.
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements TypedDataInterface
- class \Drupal\Core\TypedData\Type\Language
Expanded class hierarchy of Language
48 string references to 'Language'
- breakpoint.schema.yml in drupal/
core/ modules/ breakpoint/ config/ schema/ breakpoint.schema.yml - drupal/core/modules/breakpoint/config/schema/breakpoint.schema.yml
- comment_views_data in drupal/
core/ modules/ comment/ comment.views.inc - Implements hook_views_data().
- CustomBlockFormController::form in drupal/
core/ modules/ block/ custom_block/ lib/ Drupal/ custom_block/ CustomBlockFormController.php - Overrides \Drupal\Core\Entity\EntityFormController::form().
- editor.schema.yml in drupal/
core/ modules/ editor/ config/ schema/ editor.schema.yml - drupal/core/modules/editor/config/schema/editor.schema.yml
- EntityTestFormController::form in drupal/
core/ modules/ system/ tests/ modules/ entity_test/ lib/ Drupal/ entity_test/ EntityTestFormController.php - Overrides Drupal\Core\Entity\EntityFormController::form().
File
- drupal/
core/ lib/ Drupal/ Core/ TypedData/ Type/ Language.php, line 28 - Contains \Drupal\Core\TypedData\Type\Language.
Namespace
Drupal\Core\TypedData\TypeView source
class Language extends TypedData {
/**
* The language code of the language if no 'langcode source' is used.
*
* @var string
*/
protected $langcode;
/**
* Overrides TypedData::getValue().
*/
public function getValue() {
if (!empty($this->definition['settings']['langcode source'])) {
$this->langcode = $this->parent
->__get($this->definition['settings']['langcode source']);
}
if ($this->langcode) {
$language = language_load($this->langcode);
return $language ?: new LanguageObject(array(
'langcode' => $this->langcode,
));
}
}
/**
* Overrides TypedData::setValue().
*
* Both the langcode and the language object may be passed as value.
*/
public function setValue($value, $notify = TRUE) {
// Support passing language objects.
if (is_object($value)) {
$value = $value->langcode;
}
elseif (isset($value) && !is_scalar($value)) {
throw new InvalidArgumentException('Value is no valid langcode or language object.');
}
// Update the 'langcode source' property, if given.
if (!empty($this->definition['settings']['langcode source'])) {
$this->parent
->__set($this->definition['settings']['langcode source'], $value, $notify);
}
else {
// Notify the parent of any changes to be made.
if ($notify && isset($this->parent)) {
$this->parent
->onChange($this->name);
}
$this->langcode = $value;
}
}
/**
* Overrides TypedData::getString().
*/
public function getString() {
$language = $this
->getValue();
return $language ? $language->name : '';
}
}