class LibraryDeriver in UI Patterns 8

Class LibraryDeriver.

@package Drupal\ui_patterns_library\Deriver

Hierarchy

class \Drupal\Component\Plugin\Derivative\DeriverBase implements DeriverInterface
- class \Drupal\ui_patterns\Plugin\Deriver\AbstractPatternsDeriver implements ContainerDeriverInterface, PatternsDeriverInterface uses StringTranslationTrait
  - class \Drupal\ui_patterns\Plugin\Deriver\AbstractYamlPatternsDeriver implements YamlPatternsDeriverInterface
    class \Drupal\ui_patterns_library\Plugin\Deriver\LibraryDeriver

Expanded class hierarchy of LibraryDeriver

File

modules/ui_patterns_library/src/Plugin/Deriver/LibraryDeriver.php, line 20

Namespace

Drupal\ui_patterns_library\Plugin\Deriver

View source

class LibraryDeriver extends AbstractYamlPatternsDeriver {

  /**
   * The base plugin ID.
   *
   * @var string
   */
  protected $basePluginId;

  /**
   * The app root.
   *
   * @var string
   */
  protected $suffixes;

  /**
   * The app root.
   *
   * @var string
   */
  protected $root;

  /**
   * The theme handler.
   *
   * @var \Drupal\Core\Extension\ThemeHandlerInterface
   */
  protected $themeHandler;

  /**
   * The module handler to invoke the alter hook.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Extension discovery class.
   *
   * @var \Drupal\Core\Extension\ExtensionDiscovery
   */
  protected $extensionDiscovery;

  /**
   * List of extension locations.
   *
   * @var array
   */
  protected $extensionLocations = [];

  /**
   * List of valid definition file extensions.
   *
   * @var array
   */
  protected $fileExtensions = [];

  /**
   * Constructor.
   *
   * @param string $base_plugin_id
   *   The base plugin ID.
   * @param \Drupal\Core\TypedData\TypedDataManager $typed_data_manager
   *   Typed data manager service.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   Messenger.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   File system service.
   * @param string $root
   *   Application root directory.
   * @param array $extensions
   *   File extensions.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   Module handler service.
   * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
   *   Theme handler service.
   */
  public function __construct($base_plugin_id, TypedDataManager $typed_data_manager, MessengerInterface $messenger, FileSystemInterface $file_system, $root, array $extensions, ModuleHandlerInterface $module_handler, ThemeHandlerInterface $theme_handler) {
    parent::__construct($base_plugin_id, $typed_data_manager, $messenger, $file_system);
    $this->root = $root;
    $this->fileExtensions = $extensions;
    $this->moduleHandler = $module_handler;
    $this->themeHandler = $theme_handler;
    $this->extensionDiscovery = new ExtensionDiscovery($root);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, $base_plugin_id) {
    return new static($base_plugin_id, $container
      ->get('typed_data_manager'), $container
      ->get('messenger'), $container
      ->get('file_system'), $container
      ->get('app.root'), $container
      ->getParameter('ui_patterns_library.file_extensions'), $container
      ->get('module_handler'), $container
      ->get('theme_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFileExtensions() {
    return $this->fileExtensions;
  }

  /**
   * {@inheritdoc}
   */
  public function getPatterns() {
    $patterns = [];
    foreach ($this
      ->getDirectories() as $provider => $directory) {
      foreach ($this
        ->fileScanDirectory($directory) as $file_path => $file) {
        $host_extension = $this
          ->getHostExtension($file_path);
        if ($host_extension == FALSE || $host_extension == $provider) {
          $content = file_get_contents($file_path);
          foreach (Yaml::decode($content) as $id => $definition) {
            $definition['id'] = $id;
            $definition['base path'] = dirname($file_path);
            $definition['file name'] = basename($file_path);
            $definition['provider'] = $provider;
            $patterns[] = $this
              ->getPatternDefinition($definition);
          }
        }
      }
    }
    return $patterns;
  }

  /**
   * Create a list of all directories to scan.
   *
   * This includes all module directories and directories of the default theme
   * and all of its possible base themes.
   *
   * @return array
   *   An array containing directory paths keyed by their extension name.
   */
  protected function getDirectories() {
    $default_theme = $this->themeHandler
      ->getDefault();
    $base_themes = $this->themeHandler
      ->getBaseThemes($this->themeHandler
      ->listInfo(), $default_theme);
    $theme_directories = $this->themeHandler
      ->getThemeDirectories();
    $directories = [];
    if (isset($theme_directories[$default_theme])) {
      $directories[$default_theme] = $theme_directories[$default_theme];
      foreach ($base_themes as $name => $theme) {
        $directories[$name] = $theme_directories[$name];
      }
    }
    return $directories + $this->moduleHandler
      ->getModuleDirectories();
  }

  /**
   * Get extension name that hosts the given YAML definition file.
   *
   * @param string $pathname
   *   YAML definition file full path.
   *
   * @return bool|string
   *   Either extension machine name or FALSE if not found.
   */
  protected function getHostExtension($pathname) {
    $extensions = $this
      ->getExtensionLocations();
    $parts = explode(DIRECTORY_SEPARATOR, $pathname);
    while (!empty($parts)) {
      $path = implode(DIRECTORY_SEPARATOR, $parts);
      if (isset($extensions[$path])) {
        return $extensions[$path];
      }
      array_pop($parts);
    }
    return FALSE;
  }

  /**
   * Get extension locations.
   *
   * @return array
   *   Array of extensions keyed by their path location.
   */
  protected function getExtensionLocations() {

    /** @var \Drupal\Core\Extension\Extension[] $extensions */
    if (empty($this->extensionLocations)) {
      $extensions = $this->extensionDiscovery
        ->scan('theme') + $this->extensionDiscovery
        ->scan('module');
      foreach ($extensions as $name => $extension) {
        $this->extensionLocations[$this->root . DIRECTORY_SEPARATOR . $extension
          ->getPath()] = $name;
      }
    }
    return $this->extensionLocations;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AbstractPatternsDeriver::$messenger	protected	property	The messenger.
AbstractPatternsDeriver::$typedDataManager	protected	property	Typed data manager service.
AbstractPatternsDeriver::getDerivativeDefinitions	public	function	Gets the definition of all derivatives of a base plugin. Overrides DeriverBase::getDerivativeDefinitions
AbstractPatternsDeriver::getPatternDefinition	protected	function	Get pattern data object.
AbstractPatternsDeriver::isValidPatternDefinition	protected	function	Validate pattern definition.
AbstractYamlPatternsDeriver::$fileSystem	protected	property	File system service.
AbstractYamlPatternsDeriver::fileScanDirectory	public	function	Wrapper method for global function call. Overrides YamlPatternsDeriverInterface::fileScanDirectory
AbstractYamlPatternsDeriver::getNoMask	protected	function	Returns a regular expression for directories to be excluded in a file scan.
DeriverBase::$derivatives	protected	property	List of derivative definitions.	1
DeriverBase::getDerivativeDefinition	public	function	Gets the definition of a derivative plugin. Overrides DeriverInterface::getDerivativeDefinition
LibraryDeriver::$basePluginId	protected	property	The base plugin ID.
LibraryDeriver::$extensionDiscovery	protected	property	Extension discovery class.
LibraryDeriver::$extensionLocations	protected	property	List of extension locations.
LibraryDeriver::$fileExtensions	protected	property	List of valid definition file extensions.
LibraryDeriver::$moduleHandler	protected	property	The module handler to invoke the alter hook.
LibraryDeriver::$root	protected	property	The app root.
LibraryDeriver::$suffixes	protected	property	The app root.
LibraryDeriver::$themeHandler	protected	property	The theme handler.
LibraryDeriver::create	public static	function	Creates a new class instance. Overrides AbstractYamlPatternsDeriver::create
LibraryDeriver::getDirectories	protected	function	Create a list of all directories to scan.
LibraryDeriver::getExtensionLocations	protected	function	Get extension locations.
LibraryDeriver::getFileExtensions	public	function	Get list of possible yaml definition file extensions. Overrides YamlPatternsDeriverInterface::getFileExtensions
LibraryDeriver::getHostExtension	protected	function	Get extension name that hosts the given YAML definition file.
LibraryDeriver::getPatterns	public	function	Get pattern definition objects. Overrides PatternsDeriverInterface::getPatterns
LibraryDeriver::__construct	public	function	Constructor. Overrides AbstractYamlPatternsDeriver::__construct
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.

You are here

class LibraryDeriver in UI Patterns 8

Hierarchy

File

Namespace

Members

API Navigation