class CustomPlugin

Same name in this branch
  1. 11.x core/tests/Drupal/Tests/Component/Plugin/Attribute/Fixtures/CustomPlugin.php \com\example\PluginNamespace\CustomPlugin
Same name and namespace in other branches
  1. 9 core/tests/Drupal/Tests/Component/Annotation/AnnotatedClassDiscoveryTest.php \Drupal\Tests\Component\Annotation\CustomPlugin
  2. 8.9.x core/tests/Drupal/Tests/Component/Annotation/AnnotatedClassDiscoveryTest.php \Drupal\Tests\Component\Annotation\CustomPlugin
  3. 10 core/tests/Drupal/Tests/Component/Annotation/AnnotatedClassDiscoveryTest.php \Drupal\Tests\Component\Annotation\CustomPlugin
  4. 10 core/tests/Drupal/Tests/Component/Plugin/Attribute/Fixtures/CustomPlugin.php \com\example\PluginNamespace\CustomPlugin

Custom plugin annotation.

Hierarchy

Expanded class hierarchy of CustomPlugin

Related topics

Annotations
Annotations for class discovery and metadata description.

File

core/tests/Drupal/Tests/Component/Annotation/AnnotatedClassDiscoveryTest.php, line 76

Namespace

Drupal\Tests\Component\Annotation
View source 
class CustomPlugin extends Plugin {
    
    /**
     * The plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The plugin title.
     *
     * @var string
     *
     * @ingroup plugin_translatable
     */
    public $title = '';

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
CustomPlugin::$id public property The plugin ID.
CustomPlugin::$title public property The plugin title.
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 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
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 1
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. 3

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.