class YamlDiscovery in Drupal 8
Same name in this branch
- 8 core/lib/Drupal/Core/Discovery/YamlDiscovery.php \Drupal\Core\Discovery\YamlDiscovery
- 8 core/lib/Drupal/Component/Discovery/YamlDiscovery.php \Drupal\Component\Discovery\YamlDiscovery
- 8 core/lib/Drupal/Core/Plugin/Discovery/YamlDiscovery.php \Drupal\Core\Plugin\Discovery\YamlDiscovery
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Discovery/YamlDiscovery.php \Drupal\Core\Discovery\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 DiscoverableInterface
- class \Drupal\Core\Discovery\YamlDiscovery
Expanded class hierarchy of YamlDiscovery
6 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 - RouteBuilderTest.php in core/
tests/ Drupal/ Tests/ Core/ Routing/ RouteBuilderTest.php - Contains \Drupal\Tests\Core\Routing\RouteBuilderTest.
- YamlDiscovery.php in core/
lib/ Drupal/ Core/ Plugin/ Discovery/ YamlDiscovery.php
File
- core/
lib/ Drupal/ Core/ Discovery/ YamlDiscovery.php, line 14
Namespace
Drupal\Core\DiscoveryView source
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:: |
protected | property | An array of directories to scan, keyed by the provider. | |
YamlDiscovery:: |
protected | property | The base filename to look for in each directory. | |
YamlDiscovery:: |
protected | function |
Decode a YAML file. Overrides YamlDiscovery:: |
|
YamlDiscovery:: |
public | function |
Returns an array of discoverable items. Overrides DiscoverableInterface:: |
|
YamlDiscovery:: |
protected | function | Returns an array of file paths, keyed by provider. | |
YamlDiscovery:: |
public | function | Constructs a YamlDiscovery object. |