class ContributorName in Bibliography & Citation 8

Contributor name computed field.

Hierarchy

• class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
  • class \Drupal\Core\TypedData\Plugin\DataType\ItemList implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ListInterface
    • class \Drupal\Core\Field\FieldItemList implements FieldItemListInterface
      • class \Drupal\bibcite_entity\ContributorName uses ComputedItemListTrait

File

modules/bibcite_entity/src/ContributorName.php, line 11

Namespace

Drupal\bibcite_entity

class ContributorName extends FieldItemList {
  use ComputedItemListTrait {
    get as traitGet;
  }

  /**
   * {@inheritdoc}
   */
  protected function computeValue() {

    /** @var \Drupal\bibcite_entity\Entity\ContributorInterface $contributor */
    $contributor = $this->parent
      ->getValue();
    $arguments = [];
    foreach ($contributor::getNameParts() as $part) {
      $arguments["@{$part}"] = $contributor
        ->get($part)->value;
    }

    // @todo Dependency injection.
    $format = \Drupal::config('bibcite_entity.contributor.settings')
      ->get('full_name_pattern') ?: '@prefix @first_name @last_name @suffix';
    $full_name = strtr($format, $arguments);
    $value = trim(preg_replace('/\\s+/', ' ', $full_name));
    $this->list[0] = $this
      ->createItem(0, $value);
  }

  /**
   * Compute values every time.
   */
  protected function ensureComputedValue() {
    $this
      ->computeValue();
  }

  /**
   * {@inheritdoc}
   */
  public function get($index) {
    if ($index !== 0) {
      throw new \InvalidArgumentException("A contributor entity cannot have multiple names at the same time.");
    }
    return $this
      ->traitGet($index);
  }

  /**
   * {@inheritdoc}
   */
  public function setValue($values, $notify = TRUE) {
    parent::setValue($values, $notify);

    // Gather new string value, so we do not worry how it was set: as string
    // or as array.
    // We cannot use $this->value because it'll be newly calculated value but
    // from old name parts i.e. old value in result.
    // If the parent should be notified about the change,
    // update the contributor entity.
    if ($notify) {
      $value = isset($this->list[0]) ? $this->list[0]->value : NULL;
      $this
        ->updateContributorEntity($value);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function appendItem($value = NULL) {

    // Without this, the name field cannot be set via REST, it fails with
    // "Unprocessable Entity: validation failed. name: Name: this field cannot
    // hold more than 1 values." error.
    // There was similar issue with content moderation state computed field in
    // Drupal core, though the way it was fixed doesn't seem to be applicable
    // in our case.
    // We also do not care about handling offset other than 0 here, because it's
    // a single-value field.

    /* @see https://www.drupal.org/node/2943899 */

    /* @see \Drupal\serialization\Normalizer\FieldNormalizer::denormalize */

    /* @see \Drupal\Core\TypedData\ComputedItemListTrait::appendItem */

    /* @see \Drupal\content_moderation\Plugin\Field\ModerationStateFieldItemList */
    $item = $this
      ->createItem(0, $value);
    $this->list[0] = $item;
    return $item;
  }

  /**
   * {@inheritdoc}
   */
  public function onChange($delta) {

    /* @see \Drupal\content_moderation\Plugin\Field\ModerationStateFieldItemList::onChange */
    $this
      ->updateContributorEntity($this->list[$delta]->value);
    parent::onChange($delta);
  }

  /**
   * Updates name parts of the bibcite_contributor entity.
   *
   * @param string $name
   *   Full name string.
   */
  protected function updateContributorEntity($name) {

    /** @var \Drupal\bibcite_entity\Entity\Contributor $entity */
    $entity = $this
      ->getEntity();
    if ($name) {
      $name_parts = \Drupal::service('bibcite.human_name_parser')
        ->parse($name);

      // Explicitly map name parts. Entity fields names and keys returned by
      // the name parser do not have to be the same.
      $entity->prefix = $name_parts['prefix'];
      $entity->leading_title = $name_parts['leading_title'];
      $entity->first_name = $name_parts['first_name'];
      $entity->middle_name = $name_parts['middle_name'];
      $entity->last_name = $name_parts['last_name'];
      $entity->nick = $name_parts['nick'];
      $entity->suffix = $name_parts['suffix'];
    }
    else {
      $part_value = $name === '' ? '' : NULL;
      foreach ($entity::getNameParts() as $name_part) {
        $entity
          ->set($name_part, $part_value);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ComputedItemListTrait::$valueComputed	protected	property	Whether the values have already been computed or not.
ComputedItemListTrait::applyDefaultValue	public	function
ComputedItemListTrait::count	public	function
ComputedItemListTrait::get	public	function	Aliased as: traitGet
ComputedItemListTrait::getIterator	public	function
ComputedItemListTrait::getString	public	function
ComputedItemListTrait::getValue	public	function
ComputedItemListTrait::isEmpty	public	function
ComputedItemListTrait::offsetExists	public	function
ComputedItemListTrait::removeItem	public	function
ComputedItemListTrait::set	public	function
ContributorName::appendItem	public	function	Appends a new item to the list. Overrides ComputedItemListTrait::appendItem
ContributorName::computeValue	protected	function	Computes the values for an item list. Overrides ComputedItemListTrait::computeValue
ContributorName::ensureComputedValue	protected	function	Compute values every time. Overrides ComputedItemListTrait::ensureComputedValue
ContributorName::get	public	function	Returns the item at the specified position in this list. Overrides ItemList::get
ContributorName::onChange	public	function	React to changes to a child property or item. Overrides ItemList::onChange
ContributorName::setValue	public	function	Sets the data value. Overrides ComputedItemListTrait::setValue
ContributorName::updateContributorEntity	protected	function	Updates name parts of the bibcite_contributor entity.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
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::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::defaultValuesFormSubmit	public	function	Processes the submitted default value. Overrides FieldItemListInterface::defaultValuesFormSubmit	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
FieldItemList::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedData::getConstraints	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::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemListInterface::preSave	1
FieldItemList::processDefaultValue	public static	function	Processes the default value before being applied. Overrides FieldItemListInterface::processDefaultValue	2
FieldItemList::setLangcode	public	function	Sets the langcode of the field values held in the object. Overrides FieldItemListInterface::setLangcode
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::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::offsetGet	public	function
ItemList::offsetSet	public	function
ItemList::offsetUnset	public	function
ItemList::rekey	protected	function	Renumbers the items in the list.
ItemList::__clone	public	function	Magic method: Implements a deep clone.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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