class BUEditorPluginManager in BUEditor 8.2
Same name and namespace in other branches
- 8 src/BUEditorPluginManager.php \Drupal\bueditor\BUEditorPluginManager
Provides a plugin manager for BUEditor Plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
- class \Drupal\bueditor\BUEditorPluginManager
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
Expanded class hierarchy of BUEditorPluginManager
See also
\Drupal\bueditor\BUEditorPluginInterface
\Drupal\bueditor\BUEditorPluginBase
\Drupal\bueditor\Annotation\BUEditorPlugin
1 string reference to 'BUEditorPluginManager'
1 service uses BUEditorPluginManager
File
- src/
BUEditorPluginManager.php, line 20
Namespace
Drupal\bueditorView source
class BUEditorPluginManager extends DefaultPluginManager {
/**
* Available plugin hooks.
*
* @var array
*/
protected $hooks;
/**
* Available plugin instances.
*
* @var array
*/
public $instances;
/**
* Constructs a BUEditorPluginManager object.
*
* @param \Traversable $namespaces
* An object that implements \Traversable which contains the root paths
* keyed by the corresponding namespace to look for plugin implementations.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend instance to use.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler to invoke the alter hook with.
*/
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
parent::__construct('Plugin/BUEditorPlugin', $namespaces, $module_handler, 'Drupal\\bueditor\\BUEditorPluginInterface', 'Drupal\\bueditor\\Annotation\\BUEditorPlugin');
$this
->alterInfo('bueditor_plugin_info');
$this
->setCacheBackend($cache_backend, 'bueditor_plugins');
}
/**
* {@inheritdoc}
*/
protected function findDefinitions() {
$definitions = parent::findDefinitions();
// Sort definitions by weight
uasort($definitions, [
'Drupal\\Component\\Utility\\SortArray',
'sortByWeightElement',
]);
return $definitions;
}
/**
* {@inheritdoc}
*/
public function getInstance(array $options) {
if (isset($options['id']) && ($id = $options['id'])) {
return isset($this->instances[$id]) ? $this->instances[$id] : $this
->createInstance($id);
}
}
/**
* Returns all available plugin instances.
*
* @return array
* A an array plugin intances.
*/
public function getInstances() {
if (!isset($this->instances)) {
$this->instances = [];
foreach ($this
->getDefinitions() as $id => $def) {
$this->instances[$id] = $this
->createInstance($id);
}
}
return $this->instances;
}
/**
* Returns available hooks.
*
* @return array
* An array of method names defined by plugin interface.
*/
public function getHooks() {
if (!isset($this->hooks)) {
$this->hooks = get_class_methods('Drupal\\bueditor\\BUEditorPluginInterface');
}
return $this->hooks;
}
/**
* Invokes a hook in all available plugins.
*
* @return array
* An array of results keyed by plugin id.
*/
public function invokeAll($hook, &$a = NULL, $b = NULL, $c = NULL) {
$ret = [];
if (in_array($hook, $this
->getHooks())) {
foreach ($this
->getInstances() as $plugin => $instance) {
$ret[$plugin] = $instance
->{$hook}($a, $b, $c);
}
}
return $ret;
}
/**
* Returns buttons defined by plugins.
*
* @return array
* An array of button definitions keyed by button ids.
*/
public function getButtons() {
$buttons = [];
foreach ($this
->getButtonGroups() as $plugin => $group) {
$buttons = array_merge($buttons, $group['buttons']);
}
return $buttons;
}
/**
* Returns buttons grouped by owner plugin.
*
* @return array
* An array of button lists keyed by plugin id.
*/
public function getButtonGroups() {
$plugin_buttons = [];
$definitions = $this
->getDefinitions();
foreach ($this
->invokeAll('getButtons') as $plugin => $buttons) {
if ($buttons) {
foreach ($buttons as $bid => $label) {
$buttons[$bid] = (is_array($label) ? $label : [
'label' => $label,
]) + [
'id' => $bid,
];
}
$plugin_buttons[$plugin] = [
'label' => $definitions[$plugin]['label'],
'buttons' => $buttons,
];
}
}
return $plugin_buttons;
}
/**
* Alters javascript data of a BUEditor Editor entity.
*/
public function alterEditorJS(array &$js, BUEditorEditor $bueditor_editor, Editor $editor = NULL) {
return $this
->invokeAll('alterEditorJS', $js, $bueditor_editor, $editor);
}
/**
* Alters a toolbar widget
*/
public function alterToolbarWidget(array &$widget) {
return $this
->invokeAll('alterToolbarWidget', $widget);
}
/**
* Alters a BUEditor Editor form.
*/
public function alterEditorForm(array &$form, FormStateInterface $form_state, BUEditorEditor $bueditor_editor) {
return $this
->invokeAll('alterEditorForm', $form, $form_state, $bueditor_editor);
}
/**
* Validates a BUEditor Editor form.
*/
public function validateEditorForm(array &$form, FormStateInterface $form_state, BUEditorEditor $bueditor_editor) {
return $this
->invokeAll('validateEditorForm', $form, $form_state, $bueditor_editor);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BUEditorPluginManager:: |
protected | property | Available plugin hooks. | |
BUEditorPluginManager:: |
public | property | Available plugin instances. | |
BUEditorPluginManager:: |
public | function | Alters a BUEditor Editor form. | |
BUEditorPluginManager:: |
public | function | Alters javascript data of a BUEditor Editor entity. | |
BUEditorPluginManager:: |
public | function | Alters a toolbar widget | |
BUEditorPluginManager:: |
protected | function |
Finds plugin definitions. Overrides DefaultPluginManager:: |
|
BUEditorPluginManager:: |
public | function | Returns buttons grouped by owner plugin. | |
BUEditorPluginManager:: |
public | function | Returns buttons defined by plugins. | |
BUEditorPluginManager:: |
public | function | Returns available hooks. | |
BUEditorPluginManager:: |
public | function |
Gets a preconfigured instance of a plugin. Overrides PluginManagerBase:: |
|
BUEditorPluginManager:: |
public | function | Returns all available plugin instances. | |
BUEditorPluginManager:: |
public | function | Invokes a hook in all available plugins. | |
BUEditorPluginManager:: |
public | function | Validates a BUEditor Editor form. | |
BUEditorPluginManager:: |
public | function |
Constructs a BUEditorPluginManager object. Overrides DefaultPluginManager:: |
|
DefaultPluginManager:: |
protected | property | Additional namespaces the annotation discovery mechanism should scan for annotation definitions. | |
DefaultPluginManager:: |
protected | property | Name of the alter hook if one should be invoked. | |
DefaultPluginManager:: |
protected | property | The cache key. | |
DefaultPluginManager:: |
protected | property | An array of cache tags to use for the cached definitions. | |
DefaultPluginManager:: |
protected | property | A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes. | 9 |
DefaultPluginManager:: |
protected | property | The module handler to invoke the alter hook. | 1 |
DefaultPluginManager:: |
protected | property | An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations. | |
DefaultPluginManager:: |
protected | property | The name of the annotation that contains the plugin definition. | |
DefaultPluginManager:: |
protected | property | The interface each plugin should implement. | 1 |
DefaultPluginManager:: |
protected | property | The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace. | |
DefaultPluginManager:: |
protected | function | Invokes the hook to alter the definitions if the alter hook is set. | 1 |
DefaultPluginManager:: |
protected | function | Sets the alter hook name. | |
DefaultPluginManager:: |
public | function |
Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface:: |
5 |
DefaultPluginManager:: |
protected | function | Extracts the provider from a plugin definition. | |
DefaultPluginManager:: |
private | function | Fix the definitions of context-aware plugins. | |
DefaultPluginManager:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
protected | function | Returns the cached plugin definitions of the decorated discovery class. | |
DefaultPluginManager:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
public | function |
Gets the definition of all plugins for this type. Overrides DiscoveryTrait:: |
2 |
DefaultPluginManager:: |
protected | function |
Gets the plugin discovery. Overrides PluginManagerBase:: |
12 |
DefaultPluginManager:: |
protected | function |
Gets the plugin factory. Overrides PluginManagerBase:: |
|
DefaultPluginManager:: |
public | function | Performs extra processing on plugin definitions. | 13 |
DefaultPluginManager:: |
protected | function | Determines if the provider of a definition exists. | 3 |
DefaultPluginManager:: |
public | function | Initialize the cache backend. | |
DefaultPluginManager:: |
protected | function | Sets a cache of plugin definitions for the decorated discovery class. | |
DefaultPluginManager:: |
public | function |
Disable the use of caches. Overrides CachedDiscoveryInterface:: |
1 |
DiscoveryCachedTrait:: |
protected | property | Cached definitions array. | 1 |
DiscoveryCachedTrait:: |
public | function |
Overrides DiscoveryTrait:: |
3 |
DiscoveryTrait:: |
protected | function | Gets a specific plugin definition. | |
DiscoveryTrait:: |
public | function | ||
PluginManagerBase:: |
protected | property | The object that discovers plugins managed by this manager. | |
PluginManagerBase:: |
protected | property | The object that instantiates plugins managed by this manager. | |
PluginManagerBase:: |
protected | property | The object that returns the preconfigured plugin instance appropriate for a particular runtime condition. | |
PluginManagerBase:: |
public | function |
Creates a pre-configured instance of a plugin. Overrides FactoryInterface:: |
12 |
PluginManagerBase:: |
protected | function | Allows plugin managers to specify custom behavior if a plugin is not found. | 1 |
UseCacheBackendTrait:: |
protected | property | Cache backend instance. | |
UseCacheBackendTrait:: |
protected | property | Flag whether caches should be used or skipped. | |
UseCacheBackendTrait:: |
protected | function | Fetches from the cache backend, respecting the use caches flag. | 1 |
UseCacheBackendTrait:: |
protected | function | Stores data in the persistent cache, respecting the use caches flag. |