You are here

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

abstract class BaseMarkdownPluginManager in Markdown 3.0.x

Hierarchy

Expanded class hierarchy of BaseMarkdownPluginManager

File

src/BaseMarkdownPluginManager.php, line 11

Namespace

Drupal\markdown
View source 
abstract class BaseMarkdownPluginManager extends DefaultPluginManager {
  use ContainerAwareTrait;
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  protected function findDefinitions() {
    $definitions = parent::findDefinitions();
    $this
      ->sortDefinitions($definitions);
    return $definitions;
  }

  /**
   * {@inheritdoc}
   */
  public function all($includeBroken = FALSE) : array {

    /** @var \Drupal\markdown\Plugin\Markdown\MarkdownParserInterface[] $parsers */
    $parsers = [];
    foreach (array_keys($this
      ->getDefinitions()) as $plugin_id) {
      if (!$includeBroken && $plugin_id === '_broken') {
        continue;
      }
      $parsers[$plugin_id] = $this
        ->createInstance($plugin_id);
    }
    return $parsers;
  }

  /**
   * {@inheritdoc}
   */
  public function getFallbackPluginId($plugin_id = NULL, array $configuration = []) {
    return '_broken';
  }

  /**
   * {@inheritdoc}
   */
  public function getInstalled(array $configuration = []) : array {

    /** @var \Drupal\markdown\Plugin\Markdown\MarkdownParserInterface[] $parsers */
    $parsers = [];
    foreach ($this
      ->getDefinitions() as $plugin_id => $definition) {
      if ($plugin_id === '_broken' || empty($definition['installed'])) {
        continue;
      }
      $parsers[$plugin_id] = $this
        ->createInstance($plugin_id, $configuration);
    }
    return $parsers;
  }

  /**
   * {@inheritdoc}
   */
  public function getLabels($installed = TRUE, $version = TRUE) : array {
    $labels = [];
    $parsers = $installed ? $this
      ->getInstalled() : $this
      ->all();
    foreach ($parsers as $id => $parser) {

      // Cast to string for Drupal 7.
      $labels[$id] = (string) $parser
        ->getLabel($version);
    }
    return $labels;
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {

    // Immediately return if plugin is not installable.
    if (!is_array($definition) || !($class = $definition['class'] ?? NULL) || !is_subclass_of($class, MarkdownInstallablePluginInterface::class)) {
      return;
    }

    // Determine if plugin is installed, if not explicitly specified.
    if (!isset($definition['installed'])) {
      $definition['installed'] = $class::installed();
    }
    elseif (is_string($definition['installed'])) {
      $definition['installed'] = class_exists($definition['installed']);
    }
    elseif (!is_bool($definition['installed'])) {
      throw new DiscoveryException('The "installed" property must either be a class name that is checked for existence or a boolean. If complex requirements are needed, use \\Drupal\\markdown\\Plugin\\Markdown\\MarkdownInstallablePluginInterface::installed() instead of setting the value in the plugin annotation.');
    }

    // Determine if plugin version, if not explicitly specified.
    if (!isset($definition['version'])) {
      $definition['version'] = $class::version();
    }
    elseif (is_string($definition['version'])) {
      if (defined($definition['version'])) {
        $definition['version'] = constant($definition['version']);
      }
      elseif (strpos($definition['version'], '::')) {
        [
          $class,
          $const,
        ] = explode('::', $definition['version']);
        $definition['version'] = $class::$const;
      }
      elseif (is_callable($definition['version'])) {
        $definition['version'] = $definition['version']();
      }
      else {
        throw new DiscoveryException('The "version" property must either be a constant or public class constant or property that exists in code somewhere. If complex requirements are needed, use \\Drupal\\markdown\\Plugin\\Markdown\\MarkdownInstallablePluginInterface::version() instead of setting the value in the plugin annotation.');
      }
    }
  }

  /**
   * Sorts a definitions array.
   *
   * This sorts the definitions array first by the weight column, and then by
   * the plugin label, ensuring a stable, deterministic, and testable ordering
   * of plugins.
   *
   * @param array $definitions
   *   The definitions array to sort.
   */
  protected function sortDefinitions(array &$definitions) {
    $weight = array_column($definitions, 'weight', 'id');
    $label = array_map(function ($label) {
      return preg_replace("/[^a-z0-9]/", '', strtolower($label));
    }, array_column($definitions, 'label', 'id'));
    array_multisort($weight, SORT_ASC, SORT_NUMERIC, $label, SORT_ASC, SORT_NATURAL, $definitions);
  }

}

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::processDefinition public function Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition 1
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::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 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
DefaultPluginManager::__construct public function Creates the discovery object. 48
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::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.