class ConfigActionsSource in Config Actions 8

Defines a ConfigActionsSource 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.

Hierarchy

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

5 classes are annotated with ConfigActionsSource

ConfigActionsArray in src/Plugin/ConfigActionsSource/ConfigActionsArray.php

Plugin for storing source data from an array. This runs last to allow any other plugins to detect themselves first.

ConfigActionsFile in src/Plugin/ConfigActionsSource/ConfigActionsFile.php

Plugin for config source from files.

ConfigActionsId in src/Plugin/ConfigActionsSource/ConfigActionsId.php

Plugin for config id from the active store.

ConfigActionsList in src/Plugin/ConfigActionsSource/ConfigActionsList.php

Plugin for handling a list of source locations.

ConfigActionsTemplate in src/Plugin/ConfigActionsSource/ConfigActionsTemplate.php

Plugin for config source from files.

File

src/Annotation/ConfigActionsSource.php, line 19

Namespace

Drupal\config_actions\Annotation

class ConfigActionsSource extends Plugin {

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

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

  /**
   * The weight of the plugin.
   *
   * @var int
   */
  public $weight = 0;

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigActionsSource::$description	public	property	The description of the plugin
ConfigActionsSource::$id	public	property	The plugin ID.
ConfigActionsSource::$weight	public	property	The weight of the plugin.
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