class Traverse

Validates an object that needs to be traversed.

@author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

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

Expanded class hierarchy of Traverse

2 files declare their use of Traverse

ClassMetadata.php in vendor/symfony/validator/Mapping/ClassMetadata.php
GenericMetadata.php in vendor/symfony/validator/Mapping/GenericMetadata.php

2 string references to 'Traverse'

DebugCommand::getPropertyData in vendor/symfony/validator/Command/DebugCommand.php
Traverse::getDefaultOption in vendor/symfony/validator/Constraints/Traverse.php: Returns the name of the default option.

File

vendor/symfony/validator/Constraints/Traverse.php, line 22

Namespace

Symfony\Component\Validator\Constraints

View source

class Traverse extends Constraint {
    public bool $traverse = true;
    
    /**
     * @param bool|array<string,mixed>|null $traverse Whether to traverse the given object or not (defaults to true). Pass an associative array to configure the constraint's options (e.g. payload).
     */
    public function __construct(bool|array|null $traverse = null) {
        if (\is_array($traverse) && \array_key_exists('groups', $traverse)) {
            throw new ConstraintDefinitionException(\sprintf('The option "groups" is not supported by the constraint "%s".', __CLASS__));
        }
        parent::__construct($traverse);
    }
    public function getDefaultOption() : ?string {
        return 'traverse';
    }
    public function getTargets() : string|array {
        return self::CLASS_CONSTRAINT;
    }

}

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::ERROR_NAMES	protected	constant	Maps error codes to the names of their constants.		59
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::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.
Traverse::$traverse	public	property
Traverse::getDefaultOption	public	function	Returns the name of the default option.	Overrides Constraint::getDefaultOption
Traverse::getTargets	public	function	Returns whether the constraint can be put onto classes, properties or both.	Overrides Constraint::getTargets
Traverse::__construct	public	function		Overrides Constraint::__construct