Action
class Action extends Plugin (View source)
Defines an Action annotation object.
Plugin Namespace: Plugin\Action
For a working example, see \Drupal\node\Plugin\Action\UnpublishNode
Properties
| protected array | $definition | The plugin definition read from the class annotation. |
from Plugin |
| string | $id | The plugin ID. |
|
| Translation | $label | The human-readable name of the action plugin. |
|
| string | $confirm_form_route_name | The route name for a confirmation form for this action. |
|
| string | $type | The entity type the action can apply to. |
|
| Translation | $category | The category under which the action should be listed in the UI. |
Methods
Details
in
Plugin at line 35
__construct($values)
Constructs a Plugin object.
Builds up the plugin definition and invokes the get() method for any classed annotations that were used.
in
Plugin at line 54
protected array
parse(array $values)
Parses an annotation into its definition.
in
Plugin at line 73
get()
Gets the value of an annotation.
in
Plugin at line 80
string
getProvider()
Gets the name of the provider of the annotated class.
in
Plugin at line 87
setProvider(string $provider)
Sets the name of the provider of the annotated class.
in
Plugin at line 94
string
getId()
Gets the unique ID for this annotated class.
string
getClass()
Gets the class of the annotated class.
setClass(string $class)
Sets the class of the annotated class.