Version 1

[yaffs-website] / web / core / lib / Drupal / Core / Field / Plugin / Field / FieldType / LanguageItem.php

diff --git a/web/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/LanguageItem.php b/web/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/LanguageItem.php
new file mode 100644 (file)
index 0000000..18935c1
--- /dev/null
+++ b/web/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/LanguageItem.php
@@ -0,0 +1,120 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\FieldStorageDefinitionInterface;
+use Drupal\Core\Field\FieldItemBase;
+use Drupal\Core\Language\LanguageInterface;
+use Drupal\Core\TypedData\DataDefinition;
+use Drupal\Core\TypedData\DataReferenceDefinition;
+
+/**
+ * Defines the 'language' entity field item.
+ *
+ * @FieldType(
+ *   id = "language",
+ *   label = @Translation("Language"),
+ *   description = @Translation("An entity field referencing a language."),
+ *   default_widget = "language_select",
+ *   default_formatter = "language",
+ *   no_ui = TRUE,
+ *   constraints = {
+ *     "ComplexData" = {
+ *       "value" = {
+ *         "Length" = {"max" = 12},
+ *         "AllowedValues" = {"callback" = "\Drupal\Core\Field\Plugin\Field\FieldType\LanguageItem::getAllowedLanguageCodes" }
+ *       }
+ *     }
+ *   }
+ * )
+ *
+ * @todo Define the AllowedValues constraint via an options provider once
+ *   https://www.drupal.org/node/2329937 is completed.
+ */
+class LanguageItem extends FieldItemBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
+    $properties['value'] = DataDefinition::create('string')
+      ->setLabel(t('Language code'))
+      ->setRequired(TRUE);
+
+    $properties['language'] = DataReferenceDefinition::create('language')
+      ->setLabel(t('Language object'))
+      ->setDescription(t('The referenced language'))
+      // The language object is retrieved via the language code.
+      ->setComputed(TRUE)
+      ->setReadOnly(FALSE);
+
+    return $properties;
+  }
+
+  /**
+   * Defines allowed language codes for the field's AllowedValues constraint.
+   *
+   * @return string[]
+   *   The allowed values.
+   */
+  public static function getAllowedLanguageCodes() {
+    return array_keys(\Drupal::languageManager()->getLanguages(LanguageInterface::STATE_ALL));
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function schema(FieldStorageDefinitionInterface $field_definition) {
+    return [
+      'columns' => [
+        'value' => [
+          'type' => 'varchar_ascii',
+          'length' => 12,
+        ],
+      ],
+    ];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setValue($values, $notify = TRUE) {
+    // Treat the values as property value of the language property, if no array
+    // is given as this handles language codes and objects.
+    if (isset($values) && !is_array($values)) {
+      $this->set('language', $values, $notify);
+    }
+    else {
+      // Make sure that the 'language' property gets set as 'value'.
+      if (isset($values['value']) && !isset($values['language'])) {
+        $values['language'] = $values['value'];
+      }
+      parent::setValue($values, $notify);
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function applyDefaultValue($notify = TRUE) {
+    // Default to the site's default language. When language module is enabled,
+    // this behavior is configurable, see language_field_info_alter().
+    $this->setValue(['value' => \Drupal::languageManager()->getDefaultLanguage()->getId()], $notify);
+    return $this;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function onChange($property_name, $notify = TRUE) {
+    // Make sure that the value and the language property stay in sync.
+    if ($property_name == 'value') {
+      $this->writePropertyValue('language', $this->value);
+    }
+    elseif ($property_name == 'language') {
+      $this->writePropertyValue('value', $this->get('language')->getTargetIdentifier());
+    }
+    parent::onChange($property_name, $notify);
+  }
+
+}