class GroupSequence in Zircon Profile 8

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")

@Target({"CLASS", "ANNOTATION"})

@author Bernhard Schussek <[e-mail]>

Implementing \ArrayAccess, \IteratorAggregate and \Countable is

Hierarchy

• class \Symfony\Component\Validator\Constraints\GroupSequence implements \Symfony\Component\Validator\Constraints\ArrayAccess, \Symfony\Component\Validator\Constraints\IteratorAggregate, \Symfony\Component\Validator\Constraints\Countable

Deprecated

since 2.5 and will be removed in 3.0.

Related topics

Annotations

Annotations for class discovery and metadata description.

7 files declare their use of GroupSequence

Abstract2Dot5ApiTest.php in vendor/symfony/validator/Tests/Validator/Abstract2Dot5ApiTest.php

AbstractValidatorTest.php in vendor/symfony/validator/Tests/Validator/AbstractValidatorTest.php

AnnotationLoader.php in vendor/symfony/validator/Mapping/Loader/AnnotationLoader.php

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

GroupSequenceTest.php in vendor/symfony/validator/Tests/Constraints/GroupSequenceTest.php

... See full list

File

vendor/symfony/validator/Constraints/GroupSequence.php, line 59

Namespace

Symfony\Component\Validator\Constraints

class GroupSequence implements \ArrayAccess, \IteratorAggregate, \Countable {

  /**
   * The groups in the sequence.
   *
   * @var string[]|GroupSequence[]
   */
  public $groups;

  /**
   * The group in which cascaded objects are validated when validating
   * this sequence.
   *
   * By default, cascaded objects are validated in each of the groups of
   * the sequence.
   *
   * If a class has a group sequence attached, that sequence replaces the
   * "Default" group. When validating that class in the "Default" group, the
   * group sequence is used instead, but still the "Default" group should be
   * cascaded to other objects.
   *
   * @var string|GroupSequence
   */
  public $cascadedGroup;

  /**
   * Creates a new group sequence.
   *
   * @param string[] $groups The groups in the sequence
   */
  public function __construct(array $groups) {

    // Support for Doctrine annotations
    $this->groups = isset($groups['value']) ? $groups['value'] : $groups;
  }

  /**
   * Returns an iterator for this group.
   *
   * Implemented for backwards compatibility with Symfony < 2.5.
   *
   * @return \Traversable The iterator
   *
   * @see \IteratorAggregate::getIterator()
   * @deprecated since version 2.5, to be removed in 3.0.
   */
  public function getIterator() {
    @trigger_error('The ' . __METHOD__ . ' method is deprecated since version 2.5 and will be removed in 3.0.', E_USER_DEPRECATED);
    return new \ArrayIterator($this->groups);
  }

  /**
   * Returns whether the given offset exists in the sequence.
   *
   * Implemented for backwards compatibility with Symfony < 2.5.
   *
   * @param int $offset The offset
   *
   * @return bool Whether the offset exists
   *
   * @deprecated since version 2.5, to be removed in 3.0.
   */
  public function offsetExists($offset) {
    @trigger_error('The ' . __METHOD__ . ' method is deprecated since version 2.5 and will be removed in 3.0.', E_USER_DEPRECATED);
    return isset($this->groups[$offset]);
  }

  /**
   * Returns the group at the given offset.
   *
   * Implemented for backwards compatibility with Symfony < 2.5.
   *
   * @param int $offset The offset
   *
   * @return string The group a the given offset
   *
   * @throws OutOfBoundsException If the object does not exist
   *
   * @deprecated since version 2.5, to be removed in 3.0.
   */
  public function offsetGet($offset) {
    @trigger_error('The ' . __METHOD__ . ' method is deprecated since version 2.5 and will be removed in 3.0.', E_USER_DEPRECATED);
    if (!isset($this->groups[$offset])) {
      throw new OutOfBoundsException(sprintf('The offset "%s" does not exist.', $offset));
    }
    return $this->groups[$offset];
  }

  /**
   * Sets the group at the given offset.
   *
   * Implemented for backwards compatibility with Symfony < 2.5.
   *
   * @param int    $offset The offset
   * @param string $value  The group name
   *
   * @deprecated since version 2.5, to be removed in 3.0.
   */
  public function offsetSet($offset, $value) {
    @trigger_error('The ' . __METHOD__ . ' method is deprecated since version 2.5 and will be removed in 3.0.', E_USER_DEPRECATED);
    if (null !== $offset) {
      $this->groups[$offset] = $value;
      return;
    }
    $this->groups[] = $value;
  }

  /**
   * Removes the group at the given offset.
   *
   * Implemented for backwards compatibility with Symfony < 2.5.
   *
   * @param int $offset The offset
   *
   * @deprecated since version 2.5, to be removed in 3.0.
   */
  public function offsetUnset($offset) {
    @trigger_error('The ' . __METHOD__ . ' method is deprecated since version 2.5 and will be removed in 3.0.', E_USER_DEPRECATED);
    unset($this->groups[$offset]);
  }

  /**
   * Returns the number of groups in the sequence.
   *
   * Implemented for backwards compatibility with Symfony < 2.5.
   *
   * @return int The number of groups
   *
   * @deprecated since version 2.5, to be removed in 3.0.
   */
  public function count() {
    @trigger_error('The ' . __METHOD__ . ' method is deprecated since version 2.5 and will be removed in 3.0.', E_USER_DEPRECATED);
    return count($this->groups);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GroupSequence::$cascadedGroup	public	property	The group in which cascaded objects are validated when validating this sequence.
GroupSequence::$groups	public	property	The groups in the sequence.
GroupSequence::count Deprecated	public	function	Returns the number of groups in the sequence.
GroupSequence::getIterator Deprecated	public	function	Returns an iterator for this group.
GroupSequence::offsetExists Deprecated	public	function	Returns whether the given offset exists in the sequence.
GroupSequence::offsetGet Deprecated	public	function	Returns the group at the given offset.
GroupSequence::offsetSet Deprecated	public	function	Sets the group at the given offset.
GroupSequence::offsetUnset Deprecated	public	function	Removes the group at the given offset.
GroupSequence::__construct	public	function	Creates a new group sequence.