class PluginExample
Same name in this branch
- 10 core/modules/system/tests/modules/plugin_test/src/Plugin/Attribute/PluginExample.php \Drupal\plugin_test\Plugin\Attribute\PluginExample
Same name in other branches
- 9 core/modules/system/tests/modules/plugin_test/src/Plugin/Annotation/PluginExample.php \Drupal\plugin_test\Plugin\Annotation\PluginExample
- 8.9.x core/modules/system/tests/modules/plugin_test/src/Plugin/Annotation/PluginExample.php \Drupal\plugin_test\Plugin\Annotation\PluginExample
- 11.x core/modules/system/tests/modules/plugin_test/src/Plugin/Attribute/PluginExample.php \Drupal\plugin_test\Plugin\Attribute\PluginExample
- 11.x core/modules/system/tests/modules/plugin_test/src/Plugin/Annotation/PluginExample.php \Drupal\plugin_test\Plugin\Annotation\PluginExample
Defines a custom Plugin annotation.
Hierarchy
- class \Drupal\Component\Annotation\AnnotationBase implements \Drupal\Component\Annotation\AnnotationInterface
- class \Drupal\plugin_test\Plugin\Annotation\PluginExample extends \Drupal\Component\Annotation\AnnotationBase
Expanded class hierarchy of PluginExample
Related topics
1 file declares its use of PluginExample
- DefaultPluginManagerTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Plugin/ DefaultPluginManagerTest.php
2 classes are annotated with PluginExample
- Example1 in core/
modules/ system/ tests/ modules/ plugin_test/ src/ Plugin/ plugin_test/ custom_annotation/ Example1.php - Provides a test plugin with a custom annotation.
- Example2 in core/
modules/ system/ tests/ modules/ plugin_test/ src/ Plugin/ plugin_test/ custom_annotation/ Example2.php - Provides a test plugin with a custom annotation.
File
-
core/
modules/ system/ tests/ modules/ plugin_test/ src/ Plugin/ Annotation/ PluginExample.php, line 12
Namespace
Drupal\plugin_test\Plugin\AnnotationView source
class PluginExample extends AnnotationBase {
/**
* The plugin ID.
*
* @var string
*/
public $id;
/**
* Another plugin metadata.
*
* @var string
*/
public $custom;
/**
* {@inheritdoc}
*/
public function get() {
return [
'id' => $this->id,
'custom' => $this->custom,
'class' => $this->class,
'provider' => $this->provider,
];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AnnotationBase::$class | protected | property | The class used for this annotated class. | ||
AnnotationBase::$provider | protected | property | The provider of the annotated class. | ||
AnnotationBase::getClass | public | function | Gets the class of the annotated class. | Overrides AnnotationInterface::getClass | |
AnnotationBase::getId | public | function | Gets the unique ID for this annotated class. | Overrides AnnotationInterface::getId | 1 |
AnnotationBase::getProvider | public | function | Gets the name of the provider of the annotated class. | Overrides AnnotationInterface::getProvider | |
AnnotationBase::setClass | public | function | Sets the class of the annotated class. | Overrides AnnotationInterface::setClass | |
AnnotationBase::setProvider | public | function | Sets the name of the provider of the annotated class. | Overrides AnnotationInterface::setProvider | |
PluginExample::$custom | public | property | Another plugin metadata. | ||
PluginExample::$id | public | property | The plugin ID. | Overrides AnnotationBase::$id | |
PluginExample::get | public | function | Gets the value of an annotation. | Overrides AnnotationInterface::get |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.