class Yaml

Same name in this branch

11.1.x vendor/symfony/yaml/Yaml.php \Symfony\Component\Yaml\Yaml
11.1.x core/lib/Drupal/Component/Serialization/Yaml.php \Drupal\Component\Serialization\Yaml

@author Kev <https://github.com/symfonyaml>

Hierarchy

class \Symfony\Component\Validator\Constraint
- class \Symfony\Component\Validator\Constraints\Yaml extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of Yaml

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/validator/Constraints/Yaml.php, line 22

Namespace

Symfony\Component\Validator\Constraints

View source

class Yaml extends Constraint {
    public const INVALID_YAML_ERROR = '63313a31-837c-42bb-99eb-542c76aacc48';
    protected const ERROR_NAMES = [
        self::INVALID_YAML_ERROR => 'INVALID_YAML_ERROR',
    ];
    
    /**
     * @param int-mask-of<\Symfony\Component\Yaml\Yaml::PARSE_*> $flags
     * @param string[]|null                                      $groups
     */
    public function __construct(string $message = 'This value is not valid YAML.', int $flags = 0, ?array $groups = null, mixed $payload = null) {
        if (!class_exists(Parser::class)) {
            throw new LogicException('The Yaml component is required to use the Yaml constraint. Try running "composer require symfony/yaml".');
        }
        parent::__construct(null, $groups, $payload);
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
Constraint::$groups	public	property	The groups that the constraint belongs to.
Constraint::$payload	public	property	Domain-specific data attached to a constraint.
Constraint::addImplicitGroupName	public	function	Adds the given group if this constraint is in the Default group.		2
Constraint::CLASS_CONSTRAINT	public	constant	Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP	public	constant	The name of the group given to all constraints with no explicit group.
Constraint::getDefaultOption	public	function	Returns the name of the default option.		28
Constraint::getErrorName	public static	function	Returns the name of the given error code.
Constraint::getRequiredOptions	public	function	Returns the name of the required options.		22
Constraint::getTargets	public	function	Returns whether the constraint can be put onto classes, properties or both.		8
Constraint::normalizeOptions	protected	function
Constraint::PROPERTY_CONSTRAINT	public	constant	Marks a constraint that can be put onto properties.
Constraint::validatedBy	public	function	Returns the name of the class that validates this constraint.		9
Constraint::__get	public	function	Returns the value of a lazily initialized option.		2
Constraint::__isset	public	function			1
Constraint::__set	public	function	Sets the value of a lazily initialized option.		1
Constraint::__sleep	public	function	Optimizes the serialized value to minimize storage space.
Yaml::ERROR_NAMES	protected	constant	Maps error codes to the names of their constants.	Overrides Constraint::ERROR_NAMES
Yaml::INVALID_YAML_ERROR	public	constant
Yaml::__construct	public	function		Overrides Constraint::__construct