Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Component\Annotation;
Chris@0: 
Chris@0: use Drupal\Component\Utility\NestedArray;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a Plugin annotation object.
Chris@0:  *
Chris@0:  * Annotations in plugin classes can use this class in order to pass various
Chris@0:  * metadata about the plugin through the parser to
Chris@0:  * DiscoveryInterface::getDefinitions() calls. This allows the metadata
Chris@0:  * of a class to be located with the class itself, rather than in module-based
Chris@0:  * info hooks.
Chris@0:  *
Chris@0:  * @ingroup plugin_api
Chris@0:  *
Chris@0:  * @Annotation
Chris@0:  */
Chris@0: class Plugin implements AnnotationInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The plugin definition read from the class annotation.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $definition;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a Plugin object.
Chris@0:    *
Chris@0:    * Builds up the plugin definition and invokes the get() method for any
Chris@0:    * classed annotations that were used.
Chris@0:    */
Chris@0:   public function __construct($values) {
Chris@0:     $reflection = new \ReflectionClass($this);
Chris@0:     // Only keep actual default values by ignoring NULL values.
Chris@0:     $defaults = array_filter($reflection->getDefaultProperties(), function ($value) {
Chris@0:       return $value !== NULL;
Chris@0:     });
Chris@0:     $parsed_values = $this->parse($values);
Chris@0:     $this->definition = NestedArray::mergeDeep($defaults, $parsed_values);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Parses an annotation into its definition.
Chris@0:    *
Chris@0:    * @param array $values
Chris@0:    *   The annotation array.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The parsed annotation as a definition.
Chris@0:    */
Chris@0:   protected function parse(array $values) {
Chris@0:     $definitions = [];
Chris@0:     foreach ($values as $key => $value) {
Chris@0:       if ($value instanceof AnnotationInterface) {
Chris@0:         $definitions[$key] = $value->get();
Chris@0:       }
Chris@0:       elseif (is_array($value)) {
Chris@0:         $definitions[$key] = $this->parse($value);
Chris@0:       }
Chris@0:       else {
Chris@0:         $definitions[$key] = $value;
Chris@0:       }
Chris@0:     }
Chris@0:     return $definitions;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function get() {
Chris@0:     return $this->definition;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getProvider() {
Chris@0:     return isset($this->definition['provider']) ? $this->definition['provider'] : FALSE;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setProvider($provider) {
Chris@0:     $this->definition['provider'] = $provider;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getId() {
Chris@0:     return $this->definition['id'];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getClass() {
Chris@0:     return $this->definition['class'];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setClass($class) {
Chris@0:     $this->definition['class'] = $class;
Chris@0:   }
Chris@0: 
Chris@0: }