You are here

Home » API reference » Advanced Help 8 » AdvancedHelpManager.php

class AdvancedHelpManager in Advanced Help 8

AdvancedHelp plugin manager.

Hierarchy

Expanded class hierarchy of AdvancedHelpManager

1 file declares its use of AdvancedHelpManager
AdvancedHelpSearch.php in src/Plugin/Search/AdvancedHelpSearch.php
1 string reference to 'AdvancedHelpManager'
advanced_help.services.yml in ./advanced_help.services.yml
advanced_help.services.yml
1 service uses AdvancedHelpManager
plugin.manager.advanced_help in ./advanced_help.services.yml
Drupal\advanced_help\AdvancedHelpManager

File

src/AdvancedHelpManager.php, line 17

Namespace

Drupal\advanced_help
View source 
class AdvancedHelpManager extends DefaultPluginManager {
  use StringTranslationTrait;

  /**
   * The file system service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * Constructs an AdvancedHelpManager instance.
   *
   * @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.
   * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
   *   Theme handler.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translation service.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   The file handler.
   */
  public function __construct(ModuleHandlerInterface $module_handler, ThemeHandlerInterface $theme_handler, CacheBackendInterface $cache_backend, TranslationInterface $string_translation, FileSystemInterface $file_system) {
    $this->module_handler = $module_handler;
    $this->theme_handler = $theme_handler;
    $this
      ->setStringTranslation($string_translation);
    $this
      ->alterInfo('advanced_help');
    $this
      ->setCacheBackend($cache_backend, 'advanced_help', [
      'advanced_help',
    ]);
    $this->fileSystem = $file_system;
  }

  /**
   * Get the modules/theme list.
   *
   * @todo cache
   */
  public function getModuleList() {
    $modules = $this->module_handler
      ->getModuleList();
    $themes = $this->theme_handler
      ->listInfo();
    $result = [];
    foreach ($modules as $name => $data) {
      $result[$name] = $this->module_handler
        ->getName($name);
    }
    foreach ($themes as $name => $data) {
      $result[$name] = $this->theme_handler
        ->getName($name);
    }
    return $result;
  }

  /**
   * Get the information for a single help topic.
   *
   * @param $module
   * @param $topic
   *
   * @return string|bool
   */
  public function getTopic($module, $topic) {
    $topics = $this
      ->getTopics();
    if (!empty($topics[$module][$topic])) {
      return $topics[$module][$topic];
    }
    return FALSE;
  }

  /**
   * Return the name of the module.
   *
   * @param string $module
   *
   * @return string
   */
  public function getModuleName($module) {
    return $this->module_handler
      ->getName($module);
  }

  /**
   * Search the system for all available help topics.
   *
   * @todo check visibility of the method.
   */
  public function getTopics() {
    $ini = $this
      ->parseHelp();
    return $ini['topics'];
  }

  /**
   * Returns advanced help settings.
   *
   * @todo check visibility of the method.
   */
  public function getSettings() {
    $ini = $this
      ->parseHelp();
    return $ini['settings'];
  }

  /**
   * Function to parse yml / txt files.
   *
   * @todo implement cache
   * @todo check visibility of the method.
   */
  public function parseHelp() {
    $language = \Drupal::languageManager()
      ->getCurrentLanguage()
      ->getId();
    static $ini = NULL;
    $cache = $this
      ->cacheGet('advanced_help_ini_' . $language);
    if ($cache) {
      $ini = $cache->data;
    }
    if (!isset($ini)) {
      $ini = [
        'topics' => [],
        'settings' => [],
      ];
      foreach ($this->module_handler
        ->getModuleList() + $this->theme_handler
        ->listInfo() as $plugin_name => $extension) {
        $module = $plugin_name;
        $module_path = $extension
          ->getPath();
        $info = [];
        if (file_exists("{$module_path}/help/{$module}.help.yml")) {
          $path = "{$module_path}/help";
          $info = Yaml::decode(file_get_contents("{$module_path}/help/{$module}.help.yml"));
        }
        elseif (!file_exists("{$module_path}/help")) {

          // Look for one or more README files.
          if (floatval(\Drupal::VERSION) >= 8.800000000000001) {
            $files = $this->fileSystem
              ->scanDirectory("./{$module_path}", '/^(readme).*\\.(txt|md)$/i', [
              'recurse' => FALSE,
            ]);
          }
          else {
            $files = file_scan_directory("./{$module_path}", '/^(readme).*\\.(txt|md)$/i', [
              'recurse' => FALSE,
            ]);
          }
          $path = "./{$module_path}";
          foreach ($files as $name => $fileinfo) {
            $info[$fileinfo->filename] = [
              'line break' => TRUE,
              'readme file' => TRUE,
              'file' => $fileinfo->filename,
              'title' => $fileinfo->name,
            ];
          }
        }
        if (!empty($info)) {

          // Get translated titles:
          $translation = [];
          if (file_exists("{$module_path}/translations/help/{$language}/{$module}.help.yml")) {
            $translation = Yaml::decode(file_get_contents("{$module_path}/translations/help/{$language}/{$module}.help.yml"));
          }
          $ini['settings'][$module] = [];
          if (!empty($info['advanced help settings'])) {
            $ini['settings'][$module] = $info['advanced help settings'];
            unset($info['advanced help settings']);

            // Check translated strings for translatable global settings.
            if (isset($translation['advanced help settings']['name'])) {
              $ini['settings']['name'] = $translation['advanced help settings']['name'];
            }
            if (isset($translation['advanced help settings']['index name'])) {
              $ini['settings']['index name'] = $translation['advanced help settings']['index name'];
            }
          }
          foreach ($info as $name => $topic) {

            // Each topic should have a name, a title, a file and path.
            $file = !empty($topic['file']) ? $topic['file'] : $name;
            $ini['topics'][$module][$name] = [
              'name' => $name,
              'module' => $module,
              'ini' => $topic,
              'title' => !empty($translation[$name]['title']) ? $translation[$name]['title'] : $topic['title'],
              'weight' => isset($topic['weight']) ? $topic['weight'] : 0,
              'parent' => isset($topic['parent']) ? $topic['parent'] : 0,
              'popup width' => isset($topic['popup width']) ? $topic['popup width'] : 500,
              'popup height' => isset($topic['popup height']) ? $topic['popup height'] : 500,
              // Require extension.
              'file' => isset($topic['readme file']) ? $file : $file . '.html',
              // Not in .ini file.
              'path' => $path,
              'line break' => isset($topic['line break']) ? $topic['line break'] : (isset($ini['settings'][$module]['line break']) ? $ini['settings'][$module]['line break'] : FALSE),
              'navigation' => isset($topic['navigation']) ? $topic['navigation'] : (isset($ini['settings'][$module]['navigation']) ? $ini['settings'][$module]['navigation'] : TRUE),
              'css' => isset($topic['css']) ? $topic['css'] : (isset($ini['settings'][$module]['css']) ? $ini['settings'][$module]['css'] : NULL),
              'readme file' => isset($topic['readme file']) ? $topic['readme file'] : FALSE,
            ];
          }
        }
      }

      // drupal_alter('advanced_help_topic_info', $ini);.
      $this
        ->cacheSet('advanced_help_ini_' . $language, $ini);
    }
    return $ini;
  }

  /**
   * Load and render a help topic.
   *
   * @todo allow the theme override the help.
   * @param $module
   * @param $topic
   *
   * @return array
   */
  public function getTopicFileInfo($module, $topic) {
    $language = \Drupal::languageManager()
      ->getCurrentLanguage()
      ->getId();
    $info = $this
      ->getTopic($module, $topic);
    if (empty($info)) {
      return FALSE;
    }
    $path_type = preg_match('/themes/', $info['path']) ? 'theme' : 'module';

    // Search paths:
    $paths = [
      // // Allow theme override.
      //      path_to_theme() . '/help',
      // Translations.
      drupal_get_path($path_type, $module) . "/translations/help/{$language}",
      // In same directory as .inc file.
      $info['path'],
    ];
    foreach ($paths as $path) {
      if (file_exists("{$path}/{$info['file']}")) {
        return [
          'path' => $path,
          'file' => $info['file'],
        ];
      }
    }
    return FALSE;
  }

  /**
   *
   */
  public function getTopicFileName($module, $topic) {
    $info = $this
      ->getTopicFileInfo($module, $topic);
    if ($info) {
      return "./{$info['path']}/{$info['file']}";
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdvancedHelpManager::$fileSystem protected property The file system service.
AdvancedHelpManager::getModuleList public function Get the modules/theme list.
AdvancedHelpManager::getModuleName public function Return the name of the module.
AdvancedHelpManager::getSettings public function Returns advanced help settings.
AdvancedHelpManager::getTopic public function Get the information for a single help topic.
AdvancedHelpManager::getTopicFileInfo public function Load and render a help topic.
AdvancedHelpManager::getTopicFileName public function
AdvancedHelpManager::getTopics public function Search the system for all available help topics.
AdvancedHelpManager::parseHelp public function Function to parse yml / txt files.
AdvancedHelpManager::__construct public function Constructs an AdvancedHelpManager instance. 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::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::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::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
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.