class PathExtractor

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Theme/Plugin/IconExtractor/PathExtractor.php \Drupal\Core\Theme\Plugin\IconExtractor\PathExtractor

Plugin implementation of the icon_extractor.

@internal This API is experimental.

Attributes

#[IconExtractor(id: 'path', label: new TranslatableMarkup('Path or URL'), description: new TranslatableMarkup('Handles paths or URLs for icons.'), forms: [ 'settings' => IconPackExtractorForm::class, ])]

Hierarchy

Expanded class hierarchy of PathExtractor

1 file declares its use of PathExtractor
PathExtractorTest.php in core/tests/Drupal/Tests/Core/Theme/Icon/Plugin/PathExtractorTest.php

File

View on git.drupalcode.org

core/lib/Drupal/Core/Theme/Plugin/IconExtractor/PathExtractor.php, line 19

Namespace

Drupal\Core\Theme\Plugin\IconExtractor
View source 
class PathExtractor extends IconExtractorWithFinder {
  
  /**
   * {@inheritdoc}
   */
  public function discoverIcons() : array {
    $files = $this->getFilesFromSources();
    if (empty($files)) {
      return [];
    }
    $icons = [];
    foreach ($files as $file) {
      $id = IconDefinition::createIconId($this->configuration['id'], $file['icon_id']);
      $icons[$id] = [
        'absolute_path' => $file['absolute_path'],
        'source' => $file['source'],
        'group' => $file['group'] ?? NULL,
      ];
    }
    return $icons;
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
IconExtractorBase::buildConfigurationForm public function Overrides PluginFormInterface::buildConfigurationForm
IconExtractorBase::createIcon public function Overrides IconExtractorInterface::createIcon
IconExtractorBase::DEFINITION_REMOVE private constant
IconExtractorBase::description public function Overrides IconExtractorInterface::description
IconExtractorBase::label public function Overrides IconExtractorInterface::label
IconExtractorBase::loadIcon public function Overrides IconExtractorInterface::loadIcon 1
IconExtractorBase::submitConfigurationForm public function Overrides PluginFormInterface::submitConfigurationForm
IconExtractorBase::validateConfigurationForm public function Overrides PluginFormInterface::validateConfigurationForm
IconExtractorWithFinder::checkRequiredConfigSources protected function Check the required `config > sources` value from definition.
IconExtractorWithFinder::create public static function Overrides ContainerFactoryPluginInterface::create
IconExtractorWithFinder::getFilesFromSources public function Overrides IconExtractorWithFinderInterface::getFilesFromSources
IconExtractorWithFinder::__construct public function Constructs a IconExtractorWithFinder object. Overrides PluginBase::__construct
PathExtractor::discoverIcons public function Overrides IconExtractorInterface::discoverIcons
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin ID.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Overrides PluginInspectionInterface::getPluginId
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.