class TypedDataRelationship
Same name and namespace in other branches
- 8.x-3.x src/Plugin/Relationship/TypedDataRelationship.php \Drupal\ctools\Plugin\Relationship\TypedDataRelationship
Plugin annotation
@Relationship(
id = "typed_data_relationship",
deriver = "\Drupal\ctools\Plugin\Deriver\TypedDataRelationshipDeriver"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\ctools\Plugin\RelationshipBase extends \Drupal\ctools\Plugin\RelationshipInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\ctools\Plugin\Relationship\TypedDataRelationship implements \Drupal\ctools\Plugin\RelationshipBase
- class \Drupal\ctools\Plugin\RelationshipBase extends \Drupal\ctools\Plugin\RelationshipInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of TypedDataRelationship
File
-
src/
Plugin/ Relationship/ TypedDataRelationship.php, line 20
Namespace
Drupal\ctools\Plugin\RelationshipView 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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ContextAwarePluginTrait::$context | protected | property | The data objects representing the context of this plugin. | ||
ContextAwarePluginTrait::getCacheContexts | public | function | 10 | ||
ContextAwarePluginTrait::getCacheMaxAge | public | function | 6 | ||
ContextAwarePluginTrait::getCacheTags | public | function | 3 | ||
ContextAwarePluginTrait::getContext | public | function | |||
ContextAwarePluginTrait::getContextDefinition | public | function | |||
ContextAwarePluginTrait::getContextDefinitions | public | function | |||
ContextAwarePluginTrait::getContextMapping | public | function | 1 | ||
ContextAwarePluginTrait::getContexts | public | function | |||
ContextAwarePluginTrait::getContextValue | public | function | |||
ContextAwarePluginTrait::getContextValues | public | function | |||
ContextAwarePluginTrait::getPluginDefinition | abstract public | function | 1 | ||
ContextAwarePluginTrait::setContext | public | function | 1 | ||
ContextAwarePluginTrait::setContextMapping | public | function | |||
ContextAwarePluginTrait::setContextValue | public | function | |||
ContextAwarePluginTrait::validateContexts | public | function | |||
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 | 2 | ||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
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::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 87 | |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
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 |