Drupal 8  8.0.2
ConditionManager Class Reference
Inheritance diagram for ConditionManager:

Public Member Functions

 __construct (\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler)
 
 createInstance ($plugin_id, array $configuration=array())
 
 execute (ExecutableInterface $condition)
 
- Public Member Functions inherited from DefaultPluginManager
 __construct ($subdir,\Traversable $namespaces, ModuleHandlerInterface $module_handler, $plugin_interface=NULL, $plugin_definition_annotation_name= 'Drupal\Component\Annotation\Plugin')
 
 setCacheBackend (CacheBackendInterface $cache_backend, $cache_key, array $cache_tags=array())
 
 getDefinitions ()
 
 clearCachedDefinitions ()
 
 useCaches ($use_caches=FALSE)
 
 processDefinition (&$definition, $plugin_id)
 
- Public Member Functions inherited from PluginManagerBase
 getDefinition ($plugin_id, $exception_on_invalid=TRUE)
 
 getDefinitions ()
 
 createInstance ($plugin_id, array $configuration=array())
 
 getInstance (array $options)
 
- Public Member Functions inherited from DiscoveryInterface
 hasDefinition ($plugin_id)
 
- Public Member Functions inherited from CategorizingPluginManagerInterface
 getCategories ()
 
 getSortedDefinitions (array $definitions=NULL)
 
 getGroupedDefinitions (array $definitions=NULL)
 

Additional Inherited Members

- Protected Member Functions inherited from DefaultPluginManager
 alterInfo ($alter_hook)
 
 getCachedDefinitions ()
 
 setCachedDefinitions ($definitions)
 
 getDiscovery ()
 
 getFactory ()
 
 findDefinitions ()
 
 alterDefinitions (&$definitions)
 
 providerExists ($provider)
 
- Protected Member Functions inherited from PluginManagerBase
 getDiscovery ()
 
 getFactory ()
 
- Protected Attributes inherited from DefaultPluginManager
 $cacheKey
 
 $cacheTags = array()
 
 $alterHook
 
 $subdir
 
 $moduleHandler
 
 $defaults = array()
 
 $pluginDefinitionAnnotationName
 
 $pluginInterface
 
 $namespaces
 
- Protected Attributes inherited from PluginManagerBase
 $discovery
 
 $factory
 
 $mapper
 

Detailed Description

A plugin manager for condition plugins.

See Also

Constructor & Destructor Documentation

__construct ( \Traversable  $namespaces,
CacheBackendInterface  $cache_backend,
ModuleHandlerInterface  $module_handler 
)

Constructs a ConditionManager object.

Parameters
\Traversable$namespacesAn object that implements which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
\Drupal\Core\Cache\CacheBackendInterface$cache_backendCache backend instance to use.
\Drupal\Core\Extension\ModuleHandlerInterface$module_handlerThe module handler to invoke the alter hook with.

References DefaultPluginManager\alterInfo(), and DefaultPluginManager\setCacheBackend().

Here is the call graph for this function:

Member Function Documentation

createInstance (   $plugin_id,
array  $configuration = array() 
)

{Creates a pre-configured instance of a plugin.

Parameters
string$plugin_idThe ID of the plugin being instantiated.
array$configurationAn array of configuration relevant to the plugin instance.
Returns
object A fully configured plugin instance.
Exceptions
\Drupal\Component\Plugin\Exception\PluginExceptionIf the instance cannot be created, such as if the ID is invalid.
}

Implements FactoryInterface.

References DefaultPluginManager\getFactory().

Here is the call graph for this function:

execute ( ExecutableInterface  $condition)

{Executes an executable plugin.

Parameters
\Drupal\Core\Executable\ExecutableInterface$pluginAn executable plugin instance managed by the implementing manager.
Returns
mixed The returned data varies by plugin implementation, e.g. conditions return the boolean evaluation result.
Exceptions
\Drupal\Core\Executable\ExecutableExceptionIf the plugin could not be executed.
}

Implements ExecutableManagerInterface.


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