You are here

Home » API reference » Markdown 3.0.x » MarkdownExtensionManager.php

class MarkdownExtensionManager in Markdown 3.0.x

Hierarchy

Expanded class hierarchy of MarkdownExtensionManager

1 string reference to 'MarkdownExtensionManager'
markdown.services.yml in ./markdown.services.yml
markdown.services.yml
1 service uses MarkdownExtensionManager
plugin.manager.markdown.extension in ./markdown.services.yml
Drupal\markdown\MarkdownExtensionManager

File

src/MarkdownExtensionManager.php, line 14

Namespace

Drupal\markdown
View source 
class MarkdownExtensionManager extends BaseMarkdownPluginManager implements MarkdownExtensionManagerInterface {
  use ContainerAwareTrait;

  /**
   * {@inheritdoc}
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/Markdown/Extension', $namespaces, $module_handler, MarkdownExtensionInterface::class, MarkdownExtension::class);
    $this
      ->setCacheBackend($cache_backend, 'markdown_extensions');
    $this
      ->alterInfo('markdown_extensions');
  }

  /**
   * {@inheritdoc}
   */
  protected function alterDefinitions(&$definitions) {

    // Remove any plugins that don't actually have the parser installed.
    foreach ($definitions as $plugin_id => $definition) {
      if ($plugin_id === '_broken' || empty($definition['checkClass'])) {
        continue;
      }
      if (!class_exists($definition['checkClass'])) {
        unset($definitions[$plugin_id]);
      }
    }
    parent::alterDefinitions($definitions);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = new static($container
      ->get('container.namespaces'), $container
      ->get('cache.discovery'), $container
      ->get('module_handler'));
    $instance
      ->setContainer($container);
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function getExtensions($parser = NULL, $enabled = NULL) {

    // Normalize parser to a string representation of its plugin identifier.
    if ($parser instanceof MarkdownParserInterface) {
      $parser = $parser
        ->getPluginId();
    }
    $extensions = [];
    foreach ($this
      ->getDefinitions() as $plugin_id => $definition) {

      // Skip extensions that don't belong to a particular parser.
      if ($plugin_id === $this
        ->getFallbackPluginId() || isset($parser) && $definition['parsers'] && !in_array($parser, $definition['parsers'], TRUE)) {
        continue;
      }
      try {
        $extension = $this
          ->createInstance($plugin_id);

        // Set settings from the definition (i.e. added via alter).
        if (isset($definition['settings'])) {
          $extension
            ->setSettings($definition['settings']);
        }
        if ($enabled === TRUE && $extension
          ->isEnabled()) {
          $extensions[$plugin_id] = $extension;
        }
        elseif ($enabled === FALSE && !$extension
          ->isEnabled()) {
          $extensions[$plugin_id] = $extension;
        }
        elseif ($enabled === NULL) {
          $extensions[$plugin_id] = $extension;
        }
      } catch (PluginException $e) {

        // Intentionally left empty.
      }
    }
    return $extensions;
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {
    parent::processDefinition($definition, $plugin_id);
    if (!is_array($definition)) {
      return;
    }
    $definition['parsers'] = (array) $definition['parsers'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BaseMarkdownPluginManager::all public function
BaseMarkdownPluginManager::findDefinitions protected function Finds plugin definitions. Overrides DefaultPluginManager::findDefinitions
BaseMarkdownPluginManager::getFallbackPluginId public function 1
BaseMarkdownPluginManager::getInstalled public function
BaseMarkdownPluginManager::getLabels public function
BaseMarkdownPluginManager::sortDefinitions protected function Sorts a definitions array.
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::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 6
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
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::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
MarkdownExtensionManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. Overrides DefaultPluginManager::alterDefinitions
MarkdownExtensionManager::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
MarkdownExtensionManager::getExtensions public function Retrieves MarkdownExtension plugins. Overrides MarkdownExtensionManagerInterface::getExtensions
MarkdownExtensionManager::processDefinition public function Performs extra processing on plugin definitions. Overrides BaseMarkdownPluginManager::processDefinition
MarkdownExtensionManager::__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 6
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
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.
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.