Drupal 8  8.0.2
ExecutablePluginBase Class Reference
Inheritance diagram for ExecutablePluginBase:

Public Member Functions

 getConfigDefinitions ()
 
 getConfigDefinition ($key)
 
 getConfig ()
 
 setConfig ($key, $value)
 
- Public Member Functions inherited from ContextAwarePluginBase
 getContext ($name)
 
 setContext ($name, ComponentContextInterface $context)
 
 setContextValue ($name, $value)
 
 getContextMapping ()
 
 setContextMapping (array $context_mapping)
 
 getContextDefinitions ()
 
 getContextDefinition ($name)
 
- Public Member Functions inherited from ContextAwarePluginBase
 __construct (array $configuration, $plugin_id, $plugin_definition)
 
 getContextDefinitions ()
 
 getContextDefinition ($name)
 
 getContexts ()
 
 getContext ($name)
 
 setContext ($name, ContextInterface $context)
 
 getContextValues ()
 
 getContextValue ($name)
 
 setContextValue ($name, $value)
 
 validateContexts ()
 
- Public Member Functions inherited from PluginBase
 __construct (array $configuration, $plugin_id, $plugin_definition)
 
 getPluginId ()
 
 getBaseId ()
 
 getDerivativeId ()
 
 getPluginDefinition ()
 
- Public Member Functions inherited from ExecutableInterface
 execute ()
 

Additional Inherited Members

- Data Fields inherited from PluginBase
const DERIVATIVE_SEPARATOR = ':'
 
- Protected Member Functions inherited from ContextAwarePluginBase
 createContextFromConfiguration (array $context_configuration)
 
 contextHandler ()
 
- Protected Member Functions inherited from ContextAwarePluginBase
 createContextFromConfiguration (array $context_configuration)
 
- Protected Attributes inherited from ContextAwarePluginBase
 $context = []
 
- Protected Attributes inherited from PluginBase
 $pluginId
 
 $pluginDefinition
 
 $configuration
 

Detailed Description

Provides the basic architecture for executable plugins.

Member Function Documentation

getConfig ( )

Gets all configuration values.

Todo:
: This needs to go into an interface.
Returns
array The array of all configuration values, keyed by configuration option name.
getConfigDefinition (   $key)

Gets the definition of a configuration option.

Todo:
: This needs to go into an interface.
Returns
array The typed data definition describing the configuration option, or FALSE if the option does not exist.

References PluginBase\getPluginDefinition().

Referenced by ExecutablePluginBase\setConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

getConfigDefinitions ( )

Gets an array of definitions of available configuration options.

Todo:
: This needs to go into an interface.
Returns
array An array of typed data definitions describing available configuration options, keyed by option name.

References PluginBase\getPluginDefinition().

Here is the call graph for this function:

setConfig (   $key,
  $value 
)

Sets the value of a particular configuration option.

Parameters
string$nameThe name of the configuration option to set.
mixed$valueThe value to set.
Todo:

This doesn't belong here. Move this into a new base class in https://www.drupal.org/node/1764380.

This does not set a value in ::config(), so the name is confusing.

Returns
. The executable object for chaining.

References ExecutablePluginBase\getConfigDefinition(), and Drupal\typedDataManager().

Here is the call graph for this function:


The documentation for this class was generated from the following file: