class FormatterExtrasManager in Custom Formatters 8.3

Class FormatterExtrasManager.

@package Drupal\custom_formatters

Hierarchy

class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
  - class \Drupal\custom_formatters\FormatterExtrasManager

Expanded class hierarchy of FormatterExtrasManager

1 file declares its use of FormatterExtrasManager

FormatterForm.php in src/Form/FormatterForm.php

1 string reference to 'FormatterExtrasManager'

custom_formatters.services.yml in ./custom_formatters.services.yml: custom_formatters.services.yml

1 service uses FormatterExtrasManager

plugin.manager.custom_formatters.formatter_extras in ./custom_formatters.services.yml: Drupal\custom_formatters\FormatterExtrasManager

File

src/FormatterExtrasManager.php, line 14

Namespace

Drupal\custom_formatters

View source

class FormatterExtrasManager extends DefaultPluginManager {

  /**
   * {@inheritdoc}
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/CustomFormatters/FormatterExtras', $namespaces, $module_handler, NULL, '\\Drupal\\custom_formatters\\Annotation\\FormatterExtras');

    // @TODO - Add alter hook here?
    $this
      ->setCacheBackend($cache_backend, 'custom_formatters_formatter_extras_plugins');
  }

  /**
   * Passes alterable variables to specific methods.
   */
  public function alter($method, $entity, &$data, &$context1 = NULL, &$context2 = NULL) {
    $method = $method . "Alter";
    $definitions = $this
      ->getDefinitions();
    if (is_array($definitions) && !empty($definitions)) {
      foreach ($definitions as $definition) {
        $extra = $this
          ->createInstance($definition['id'], [
          'entity' => $entity,
        ]);
        if (method_exists($extra, $method)) {
          $extra
            ->{$method}($data, $context1, $context2);
        }
      }
    }
  }

  /**
   * Invoke method on specified extras plugin.
   */
  public function invoke($plugin_id, $method, FormatterInterface $entity) {
    $args = func_get_args();
    array_shift($args);
    array_shift($args);
    array_shift($args);
    $definitions = $this
      ->getDefinitions();
    if (isset($definitions[$plugin_id])) {
      $extra = $this
        ->createInstance($plugin_id, [
        'entity' => $entity,
      ]);
      if (method_exists($extra, $method)) {
        return empty($args) ? $extra
          ->{$method}() : call_user_func_array([
          $extra,
          $method,
        ], $args);
      }
    }
    return FALSE;
  }

  /**
   * Invoke method on all available extras.
   */
  public function invokeAll($method, FormatterInterface $entity) {
    $args = func_get_args();
    $definitions = $this
      ->getDefinitions();
    $returns = [];
    if (is_array($definitions) && !empty($definitions)) {
      foreach ($definitions as $definition) {
        array_unshift($args, $definition['id']);
        $return = call_user_func_array([
          get_class($this),
          'invoke',
        ], $args);
        if ($return) {
          $returns[$definition['id']] = $return;
        }
      }
    }
    return $returns;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinitions() {
    $definitions = parent::getDefinitions();

    // Ensure Extras configuration dependencies are met.
    if (isset($definitions) && is_array($definitions)) {
      foreach ($definitions as $definition) {
        if (!$this
          ->validateDependencies($definition)) {
          unset($definitions[$definition['id']]);
        }
      }
    }
    return $definitions;
  }

  /**
   * Validate definition dependencies.
   *
   * @param array $definition
   *   The definition to validate.
   *
   * @return bool
   *   TRUE if dependencies met, else FALSE.
   */
  public function validateDependencies(array $definition) {
    if (empty($definition['dependencies'])) {
      return TRUE;
    }
    foreach ($definition['dependencies'] as $type => $dependencies) {
      if (!empty($dependencies)) {
        switch ($type) {
          case 'module':
            foreach ($dependencies as $dependency) {
              if (!\Drupal::moduleHandler()
                ->moduleExists($dependency)) {
                return FALSE;
              }
            }
            break;
        }
      }
    }
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::findDefinitions	protected	function	Finds plugin definitions.	7
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::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
FormatterExtrasManager::alter	public	function	Passes alterable variables to specific methods.
FormatterExtrasManager::getDefinitions	public	function	Gets the definition of all plugins for this type. Overrides DefaultPluginManager::getDefinitions
FormatterExtrasManager::invoke	public	function	Invoke method on specified extras plugin.
FormatterExtrasManager::invokeAll	public	function	Invoke method on all available extras.
FormatterExtrasManager::validateDependencies	public	function	Validate definition dependencies.
FormatterExtrasManager::__construct	public	function	Creates the discovery object. Overrides DefaultPluginManager::__construct
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::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance	7
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 FormatterExtrasManager in Custom Formatters 8.3

Hierarchy

File

Namespace

Members

API Navigation