class YamlDiscovery in Drupal 9

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 DiscoverableInterface
  • class \Drupal\Core\Discovery\YamlDiscovery

5 files declare their use of YamlDiscovery

MigrationState.php in core/modules/migrate_drupal/src/MigrationState.php

PermissionHandler.php in core/modules/user/src/PermissionHandler.php

RouteBuilder.php in core/lib/Drupal/Core/Routing/RouteBuilder.php

YamlDiscovery.php in core/lib/Drupal/Core/Plugin/Discovery/YamlDiscovery.php

YamlDiscoveryTest.php in core/tests/Drupal/Tests/Core/Discovery/YamlDiscoveryTest.php

File

core/lib/Drupal/Core/Discovery/YamlDiscovery.php, line 14

Namespace

Drupal\Core\Discovery

class YamlDiscovery extends ComponentYamlDiscovery {

  /**
   * {@inheritdoc}
   */
  protected function decode($file) {
    try {
      return Yaml::decode(file_get_contents($file)) ?: [];
    } catch (InvalidDataTypeException $e) {
      throw new InvalidDataTypeException($file . ': ' . $e
        ->getMessage(), $e
        ->getCode(), $e);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
YamlDiscovery::$directories	protected	property	An array of directories to scan, keyed by the provider.
YamlDiscovery::$name	protected	property	The base filename to look for in each directory.
YamlDiscovery::decode	protected	function	Decode a YAML file. Overrides YamlDiscovery::decode
YamlDiscovery::findAll	public	function	Returns an array of discoverable items. Overrides DiscoverableInterface::findAll
YamlDiscovery::findFiles	protected	function	Returns an array of file paths, keyed by provider.
YamlDiscovery::__construct	public	function	Constructs a YamlDiscovery object.