YamlDiscovery

Provides discovery for YAML files within a given set of directories. This overrides the Component file decoding with the Core YAML implementation. Hierarchy class \Drupal\Component\Discovery\YamlDiscovery implements DiscoverableInterfaceclass \Drupal\Core\Discovery\YamlDiscovery File core/lib/Drupal/Core/Discovery/YamlDiscovery.php, line 13 Namespace Drupal\Core\Discovery Members Name Modifiers Type Description YamlDiscovery::$directories protected property An array of

YamlDirectoryDiscovery::__construct

public YamlDirectoryDiscovery::__construct(array $directories, $file_cache_key_suffix, $key = 'id') Constructs a YamlDirectoryDiscovery object. Parameters array $directories: An array of directories to scan, keyed by the provider. The value can either be a string or an array of strings. The string values should be the path of a directory to scan. string $file_cache_key_suffix: The file cache key suffix. This should be unique for each type of discovery. string $key: (optional) The key contained

YamlDirectoryDiscovery::getIdentifier

protected YamlDirectoryDiscovery::getIdentifier($file, array $data) Gets the identifier from the data. Parameters string $file: The filename. array $data: The data from the YAML file. Return value string The identifier from the data. File core/lib/Drupal/Component/Discovery/YamlDirectoryDiscovery.php, line 112 Class YamlDirectoryDiscovery Discovers multiple YAML files in a set of directories. Namespace Drupal\Component\Discovery Code protected function getIdentifier($file, array $dat

YamlDirectoryDiscovery::getDirectoryIterator

protected YamlDirectoryDiscovery::getDirectoryIterator($directory) Gets an iterator to loop over the files in the provided directory. This method exists so that it is easy to replace this functionality in a class that extends this one. For example, it could be used to make the scan recursive. Parameters string $directory: The directory to scan. Return value \Traversable An \Traversable object or array where the values are \SplFileInfo objects. File core/lib/Drupal/Component/Discovery/YamlDire

YamlDirectoryDiscovery::findFiles

protected YamlDirectoryDiscovery::findFiles() Returns an array of providers keyed by file path. Return value array An array of providers keyed by file path. File core/lib/Drupal/Component/Discovery/YamlDirectoryDiscovery.php, line 125 Class YamlDirectoryDiscovery Discovers multiple YAML files in a set of directories. Namespace Drupal\Component\Discovery Code protected function findFiles() { $file_list = []; foreach ($this->directories as $provider => $directories) { $dir

YamlDirectoryDiscovery::findAll

public YamlDirectoryDiscovery::findAll() Returns an array of discoverable items. Return value array An array of discovered data keyed by provider. Throws \Drupal\Component\Discovery\DiscoveryException Exception thrown if there is a problem during discovery. Overrides DiscoverableInterface::findAll File core/lib/Drupal/Component/Discovery/YamlDirectoryDiscovery.php, line 67 Class YamlDirectoryDiscovery Discovers multiple YAML files in a set of directories. Namespace Drupal\Component\Di

YamlDirectoryDiscovery::FILE_KEY

Defines the key in the discovered data where the file path is stored. File core/lib/Drupal/Component/Discovery/YamlDirectoryDiscovery.php, line 18 Class YamlDirectoryDiscovery Discovers multiple YAML files in a set of directories. Namespace Drupal\Component\Discovery Code const FILE_KEY = '_discovered_file_path';

YamlDirectoryDiscovery::$idKey

The key contained in the discovered data that identifies it. Type: string File core/lib/Drupal/Component/Discovery/YamlDirectoryDiscovery.php, line 42 Class YamlDirectoryDiscovery Discovers multiple YAML files in a set of directories. Namespace Drupal\Component\Discovery Code protected $idKey;

YamlDirectoryDiscovery::$fileCacheKeySuffix

The suffix for the file cache key. Type: string File core/lib/Drupal/Component/Discovery/YamlDirectoryDiscovery.php, line 35 Class YamlDirectoryDiscovery Discovers multiple YAML files in a set of directories. Namespace Drupal\Component\Discovery Code protected $fileCacheKeySuffix;

YamlDirectoryDiscovery::$directories

An array of directories to scan, keyed by the provider. The value can either be a string or an array of strings. The string values should be the path of a directory to scan. Type: array File core/lib/Drupal/Component/Discovery/YamlDirectoryDiscovery.php, line 28 Class YamlDirectoryDiscovery Discovers multiple YAML files in a set of directories. Namespace Drupal\Component\Discovery Code protected $directories = [];