class EntityUsageTrack in Entity Usage 8.3

Defines an entity_usage track annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\entity_usage\Annotation\EntityUsageTrack

See also

hook_entity_usage_track_info_alter()

7 classes are annotated with EntityUsageTrack

BlockField in src/Plugin/EntityUsage/Track/BlockField.php

Tracks usage of entities related in block_field fields.

DynamicEntityReference in src/Plugin/EntityUsage/Track/DynamicEntityReference.php

Tracks usage of entities related in dynamic_entity_reference fields.

EntityEmbed in src/Plugin/EntityUsage/Track/EntityEmbed.php

Tracks usage of entities related in entity_reference fields.

EntityReference in src/Plugin/EntityUsage/Track/EntityReference.php

Tracks usage of entities related in entity_reference fields.

HtmlLink in src/Plugin/EntityUsage/Track/HtmlLink.php

Tracks usage of entities referenced from regular HTML Links.

... See full list

File

src/Annotation/EntityUsageTrack.php, line 14

Namespace

Drupal\entity_usage\Annotation

class EntityUsageTrack extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the tracking method.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * A brief description of the tracking method.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * The field types that this plugin is able to track.
   *
   * @var string[]
   */
  public $field_types = [];

}

Members

Name	Modifiers	Type	Description	Overrides
EntityUsageTrack::$description	public	property	A brief description of the tracking method.
EntityUsageTrack::$field_types	public	property	The field types that this plugin is able to track.
EntityUsageTrack::$id	public	property	The plugin ID.
EntityUsageTrack::$label	public	property	The human-readable name of the tracking method.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2