class ReferenceUri in YAML Content 8

Plugin for querying and loading a referenced entity URI.

Plugin annotation

@YamlContentProcess(
  id = "reference_uri",
  title = @Translation("Entity Reference URI Processor"),
  description = @Translation("Attach an entity reference URI.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\yaml_content\Plugin\YamlContentProcessBase implements YamlContentProcessInterface
      • class \Drupal\yaml_content\Plugin\yaml_content\process\Reference implements ContainerFactoryPluginInterface, YamlContentProcessInterface
        • class \Drupal\yaml_content\Plugin\yaml_content\process\ReferenceUri

File

src/Plugin/yaml_content/process/ReferenceUri.php, line 16

Namespace

Drupal\yaml_content\Plugin\yaml_content\process

class ReferenceUri extends Reference {

  /**
   * {@inheritdoc}
   */
  public function process(ProcessingContext $context, array &$field_data) {

    // Run the reference plugin process method.
    parent::process($context, $field_data);

    // If an entity id was stored in the field_data array.
    if (!empty($field_data['target_id'])) {

      // Get the entity type from the configuration.
      $entity_type = $this->configuration[0];

      // Create an internal path for the referenced entity.
      $uri = 'entity:' . $entity_type . '/' . $field_data['target_id'];

      // Replace 'target_id' with 'uri'.
      unset($field_data['target_id']);
      $field_data['uri'] = $uri;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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::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.
Reference::$entityTypeManager	protected	property	The entity manager.
Reference::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Reference::__construct	public	function	Constructs a new EntityView. Overrides PluginBase::__construct
ReferenceUri::process	public	function	Processes field data. Overrides Reference::process
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.
YamlContentProcessBase::throwParamError	protected	function	Prepare an error message and throw error.