class Yaml
Same name in this branch
- 11.1.x vendor/symfony/validator/Constraints/Yaml.php \Symfony\Component\Validator\Constraints\Yaml
- 11.1.x core/lib/Drupal/Component/Serialization/Yaml.php \Drupal\Component\Serialization\Yaml
Yaml offers convenience methods to load and dump YAML.
@author Fabien Potencier <fabien@symfony.com>
@final
Hierarchy
- class \Symfony\Component\Yaml\Yaml
Expanded class hierarchy of Yaml
18 files declare their use of Yaml
- CoreVersionRequirementSniff.php in vendor/
drupal/ coder/ coder_sniffer/ DrupalPractice/ Sniffs/ InfoFiles/ CoreVersionRequirementSniff.php - DependenciesArraySniff.php in vendor/
drupal/ coder/ coder_sniffer/ Drupal/ Sniffs/ InfoFiles/ DependenciesArraySniff.php - DescriptionSniff.php in vendor/
drupal/ coder/ coder_sniffer/ DrupalPractice/ Sniffs/ InfoFiles/ DescriptionSniff.php - DrupalAutoloader.php in vendor/
mglaman/ phpstan-drupal/ src/ Drupal/ DrupalAutoloader.php - Extension.php in vendor/
mglaman/ phpstan-drupal/ src/ Drupal/ Extension.php
4 string references to 'Yaml'
- LintCommand::getFiles in vendor/
symfony/ yaml/ Command/ LintCommand.php - PlatformRepository::initialize in vendor/
composer/ composer/ src/ Composer/ Repository/ PlatformRepository.php - Initializes the packages array. Mostly meant as an extension point.
- YamlFileLoader::supports in vendor/
symfony/ routing/ Loader/ YamlFileLoader.php - YamlFileLoader::supports in vendor/
symfony/ dependency-injection/ Loader/ YamlFileLoader.php
File
-
vendor/
symfony/ yaml/ Yaml.php, line 23
Namespace
Symfony\Component\YamlView source
class Yaml {
public const DUMP_OBJECT = 1;
public const PARSE_EXCEPTION_ON_INVALID_TYPE = 2;
public const PARSE_OBJECT = 4;
public const PARSE_OBJECT_FOR_MAP = 8;
public const DUMP_EXCEPTION_ON_INVALID_TYPE = 16;
public const PARSE_DATETIME = 32;
public const DUMP_OBJECT_AS_MAP = 64;
public const DUMP_MULTI_LINE_LITERAL_BLOCK = 128;
public const PARSE_CONSTANT = 256;
public const PARSE_CUSTOM_TAGS = 512;
public const DUMP_EMPTY_ARRAY_AS_SEQUENCE = 1024;
public const DUMP_NULL_AS_TILDE = 2048;
public const DUMP_NUMERIC_KEY_AS_STRING = 4096;
/**
* Parses a YAML file into a PHP value.
*
* Usage:
*
* $array = Yaml::parseFile('config.yml');
* print_r($array);
*
* @param string $filename The path to the YAML file to be parsed
* @param int-mask-of<self::PARSE_*> $flags A bit field of PARSE_* constants to customize the YAML parser behavior
*
* @throws ParseException If the file could not be read or the YAML is not valid
*/
public static function parseFile(string $filename, int $flags = 0) : mixed {
$yaml = new Parser();
return $yaml->parseFile($filename, $flags);
}
/**
* Parses YAML into a PHP value.
*
* Usage:
* <code>
* $array = Yaml::parse(file_get_contents('config.yml'));
* print_r($array);
* </code>
*
* @param string $input A string containing YAML
* @param int-mask-of<self::PARSE_*> $flags A bit field of PARSE_* constants to customize the YAML parser behavior
*
* @throws ParseException If the YAML is not valid
*/
public static function parse(string $input, int $flags = 0) : mixed {
$yaml = new Parser();
return $yaml->parse($input, $flags);
}
/**
* Dumps a PHP value to a YAML string.
*
* The dump method, when supplied with an array, will do its best
* to convert the array into friendly YAML.
*
* @param mixed $input The PHP value
* @param int $inline The level where you switch to inline YAML
* @param int $indent The amount of spaces to use for indentation of nested nodes
* @param int-mask-of<self::DUMP_*> $flags A bit field of DUMP_* constants to customize the dumped YAML string
*/
public static function dump(mixed $input, int $inline = 2, int $indent = 4, int $flags = 0) : string {
$yaml = new Dumper($indent);
return $yaml->dump($input, $inline, 0, $flags);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
Yaml::dump | public static | function | Dumps a PHP value to a YAML string. |
Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE | public | constant | |
Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE | public | constant | |
Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK | public | constant | |
Yaml::DUMP_NULL_AS_TILDE | public | constant | |
Yaml::DUMP_NUMERIC_KEY_AS_STRING | public | constant | |
Yaml::DUMP_OBJECT | public | constant | |
Yaml::DUMP_OBJECT_AS_MAP | public | constant | |
Yaml::parse | public static | function | Parses YAML into a PHP value. |
Yaml::parseFile | public static | function | Parses a YAML file into a PHP value. |
Yaml::PARSE_CONSTANT | public | constant | |
Yaml::PARSE_CUSTOM_TAGS | public | constant | |
Yaml::PARSE_DATETIME | public | constant | |
Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE | public | constant | |
Yaml::PARSE_OBJECT | public | constant | |
Yaml::PARSE_OBJECT_FOR_MAP | public | constant |