class ConfigActionsPlugin in Config Actions 8

Defines a ConfigActionsPlugin annotation object.

Valid keys: 'id' string - the unique ID of the plugin 'description' string - an optional description of the plugin. Use the @Translation() function to provide translation of your text. 'options' array - an array of options and their default values. This lists the valid keys that can be specified within the action data accepted by the plugin. This is a key/value array where the key is the name of the option and the value is the default value of the option to be used when the option is not specified in the action data. 'data' array - an optional array of data that is plugin-specific. Consult the plugin documentation for any values to be used.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\config_actions\Annotation\ConfigActionsPlugin

5 classes are annotated with ConfigActionsPlugin

ConfigActionsAdd in src/Plugin/ConfigActions/ConfigActionsAdd.php

Plugin for changing data.

ConfigActionsChange in src/Plugin/ConfigActions/ConfigActionsChange.php

Plugin for changing data.

ConfigActionsDefault in src/Plugin/ConfigActions/ConfigActionsDefault.php

Default Plugin for changing, adding, deleting data.

ConfigActionsDelete in src/Plugin/ConfigActions/ConfigActionsDelete.php

Plugin for deleting data.

ConfigActionsInclude in src/Plugin/ConfigActions/ConfigActionsInclude.php

Plugin for including an action from another module.

File

src/Annotation/ConfigActionsPlugin.php, line 26

Namespace

Drupal\config_actions\Annotation

class ConfigActionsPlugin extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The description of the plugin
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * Options accepted by the plugin.
   *
   * Key/value pairs where the value is the default of the option.
   *
   * @var array
   */
  public $options = [];

  /**
   * List of options that allow string replacement.
   *
   * @var array
   */
  public $replace_in = [];

  /**
   * Plugin specific data.
   *
   * @var array
   */
  public $data = [];

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigActionsPlugin::$data	public	property	Plugin specific data.
ConfigActionsPlugin::$description	public	property	The description of the plugin
ConfigActionsPlugin::$id	public	property	The plugin ID.
ConfigActionsPlugin::$options	public	property	Options accepted by the plugin.
ConfigActionsPlugin::$replace_in	public	property	List of options that allow string replacement.
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	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
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
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
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.	2