class CodemirrorModePluginManager in The CodeMirror Editor 8

Defines a plugin manager to deal with CodeMirror modes.

Modules can define CodeMirror modes in a MODULE_NAME.codemirror_modes.yml file located in the module's base directory. Each CodeMirror mode has the following structure:


  MACHINE_NAME:
    label: STRING
    mime_types:
      - STRING
      - STRING
    usage: ARRAY (OPTIONAL)
    dependencies: ARRAY (OPTIONAL)

View source

class CodemirrorModePluginManager extends DefaultPluginManager implements CodemirrorModeManagerInterface {

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * {@inheritdoc}
   */
  protected $defaults = [
    'id' => '',
    'label' => '',
    'usage' => [],
    'dependencies' => [],
    'class' => 'Drupal\\codemirror_editor\\CodemirrorModeDefault',
  ];

  /**
   * Constructs CodemirrorModePluginManager object.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to invoke the alter hook with.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend, ConfigFactoryInterface $config_factory) {
    $this->configFactory = $config_factory;
    $this->factory = new ContainerFactory($this);
    $this->moduleHandler = $module_handler;
    $this
      ->alterInfo('codemirror_mode_info');
    $this
      ->setCacheBackend($cache_backend, 'codemirror_mode_plugins');
  }

  /**
   * {@inheritdoc}
   */
  protected function getDiscovery() {
    if (!isset($this->discovery)) {
      $this->discovery = new YamlDiscovery('codemirror_modes', $this->moduleHandler
        ->getModuleDirectories());
    }
    return $this->discovery;
  }

  /**
   * {@inheritdoc}
   */
  public function getActiveModes() {
    $enabled_modes = $this->configFactory
      ->get('codemirror_editor.settings')
      ->get('language_modes');
    $modes = [];
    foreach ($this
      ->getDefinitions() as $mode => $definition) {
      if (in_array($mode, $enabled_modes) || count($definition['usage']) > 0) {
        $modes[] = $mode;
        foreach ($definition['dependencies'] as $dependency) {
          $modes[] = $dependency;
        }
      }
    }
    return array_unique($modes);
  }

  /**
   * {@inheritdoc}
   */
  public function normalizeMode($mode) {
    $mode = strtolower($mode);
    if (strpos($mode, '/') === FALSE) {

      // HTML is actually just a subtype of XML.
      if ($mode == 'html') {
        $mode = 'text/html';
      }
      else {
        $modes = $this
          ->getDefinitions();
        if (isset($modes[$mode])) {

          // Consider the first declared mime type as a default one.
          // @see codemirror_editor.language_modes.yml
          $mode = reset($modes[$mode]['mime_types']);
        }
      }
    }
    return $mode;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CodemirrorModePluginManager::$configFactory	protected	property	The config factory.
CodemirrorModePluginManager::$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. Overrides DefaultPluginManager::$defaults
CodemirrorModePluginManager::getActiveModes	public	function	Returns active language modes. Overrides CodemirrorModeManagerInterface::getActiveModes
CodemirrorModePluginManager::getDiscovery	protected	function	Gets the plugin discovery. Overrides DefaultPluginManager::getDiscovery
CodemirrorModePluginManager::normalizeMode	public	function	Normalizes language mode. Overrides CodemirrorModeManagerInterface::normalizeMode
CodemirrorModePluginManager::__construct	public	function	Constructs CodemirrorModePluginManager 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::$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::getDefinitions	public	function	Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions	2
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::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 CodemirrorModePluginManager in The CodeMirror Editor 8

Hierarchy

See also

File

Namespace

Members

API Navigation