Language.php

Same filename in this branch
  1. 11.x core/modules/language/src/Plugin/migrate/source/Language.php
  2. 11.x core/modules/language/src/Plugin/Condition/Language.php
  3. 11.x core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Language.php
  4. 11.x core/lib/Drupal/Core/Language/Language.php
Same filename in other branches
  1. 9 core/modules/language/src/Plugin/migrate/source/Language.php
  2. 9 core/modules/language/src/Plugin/Condition/Language.php
  3. 9 core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Language.php
  4. 9 core/modules/ckeditor/src/Plugin/CKEditorPlugin/Language.php
  5. 9 core/lib/Drupal/Core/TypedData/Plugin/DataType/Language.php
  6. 9 core/lib/Drupal/Core/Language/Language.php
  7. 8.9.x core/modules/language/src/Plugin/migrate/source/Language.php
  8. 8.9.x core/modules/language/src/Plugin/Condition/Language.php
  9. 8.9.x core/modules/ckeditor/src/Plugin/CKEditorPlugin/Language.php
  10. 8.9.x core/lib/Drupal/Core/TypedData/Plugin/DataType/Language.php
  11. 8.9.x core/lib/Drupal/Core/Language/Language.php
  12. 10 core/modules/language/src/Plugin/migrate/source/Language.php
  13. 10 core/modules/language/src/Plugin/Condition/Language.php
  14. 10 core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Language.php
  15. 10 core/lib/Drupal/Core/TypedData/Plugin/DataType/Language.php
  16. 10 core/lib/Drupal/Core/Language/Language.php

Namespace

Drupal\Core\TypedData\Plugin\DataType

File

core/lib/Drupal/Core/TypedData/Plugin/DataType/Language.php

View source
<?php

namespace Drupal\Core\TypedData\Plugin\DataType;

use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\TypedData\Attribute\DataType;
use Drupal\Core\TypedData\TypedData;

/**
 * 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.
 */
class Language extends TypedData {
    
    /**
     * The id of the language.
     *
     * @var string
     */
    protected $id;
    
    /**
     * @var \Drupal\Core\Language\Language
     */
    protected $language;
    
    /**
     * Overrides TypedData::getValue().
     *
     * @return \Drupal\Core\Language\LanguageInterface|null
     */
    public function getValue() {
        if (!isset($this->language) && $this->id) {
            $this->language = \Drupal::languageManager()->getLanguage($this->id);
        }
        return $this->language;
    }
    
    /**
     * 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)) {
            $this->id = $value->getId();
            $this->language = $value;
        }
        elseif (isset($value) && !is_scalar($value)) {
            throw new \InvalidArgumentException('Value is no valid langcode or language object.');
        }
        else {
            $this->id = $value;
            $this->language = NULL;
        }
        // Notify the parent of any changes.
        if ($notify && isset($this->parent)) {
            $this->parent
                ->onChange($this->name);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getString() {
        $language = $this->getValue();
        return $language ? $language->getName() : '';
    }
    
    /**
     * {@inheritdoc}
     */
    public function id() {
        if (isset($this->id)) {
            return $this->id;
        }
        elseif (isset($this->language)) {
            return $this->language
                ->getId();
        }
    }

}

Classes

Title Deprecated Summary
Language Defines the 'language' data type.

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