class BUEditorPluginManager in BUEditor 8

Same name and namespace in other branches

8.2 src/BUEditorPluginManager.php \Drupal\bueditor\BUEditorPluginManager

Provides a plugin manager for BUEditor Plugins.

View 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::$hooks	protected	property	Available plugin hooks.
BUEditorPluginManager::$instances	public	property	Available plugin instances.
BUEditorPluginManager::alterEditorForm	public	function	Alters a BUEditor Editor form.
BUEditorPluginManager::alterEditorJS	public	function	Alters javascript data of a BUEditor Editor entity.
BUEditorPluginManager::alterToolbarWidget	public	function	Alters a toolbar widget
BUEditorPluginManager::findDefinitions	protected	function	Finds plugin definitions. Overrides DefaultPluginManager::findDefinitions
BUEditorPluginManager::getButtonGroups	public	function	Returns buttons grouped by owner plugin.
BUEditorPluginManager::getButtons	public	function	Returns buttons defined by plugins.
BUEditorPluginManager::getHooks	public	function	Returns available hooks.
BUEditorPluginManager::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides PluginManagerBase::getInstance
BUEditorPluginManager::getInstances	public	function	Returns all available plugin instances.
BUEditorPluginManager::invokeAll	public	function	Invokes a hook in all available plugins.
BUEditorPluginManager::validateEditorForm	public	function	Validates a BUEditor Editor form.
BUEditorPluginManager::__construct	public	function	Constructs a BUEditorPluginManager object. Overrides DefaultPluginManager::__construct
DefaultPluginManager::$additionalAnnotationNamespaces	protected	property	Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook	protected	property	Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey	protected	property	The cache key.
DefaultPluginManager::$cacheTags	protected	property	An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults	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::$moduleHandler	protected	property	The module handler to invoke the alter hook.	1
DefaultPluginManager::$namespaces	protected	property	An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName	protected	property	The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface	protected	property	The interface each plugin should implement.	1
DefaultPluginManager::$subdir	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::alterDefinitions	protected	function	Invokes the hook to alter the definitions if the alter hook is set.	1
DefaultPluginManager::alterInfo	protected	function	Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions	5
DefaultPluginManager::extractProviderFromDefinition	protected	function	Extracts the provider from a plugin definition.
DefaultPluginManager::fixContextAwareDefinitions	private	function	Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions	protected	function	Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions	public	function	Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions	2
DefaultPluginManager::getDiscovery	protected	function	Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery	12
DefaultPluginManager::getFactory	protected	function	Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition	public	function	Performs extra processing on plugin definitions.	13
DefaultPluginManager::providerExists	protected	function	Determines if the provider of a definition exists.	3
DefaultPluginManager::setCacheBackend	public	function	Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions	protected	function	Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches	public	function	Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches	1
DiscoveryCachedTrait::$definitions	protected	property	Cached definitions array.	1
DiscoveryCachedTrait::getDefinition	public	function	Overrides DiscoveryTrait::getDefinition	3
DiscoveryTrait::doGetDefinition	protected	function	Gets a specific plugin definition.
DiscoveryTrait::hasDefinition	public	function
PluginManagerBase::$discovery	protected	property	The object that discovers plugins managed by this manager.
PluginManagerBase::$factory	protected	property	The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper	protected	property	The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::createInstance	public	function	Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance	12
PluginManagerBase::handlePluginNotFound	protected	function	Allows plugin managers to specify custom behavior if a plugin is not found.	1
UseCacheBackendTrait::$cacheBackend	protected	property	Cache backend instance.
UseCacheBackendTrait::$useCaches	protected	property	Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet	protected	function	Fetches from the cache backend, respecting the use caches flag.	1
UseCacheBackendTrait::cacheSet	protected	function	Stores data in the persistent cache, respecting the use caches flag.

You are here

class BUEditorPluginManager in BUEditor 8

Hierarchy

See also

File

Namespace

Members

API Navigation