class FormEntityTypedDataReferencedEntityDeriver in Flexiform 8

Provides a deriver class for Flexiform form entities.

Hierarchy

• class \Drupal\Component\Plugin\Derivative\DeriverBase implements DeriverInterface
  • class \Drupal\ctools\Plugin\Deriver\TypedDataPropertyDeriverBase implements ContainerDeriverInterface uses StringTranslationTrait
    • class \Drupal\flexiform\Plugin\Deriver\FormEntityTypedDataReferencedEntityDeriver

File

src/Plugin/Deriver/FormEntityTypedDataReferencedEntityDeriver.php, line 16

Namespace

Drupal\flexiform\Plugin\Deriver

class FormEntityTypedDataReferencedEntityDeriver extends TypedDataPropertyDeriverBase {

  /**
   * The entity type bundle info.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityBundleInfo;

  /**
   * FormEntityTypedDataReferencedEntityDeriver constructor.
   *
   * @param \Drupal\Core\TypedData\TypedDataManagerInterface $typed_data_manager
   *   The typed data manager.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translation service.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_bundle_info
   *   The entity type manager service.
   */
  public function __construct(TypedDataManagerInterface $typed_data_manager, TranslationInterface $string_translation, EntityTypeBundleInfoInterface $entity_bundle_info) {
    parent::__construct($typed_data_manager, $string_translation);
    $this->entityBundleInfo = $entity_bundle_info;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, $base_plugin_id) {
    return new static($container
      ->get('typed_data_manager'), $container
      ->get('string_translation'), $container
      ->get('entity_type.bundle.info'));
  }

  /**
   * {@inheritdoc}
   */
  protected function generateDerivativeDefinition($base_plugin_definition, $data_type_id, $data_type_definition, DataDefinitionInterface $base_definition, $property_name, DataDefinitionInterface $property_definition) {

    // Only add derivatives on entity reference fields.
    if (!method_exists($property_definition, 'getType') || $property_definition
      ->getType() != 'entity_reference') {
      return;
    }

    /* @var \Drupal\Core\Field\FieldDefinitionInterface $property_definition */
    $bundle_info = $base_definition
      ->getConstraint('Bundle');

    // Identify base definitions that appear on bundle-able entities.
    if ($bundle_info && array_filter($bundle_info) && $base_definition
      ->getConstraint('EntityType')) {
      $base_data_type = 'entity:' . $base_definition
        ->getConstraint('EntityType');
    }
    else {
      $base_data_type = $data_type_id;
    }

    // If we've not processed this thing before.
    if (!isset($this->derivatives[$base_data_type . ':' . $property_name])) {
      $derivative = $base_plugin_definition;
      $derivative['label'] = $this
        ->t('@property Entity from @base', [
        '@property' => $property_definition
          ->getLabel(),
        '@base' => $data_type_definition['label'],
      ]);
      $context_definition = new ContextDefinition($base_data_type, $data_type_definition['label'], TRUE);

      // Add the constraints of the base definition to the context definition.
      if ($base_definition
        ->getConstraint('Bundle')) {
        $context_definition
          ->addConstraint('Bundle', $base_definition
          ->getConstraint('Bundle'));
      }
      $derivative['context'] = [
        'base' => $context_definition,
      ];
      $derivative['property_name'] = $property_name;
      $derivative['entity_type'] = $property_definition
        ->getFieldStorageDefinition()
        ->getPropertyDefinition('entity')
        ->getConstraint('EntityType');
      if ($bundle = $property_definition
        ->getFieldStorageDefinition()
        ->getPropertyDefinition('entity')
        ->getConstraint('Bundle')) {
        $derivative['bundle'] = $bundle;
        $this->derivatives[$base_data_type . ':' . $property_name . ':' . $bundle] = $derivative;
      }
      else {
        $label = $derivative['label'];
        foreach ($this->entityBundleInfo
          ->getBundleInfo($derivative['entity_type']) as $bundle => $info) {
          $derivative['label'] = $label . ' (' . $info['label'] . ')';
          $derivative['bundle'] = $bundle;
          $this->derivatives[$base_data_type . ':' . $property_name . ':' . $bundle] = $derivative;
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DeriverBase::$derivatives	protected	property	List of derivative definitions.	1
DeriverBase::getDerivativeDefinition	public	function	Gets the definition of a derivative plugin. Overrides DeriverInterface::getDerivativeDefinition
FormEntityTypedDataReferencedEntityDeriver::$entityBundleInfo	protected	property	The entity type bundle info.
FormEntityTypedDataReferencedEntityDeriver::create	public static	function	Creates a new class instance. Overrides TypedDataPropertyDeriverBase::create
FormEntityTypedDataReferencedEntityDeriver::generateDerivativeDefinition	protected	function	Generates and maintains a derivative definition. Overrides TypedDataPropertyDeriverBase::generateDerivativeDefinition
FormEntityTypedDataReferencedEntityDeriver::__construct	public	function	FormEntityTypedDataReferencedEntityDeriver constructor. Overrides TypedDataPropertyDeriverBase::__construct
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.
TypedDataPropertyDeriverBase::$label	protected	property	The label string for use with derivative labels.	2
TypedDataPropertyDeriverBase::$typedDataManager	protected	property
TypedDataPropertyDeriverBase::getDataType	protected	function
TypedDataPropertyDeriverBase::getDerivativeDefinitions	public	function	Gets the definition of all derivatives of a base plugin. Overrides DeriverBase::getDerivativeDefinitions	1