W3cubDocs

/Symfony 2.7

Symfony\Component\Validator\Constraints\GroupSequence

class GroupSequence implements ArrayAccess, IteratorAggregate, Countable

A sequence of validation groups.

When validating a group sequence, each group will only be validated if all of the previous groups in the sequence succeeded. For example:

$validator->validate($address, null, new GroupSequence('Basic', 'Strict'));

In the first step, all constraints that belong to the group "Basic" will be validated. If none of the constraints fail, the validator will then validate the constraints in group "Strict". This is useful, for example, if "Strict" contains expensive checks that require a lot of CPU or slow, external services. You usually don't want to run expensive checks if any of the cheap checks fail.

When adding metadata to a class, you can override the "Default" group of that class with a group sequence:

/**
 * @GroupSequence({"Address", "Strict"})
 *\/
class Address
{
    // ...
}

Whenever you validate that object in the "Default" group, the group sequence will be validated:

$validator->validate($address);

If you want to execute the constraints of the "Default" group for a class with an overridden default group, pass the class name as group name instead:

$validator->validate($address, null, "Address")

Properties

string[]|GroupSequence[] $groups The groups in the sequence
string|GroupSequence $cascadedGroup The group in which cascaded objects are validated when validating this sequence.

Methods

__construct(array $groups)

Creates a new group sequence.

Traversable getIterator()

Returns an iterator for this group.

bool offsetExists(int $offset)

Returns whether the given offset exists in the sequence.

string offsetGet(int $offset)

Returns the group at the given offset.

offsetSet(int $offset, string $value)

Sets the group at the given offset.

offsetUnset(int $offset)

Removes the group at the given offset.

int count()

Returns the number of groups in the sequence.

Details

public __construct(array $groups)

Creates a new group sequence.

Parameters

array $groups The groups in the sequence

public Traversable getIterator()

Returns an iterator for this group.

Return Value

Traversable The iterator

See also

\IteratorAggregate::getIterator()

public bool offsetExists(int $offset)

Returns whether the given offset exists in the sequence.

Parameters

int $offset The offset

Return Value

bool Whether the offset exists

public string offsetGet(int $offset)

Returns the group at the given offset.

Parameters

int $offset The offset

Return Value

string The group a the given offset

Exceptions

OutOfBoundsException If the object does not exist

public offsetSet(int $offset, string $value)

Sets the group at the given offset.

Parameters

int $offset The offset
string $value The group name

public offsetUnset(int $offset)

Removes the group at the given offset.

Parameters

int $offset The offset

public int count()

Returns the number of groups in the sequence.

Return Value

int The number of groups

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Validator/Constraints/GroupSequence.html