class RabbitHoleEntityPlugin in Rabbit Hole 2.x

Defines a Rabbit hole entity plugin item annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\rabbit_hole\Annotation\RabbitHoleEntityPlugin

See also

\Drupal\rabbit_hole\Plugin\RabbitHoleEntityPluginManager

Plugin API

7 classes are annotated with RabbitHoleEntityPlugin

File in modules/rh_file/src/Plugin/RabbitHoleEntityPlugin/File.php

Implements rabbit hole behavior for nodes.

Group in modules/rh_group/src/Plugin/RabbitHoleEntityPlugin/Group.php

Implements rabbit hole behavior for Group.

Media in modules/rh_media/src/Plugin/RabbitHoleEntityPlugin/Media.php

Implements rabbit hole behavior for media.

Node in modules/rh_node/src/Plugin/RabbitHoleEntityPlugin/Node.php

Implements rabbit hole behavior for nodes.

Product in modules/rh_commerce/src/Plugin/RabbitHoleEntityPlugin/Product.php

Implements rabbit hole behavior for commerce products.

... See full list

File

src/Annotation/RabbitHoleEntityPlugin.php, line 15

Namespace

Drupal\rabbit_hole\Annotation

class RabbitHoleEntityPlugin extends Plugin {

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

  /**
   * The label of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The string id of the affected entity.
   *
   * @var string
   */
  public $entityType;

}

Members

Name	Modifiers	Type	Description	Overrides
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	1
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
RabbitHoleEntityPlugin::$entityType	public	property	The string id of the affected entity.
RabbitHoleEntityPlugin::$id	public	property	The plugin ID.
RabbitHoleEntityPlugin::$label	public	property	The label of the plugin.