class Plugin

Defines a Plugin annotation object.

Annotations in plugin classes can utilize this class in order to pass various metadata about the plugin through the parser to DiscoveryInterface::getDefinitions() calls. This allows the metadata of a class to be located with the class itself, rather than in module-based info hooks.

Hierarchy

class \Drupal\Component\Annotation\Plugin implements AnnotationInterface

Expanded class hierarchy of Plugin

161 files declare their use of Plugin

2 string references to 'Plugin'

146 classes are annotated with Plugin

File

drupal/core/lib/Drupal/Component/Annotation/Plugin.php, line 23: Contains Drupal\Component\Annotation\Plugin.

Namespace

Drupal\Component\Annotation

View source

class Plugin implements AnnotationInterface {

  /**
   * The plugin definiton read from the class annotation.
   *
   * @var array
   */
  protected $definition;

  /**
   * Constructs a Plugin object.
   *
   * Builds up the plugin definition and invokes the get() method for any
   * classed annotations that were used.
   */
  public function __construct($values) {
    $reflection = new \ReflectionClass($this);

    // Only keep actual default values by ignoring NULL values.
    $defaults = array_filter($reflection
      ->getDefaultProperties(), function ($value) {
      return $value !== NULL;
    });
    $parsed_values = $this
      ->parse($values);
    $this->definition = NestedArray::mergeDeep($defaults, $parsed_values);
  }

  /**
   * Parses an annotation into its definition.
   *
   * @param array $values
   *   The annotation array.
   *
   * @return array
   *  The parsed annotation as a definition.
   */
  protected function parse(array $values) {
    $definitions = array();
    foreach ($values as $key => $value) {
      if ($value instanceof AnnotationInterface) {
        $definitions[$key] = $value
          ->get();
      }
      elseif (is_array($value)) {
        $definitions[$key] = $this
          ->parse($value);
      }
      else {
        $definitions[$key] = $value;
      }
    }
    return $definitions;
  }

  /**
   * Implements Drupal\Core\Annotation\AnnotationInterface::get().
   */
  public function get() {
    return $this->definition;
  }

}

Members

Name	Modifiers	Type	Description
Plugin::$definition	protected	property	The plugin definiton read from the class annotation.
Plugin::get	public	function	Implements Drupal\Core\Annotation\AnnotationInterface::get(). Overrides AnnotationInterface::get
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::__construct	public	function	Constructs a Plugin object.

Main menu

Search Drupal 8.x

API Navigation

class Plugin

Hierarchy

File

Namespace

Members

Main menu

You are here

Search Drupal 8.x

API Navigation

class Plugin

Hierarchy

File

Namespace

Members