You are here

Home » API reference » Chaos Tool Suite (ctools) 8.3 » TypedDataRelationship.php

class TypedDataRelationship in Chaos Tool Suite (ctools) 8.3

Plugin annotation


@Relationship(
  id = "typed_data_relationship",
  deriver = "\Drupal\ctools\Plugin\Deriver\TypedDataRelationshipDeriver"
)

Hierarchy

Expanded class hierarchy of TypedDataRelationship

File

src/Plugin/Relationship/TypedDataRelationship.php, line 20

Namespace

Drupal\ctools\Plugin\Relationship
View source 
class TypedDataRelationship extends RelationshipBase {

  /**
   * {@inheritdoc}
   */
  public function getRelationship() {
    $plugin_definition = $this
      ->getPluginDefinition();
    $data_type = $plugin_definition['data_type'];
    if (strpos($data_type, 'entity:') === 0) {
      $context_definition = new EntityContextDefinition($data_type, $plugin_definition['label']);
    }
    else {
      $context_definition = new ContextDefinition($data_type, $plugin_definition['label']);
    }
    $context_value = NULL;

    // If the 'base' context has a value, then get the property value to put on
    // the context (otherwise, mapping hasn't occurred yet and we just want to
    // return the context with the right definition and no value).
    if ($this
      ->getContext('base')
      ->hasContextValue()) {
      $data = $this
        ->getData($this
        ->getContext('base'));
      $property = $this
        ->getMainPropertyName($data);
      $context_value = $data
        ->get($property)
        ->getValue();
    }
    $context_definition
      ->setDefaultValue($context_value);
    return new Context($context_definition, $context_value);
  }
  public function getName() {
    return $this
      ->getPluginDefinition()['property_name'];
  }
  protected function getData(ContextInterface $context) {

    /** @var \Drupal\Core\TypedData\ComplexDataInterface $base */
    $base = $context
      ->getContextValue();
    $name = $this
      ->getPluginDefinition()['property_name'];
    $data = $base
      ->get($name);

    // @todo add configuration to get N instead of first.
    if ($data instanceof ListInterface) {
      $data = $data
        ->first();
    }
    if ($data instanceof DataReferenceInterface) {
      $data = $data
        ->getTarget();
    }
    return $data;
  }
  protected function getMainPropertyName(FieldItemInterface $data) {
    return $data
      ->getFieldDefinition()
      ->getFieldStorageDefinition()
      ->getMainPropertyName();
  }
  public function getRelationshipValue() {
    $property = $this
      ->getMainPropertyName();

    /** @var \Drupal\Core\TypedData\ComplexDataInterface $data */
    $data = $this
      ->getRelationship()
      ->getContextData();
    $data
      ->get($property)
      ->getValue();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__construct public function Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides PluginBase::__construct 4
ContextAwarePluginBase::__get public function Implements magic __get() method.
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
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
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.
TypedDataRelationship::getData protected function
TypedDataRelationship::getMainPropertyName protected function
TypedDataRelationship::getName public function The name of the property used to get this relationship. Overrides RelationshipInterface::getName
TypedDataRelationship::getRelationship public function Generates a context based on this plugin's configuration. Overrides RelationshipInterface::getRelationship 2
TypedDataRelationship::getRelationshipValue public function
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