You are here

class LingotekContentMetadataFieldItemList in Lingotek Translation 3.0.x

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/LingotekContentMetadataFieldItemList.php \Drupal\lingotek\Plugin\Field\LingotekContentMetadataFieldItemList
  2. 4.0.x src/Plugin/Field/LingotekContentMetadataFieldItemList.php \Drupal\lingotek\Plugin\Field\LingotekContentMetadataFieldItemList
  3. 3.1.x src/Plugin/Field/LingotekContentMetadataFieldItemList.php \Drupal\lingotek\Plugin\Field\LingotekContentMetadataFieldItemList
  4. 3.2.x src/Plugin/Field/LingotekContentMetadataFieldItemList.php \Drupal\lingotek\Plugin\Field\LingotekContentMetadataFieldItemList
  5. 3.3.x src/Plugin/Field/LingotekContentMetadataFieldItemList.php \Drupal\lingotek\Plugin\Field\LingotekContentMetadataFieldItemList
  6. 3.4.x src/Plugin/Field/LingotekContentMetadataFieldItemList.php \Drupal\lingotek\Plugin\Field\LingotekContentMetadataFieldItemList
  7. 3.5.x src/Plugin/Field/LingotekContentMetadataFieldItemList.php \Drupal\lingotek\Plugin\Field\LingotekContentMetadataFieldItemList
  8. 3.6.x src/Plugin/Field/LingotekContentMetadataFieldItemList.php \Drupal\lingotek\Plugin\Field\LingotekContentMetadataFieldItemList
  9. 3.7.x src/Plugin/Field/LingotekContentMetadataFieldItemList.php \Drupal\lingotek\Plugin\Field\LingotekContentMetadataFieldItemList
  10. 3.8.x src/Plugin/Field/LingotekContentMetadataFieldItemList.php \Drupal\lingotek\Plugin\Field\LingotekContentMetadataFieldItemList

A computed field that provides a content entity's Lingotek metadata.

Hierarchy

Expanded class hierarchy of LingotekContentMetadataFieldItemList

1 file declares its use of LingotekContentMetadataFieldItemList
LingotekContentTranslationHandler.php in src/LingotekContentTranslationHandler.php

File

src/Plugin/Field/LingotekContentMetadataFieldItemList.php, line 11

Namespace

Drupal\lingotek\Plugin\Field
View source
class LingotekContentMetadataFieldItemList extends EntityReferenceFieldItemList {

  /**
   * Gets the Lingotek metadata entity linked to a content entity revision.
   *
   * @return \Drupal\lingotek\LingotekContentMetadataInterface|null
   *   The content entity's Lingotek metadata.
   */
  protected function getContentMetadata() {
    $entity = $this
      ->getEntity();

    /** @var LingotekConfigurationServiceInterface $config_service */
    $config_service = \Drupal::service('lingotek.configuration');
    if (!$config_service
      ->isEnabled($entity
      ->getEntityTypeId(), $entity
      ->bundle())) {
      return NULL;
    }
    if ($entity
      ->id()) {
      $metadata_result = \Drupal::entityTypeManager()
        ->getStorage('lingotek_content_metadata')
        ->getQuery()
        ->condition('content_entity_type_id', $entity
        ->getEntityTypeId())
        ->condition('content_entity_id', $entity
        ->id())
        ->execute();
      if ($metadata_id = key($metadata_result)) {

        /** @var \Drupal\lingotek\LingotekContentMetadataInterface $metadata */
        $metadata = \Drupal::entityTypeManager()
          ->getStorage('lingotek_content_metadata')
          ->load($metadata_id);
        return $metadata;
      }
    }
    $metadata = LingotekContentMetadata::create();
    if ($entity
      ->id()) {
      $metadata
        ->setEntity($entity);
      $metadata
        ->save();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function get($index) {
    if ($index !== 0) {
      throw new \InvalidArgumentException('An entity can not have multiple moderation states at the same time.');
    }
    if (isset($this->list[$index]) && !$this->list[$index]
      ->isEmpty()) {
      return $this->list[$index];
    }
    $this
      ->computeLingotekMetadataFieldItemList();
    return isset($this->list[$index]) ? $this->list[$index] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getIterator() {
    $this
      ->computeLingotekMetadataFieldItemList();
    return parent::getIterator();
  }

  /**
   * Recalculate the Lingotek metadata field item list.
   */
  protected function computeLingotekMetadataFieldItemList() {

    // Compute the value of the moderation state.
    $index = 0;
    if (!isset($this->list[$index]) || $this->list[$index]
      ->isEmpty()) {
      $metadata = $this
        ->getContentMetadata();

      // Do not store NULL values in the static cache.
      if ($metadata) {
        $this->list[$index] = $this
          ->createItem($index, [
          'entity' => $metadata,
        ]);
      }
    }
  }

  /**
   * {@inheritDoc}
   */
  public function preSave() {

    /** @var \Drupal\lingotek\Entity\LingotekContentMetadata $metadata */
    $metadata = $this
      ->getContentMetadata();
    if ($metadata && !$metadata
      ->getContentEntityId()) {
      $metadata
        ->setEntity($this
        ->getEntity());
    }
    parent::preSave();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityReferenceFieldItemList::defaultValuesFormSubmit public function Processes the submitted default value. Overrides FieldItemList::defaultValuesFormSubmit
EntityReferenceFieldItemList::getConstraints public function Gets a list of validation constraints. Overrides FieldItemList::getConstraints
EntityReferenceFieldItemList::processDefaultValue public static function Processes the default value before being applied. Overrides FieldItemList::processDefaultValue
EntityReferenceFieldItemList::referencedEntities public function Gets the entities referenced by this field, preserving field item deltas. Overrides EntityReferenceFieldItemListInterface::referencedEntities
FieldItemList::$langcode protected property The langcode of the field values held in the object.
FieldItemList::$list protected property Numerically indexed array of field items. Overrides ItemList::$list 1
FieldItemList::access public function Checks data value access. Overrides AccessibleInterface::access 1
FieldItemList::applyDefaultValue public function Applies the default value. Overrides TypedData::applyDefaultValue
FieldItemList::createItem protected function Helper for creating a list item object. Overrides ItemList::createItem
FieldItemList::defaultAccess public function Contains the default access logic of this field. Overrides FieldItemListInterface::defaultAccess 3
FieldItemList::defaultValuesForm public function Returns a form for the default value input. Overrides FieldItemListInterface::defaultValuesForm 2
FieldItemList::defaultValuesFormValidate public function Validates the submitted default value. Overrides FieldItemListInterface::defaultValuesFormValidate 1
FieldItemList::defaultValueWidget protected function Returns the widget object used in default value form.
FieldItemList::delegateMethod protected function Calls a method on each FieldItem.
FieldItemList::delete public function Defines custom delete behavior for field values. Overrides FieldItemListInterface::delete 2
FieldItemList::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemListInterface::deleteRevision 1
FieldItemList::equals public function Determines equality to another object implementing FieldItemListInterface. Overrides FieldItemListInterface::equals 2
FieldItemList::filterEmptyItems public function Filters out empty field items and re-numbers the item deltas. Overrides FieldItemListInterface::filterEmptyItems
FieldItemList::generateSampleItems public function Populates a specified number of field items with valid sample data. Overrides FieldItemListInterface::generateSampleItems 1
FieldItemList::getEntity public function Gets the entity that field belongs to. Overrides FieldItemListInterface::getEntity 1
FieldItemList::getFieldDefinition public function Gets the field definition. Overrides FieldItemListInterface::getFieldDefinition
FieldItemList::getLangcode public function Gets the langcode of the field values held in the object. Overrides FieldItemListInterface::getLangcode
FieldItemList::getSetting public function Returns the value of a given field setting. Overrides FieldItemListInterface::getSetting
FieldItemList::getSettings public function Returns the array of field settings. Overrides FieldItemListInterface::getSettings
FieldItemList::hasAffectingChanges public function Determines whether the field has relevant changes. Overrides FieldItemListInterface::hasAffectingChanges 1
FieldItemList::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemListInterface::postSave 1
FieldItemList::setLangcode public function Sets the langcode of the field values held in the object. Overrides FieldItemListInterface::setLangcode
FieldItemList::setValue public function Sets the data value. Overrides ItemList::setValue
FieldItemList::view public function Returns a renderable array for the field items. Overrides FieldItemListInterface::view
FieldItemList::__get public function Magic method: Gets a property value of to the first field item. Overrides FieldItemListInterface::__get
FieldItemList::__isset public function Magic method: Determines whether a property of the first field item is set. Overrides FieldItemListInterface::__isset
FieldItemList::__set public function Magic method: Sets a property value of the first field item. Overrides FieldItemListInterface::__set
FieldItemList::__unset public function Magic method: Unsets a property of the first field item. Overrides FieldItemListInterface::__unset
ItemList::appendItem public function Appends a new item to the list. Overrides ListInterface::appendItem
ItemList::count public function
ItemList::filter public function Filters the items in the list using a custom callback. Overrides ListInterface::filter
ItemList::first public function Returns the first item in this list. Overrides ListInterface::first
ItemList::getItemDefinition public function Gets the definition of a contained item. Overrides ListInterface::getItemDefinition
ItemList::getString public function Returns a string representation of the data. Overrides TypedData::getString
ItemList::getValue public function Gets the data value. Overrides TypedData::getValue
ItemList::isEmpty public function Determines whether the list contains any non-empty items. Overrides ListInterface::isEmpty
ItemList::offsetExists public function 1
ItemList::offsetGet public function
ItemList::offsetSet public function
ItemList::offsetUnset public function
ItemList::onChange public function React to changes to a child property or item. Overrides TraversableTypedDataInterface::onChange 1
ItemList::rekey protected function Renumbers the items in the list.
ItemList::removeItem public function Removes the item at the specified position. Overrides ListInterface::removeItem
ItemList::set public function Sets the value of the item at a given position in the list. Overrides ListInterface::set
ItemList::__clone public function Magic method: Implements a deep clone.
LingotekContentMetadataFieldItemList::computeLingotekMetadataFieldItemList protected function Recalculate the Lingotek metadata field item list.
LingotekContentMetadataFieldItemList::get public function Returns the item at the specified position in this list. Overrides ItemList::get
LingotekContentMetadataFieldItemList::getContentMetadata protected function Gets the Lingotek metadata entity linked to a content entity revision.
LingotekContentMetadataFieldItemList::getIterator public function Overrides ItemList::getIterator
LingotekContentMetadataFieldItemList::preSave public function Defines custom presave behavior for field values. Overrides FieldItemList::preSave
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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::createInstance public static function Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
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. 3
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