class MpacSelection in Multi-path autocomplete 8

Defines a MpacSelection annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\mpac\Annotation\MpacSelection

3 files declare their use of MpacSelection

NodeSelection.php in lib/Drupal/mpac/Plugin/mpac/selection/NodeSelection.php

Contains \Drupal\mpac\Plugin\mpac\selection\NodeSelection.

PathSelection.php in lib/Drupal/mpac/Plugin/mpac/selection/PathSelection.php

Contains \Drupal\mpac\Plugin\mpac\selection\PathSelection.

SelectionBase.php in lib/Drupal/mpac/Plugin/mpac/selection/SelectionBase.php

Contains \Drupal\mpac\Plugin\mpac\selection\SelectionBase.

3 classes are annotated with MpacSelection

NodeSelection in lib/Drupal/mpac/Plugin/mpac/selection/NodeSelection.php

Provides specific selection functions for nodes.

PathSelection in lib/Drupal/mpac/Plugin/mpac/selection/PathSelection.php

Provides specific selection functions for nodes.

SelectionBase in lib/Drupal/mpac/Plugin/mpac/selection/SelectionBase.php

Plugin implementation of the 'selection' mpac.

File

lib/Drupal/mpac/Annotation/MpacSelection.php, line 17

Contains \Drupal\entity_reference\Annotation\MpacSelection.

Namespace

Drupal\mpac\Annotation

class MpacSelection extends Plugin {

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

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

  /**
   * The selection plugin group.
   *
   * This property is used to allow selection plugins to target a specific type
   * while also inheriting the code of an existing selection plugin.
   * For example, if we want to override the NodeSelection from the 'default'
   * selection type, we can define the annotation of a new plugin as follows:
   * @code
   * id = "node_advanced",
   * types = {"node"},
   * group = "default",
   * weight = 11
   * @endcode
   *
   * @var string
   */
  public $group;

  /**
   * An array of selection types that can be referenced by this plugin. Defaults
   * to all available types.
   *
   * @var array (optional)
   */
  public $types = array();

  /**
   * The weight of the plugin in it's group.
   *
   * @var int
   */
  public $weight;

}

Members

Name	Modifiers	Type	Description	Overrides
MpacSelection::$group	public	property	The selection plugin group.
MpacSelection::$id	public	property	The plugin ID.
MpacSelection::$label	public	property	The human-readable name of the selection plugin.
MpacSelection::$types	public	property	An array of selection types that can be referenced by this plugin. Defaults to all available types.
MpacSelection::$weight	public	property	The weight of the plugin in it's group.
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