class EntityReference in Entity Usage 8.3

Tracks usage of entities related in entity_reference fields.

Plugin annotation

@EntityUsageTrack(
  id = "entity_reference",
  label = @Translation("Entity Reference"),
  description = @Translation("Tracks relationships created with 'Entity Reference' fields."),
  field_types = {"entity_reference", "entity_reference_revisions"},
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\entity_usage\EntityUsageTrackBase implements ContainerFactoryPluginInterface, EntityUsageTrackInterface
      • class \Drupal\entity_usage\Plugin\EntityUsage\Track\EntityReference

File

src/Plugin/EntityUsage/Track/EntityReference.php, line 18

Namespace

Drupal\entity_usage\Plugin\EntityUsage\Track

class EntityReference extends EntityUsageTrackBase {

  /**
   * {@inheritdoc}
   */
  public function getTargetEntities(FieldItemInterface $item) {

    /** @var \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $item */
    $item_value = $item
      ->getValue();
    if (empty($item_value['target_id'])) {
      return [];
    }
    $target_type = $item
      ->getFieldDefinition()
      ->getSetting('target_type');

    // Only return a valid result if the target entity exists.
    if (!$this->entityTypeManager
      ->getStorage($target_type)
      ->load($item_value['target_id'])) {
      return [];
    }
    $target_type_and_id = $target_type . '|' . $item_value['target_id'];

    // For paragraph references, send back the revision ID as well, since this
    // will allow the system to load that revision and check its fields.
    if (!empty($item_value['target_revision_id'])) {
      $target_type_and_id = $target_type_and_id . '|' . $item_value['target_revision_id'];
    }
    return [
      $target_type_and_id,
    ];
  }

}

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
EntityReference::getTargetEntities	public	function	Retrieve the target entity(ies) from a field item value. Overrides EntityUsageTrackInterface::getTargetEntities
EntityUsageTrackBase::$config	protected	property	The Entity Update config.
EntityUsageTrackBase::$entityFieldManager	protected	property	Entity field manager service.
EntityUsageTrackBase::$entityRepository	protected	property	The EntityRepository service.
EntityUsageTrackBase::$entityTypeManager	protected	property	Entity type manager service.
EntityUsageTrackBase::$usageService	protected	property	The usage tracking service.
EntityUsageTrackBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
EntityUsageTrackBase::defaultConfiguration	public	function
EntityUsageTrackBase::getAllBottomLevelTargets	protected	function	Calculates all bottom-level targets for a given entity.
EntityUsageTrackBase::getApplicableFieldTypes	public	function	Returns the field types this plugin is capable of tracking. Overrides EntityUsageTrackInterface::getApplicableFieldTypes
EntityUsageTrackBase::getDescription	public	function	Returns the tracking method description. Overrides EntityUsageTrackInterface::getDescription
EntityUsageTrackBase::getId	public	function	Returns the tracking method unique id. Overrides EntityUsageTrackInterface::getId
EntityUsageTrackBase::getLabel	public	function	Returns the tracking method label. Overrides EntityUsageTrackInterface::getLabel
EntityUsageTrackBase::getReferencingFields	public	function	Retrieve fields of the given types on an entity. Overrides EntityUsageTrackInterface::getReferencingFields
EntityUsageTrackBase::isApplicable	protected	function	Detects whether this plugin should act on a particular entity.
EntityUsageTrackBase::trackOnEntityCreation	public	function	Track usage updates on the creation of entities. Overrides EntityUsageTrackInterface::trackOnEntityCreation
EntityUsageTrackBase::trackOnEntityUpdate	public	function	Track usage updates on the edition of entities. Overrides EntityUsageTrackInterface::trackOnEntityUpdate
EntityUsageTrackBase::__construct	public	function	Plugin constructor. Overrides PluginBase::__construct	1
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.
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.