FieldInheritanceFactory.php in Field Inheritance 2.0.x

Namespace

Drupal\field_inheritance

File

src/FieldInheritanceFactory.php

<?php

namespace Drupal\field_inheritance;

use Drupal\Core\Field\FieldItemList;
use Drupal\Core\TypedData\ComputedItemListTrait;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\TypedData\TypedDataInterface;

/**
 * The FieldInheritanceFactory class.
 */
class FieldInheritanceFactory extends FieldItemList {
  use ComputedItemListTrait;

  /**
   * Constructs a FieldInheritanceFactory object.
   *
   * @param \Drupal\Core\Field\BaseFieldDefinition $definition
   *   The data definition.
   * @param string $name
   *   (optional) The name of the created property, or NULL if it is the root
   *   of a typed data tree. Defaults to NULL.
   * @param \Drupal\Core\TypedData\TypedDataInterface $parent
   *   (optional) The parent object of the data property, or NULL if it is the
   *   root of a typed data tree. Defaults to NULL.
   *
   * @see \Drupal\Core\TypedData\TypedDataManager::create()
   */
  public function __construct(BaseFieldDefinition $definition, $name = NULL, TypedDataInterface $parent = NULL) {
    parent::__construct($definition, $name, $parent);
    if ($this
      ->getSetting('plugin') === NULL) {
      throw new \InvalidArgumentException("The definition's 'plugin' key has to specify the plugin to use to inherit data.");
    }
    if ($this
      ->getSetting('method') === NULL) {
      throw new \InvalidArgumentException("The definition's 'method' key has to specify the method to use to inherit data. Valid options are inherit, prepend, replace, and append.");
    }
    if ($this
      ->getSetting('source entity type') === NULL) {
      throw new \InvalidArgumentException("The definition's 'source entity type' key has to specify the entity type from which to inherit data.");
    }
    if ($this
      ->getSetting('source entity bundle') === NULL) {
      throw new \InvalidArgumentException("The definition's 'source entity bundle' key has to specify the entity bundle from which to inherit data.");
    }
    if ($this
      ->getSetting('source field') === NULL) {
      throw new \InvalidArgumentException("The definition's 'source field' key has to specify the field from which to inherit data.");
    }
  }

  /**
   * Compute the field property from state.
   */
  protected function computeValue() {
    $entity = $this
      ->getEntity();
    $manager = $this
      ->getManager();
    $configuration = $this
      ->getSettings() + [
      'entity' => $entity,
    ];
    $plugin = $manager
      ->createInstance($this
      ->getSetting('plugin'), $configuration);
    $values = $plugin
      ->computeValue();
    if (!empty($values)) {
      foreach ($values as $key => $value) {
        $this->list[$key] = $this
          ->createItem($key, $value);
      }
    }
    else {
      $this
        ->applyDefaultValue();
    }
  }

  /**
   * Returns the FieldInheritancePluginManager plugin manager.
   *
   * @return \Drupal\field_inheritance\FieldInheritancePluginManager
   *   The FieldInheritancePluginManager plugin manager.
   */
  protected function getManager() {
    return \Drupal::service('plugin.manager.field_inheritance');
  }

}

Classes

Name	Description
FieldInheritanceFactory	The FieldInheritanceFactory class.