annotate vendor/symfony/validator/ConstraintViolationList.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Validator;
Chris@0 13
Chris@0 14 /**
Chris@0 15 * Default implementation of {@ConstraintViolationListInterface}.
Chris@0 16 *
Chris@0 17 * @author Bernhard Schussek <bschussek@gmail.com>
Chris@0 18 */
Chris@0 19 class ConstraintViolationList implements \IteratorAggregate, ConstraintViolationListInterface
Chris@0 20 {
Chris@0 21 /**
Chris@0 22 * @var ConstraintViolationInterface[]
Chris@0 23 */
Chris@17 24 private $violations = [];
Chris@0 25
Chris@0 26 /**
Chris@0 27 * Creates a new constraint violation list.
Chris@0 28 *
Chris@0 29 * @param ConstraintViolationInterface[] $violations The constraint violations to add to the list
Chris@0 30 */
Chris@17 31 public function __construct(array $violations = [])
Chris@0 32 {
Chris@0 33 foreach ($violations as $violation) {
Chris@0 34 $this->add($violation);
Chris@0 35 }
Chris@0 36 }
Chris@0 37
Chris@0 38 /**
Chris@0 39 * Converts the violation into a string for debugging purposes.
Chris@0 40 *
Chris@0 41 * @return string The violation as string
Chris@0 42 */
Chris@0 43 public function __toString()
Chris@0 44 {
Chris@0 45 $string = '';
Chris@0 46
Chris@0 47 foreach ($this->violations as $violation) {
Chris@0 48 $string .= $violation."\n";
Chris@0 49 }
Chris@0 50
Chris@0 51 return $string;
Chris@0 52 }
Chris@0 53
Chris@0 54 /**
Chris@0 55 * {@inheritdoc}
Chris@0 56 */
Chris@0 57 public function add(ConstraintViolationInterface $violation)
Chris@0 58 {
Chris@0 59 $this->violations[] = $violation;
Chris@0 60 }
Chris@0 61
Chris@0 62 /**
Chris@0 63 * {@inheritdoc}
Chris@0 64 */
Chris@0 65 public function addAll(ConstraintViolationListInterface $otherList)
Chris@0 66 {
Chris@0 67 foreach ($otherList as $violation) {
Chris@0 68 $this->violations[] = $violation;
Chris@0 69 }
Chris@0 70 }
Chris@0 71
Chris@0 72 /**
Chris@0 73 * {@inheritdoc}
Chris@0 74 */
Chris@0 75 public function get($offset)
Chris@0 76 {
Chris@0 77 if (!isset($this->violations[$offset])) {
Chris@0 78 throw new \OutOfBoundsException(sprintf('The offset "%s" does not exist.', $offset));
Chris@0 79 }
Chris@0 80
Chris@0 81 return $this->violations[$offset];
Chris@0 82 }
Chris@0 83
Chris@0 84 /**
Chris@0 85 * {@inheritdoc}
Chris@0 86 */
Chris@0 87 public function has($offset)
Chris@0 88 {
Chris@0 89 return isset($this->violations[$offset]);
Chris@0 90 }
Chris@0 91
Chris@0 92 /**
Chris@0 93 * {@inheritdoc}
Chris@0 94 */
Chris@0 95 public function set($offset, ConstraintViolationInterface $violation)
Chris@0 96 {
Chris@0 97 $this->violations[$offset] = $violation;
Chris@0 98 }
Chris@0 99
Chris@0 100 /**
Chris@0 101 * {@inheritdoc}
Chris@0 102 */
Chris@0 103 public function remove($offset)
Chris@0 104 {
Chris@0 105 unset($this->violations[$offset]);
Chris@0 106 }
Chris@0 107
Chris@0 108 /**
Chris@0 109 * {@inheritdoc}
Chris@0 110 *
Chris@0 111 * @return \ArrayIterator|ConstraintViolationInterface[]
Chris@0 112 */
Chris@0 113 public function getIterator()
Chris@0 114 {
Chris@0 115 return new \ArrayIterator($this->violations);
Chris@0 116 }
Chris@0 117
Chris@0 118 /**
Chris@0 119 * {@inheritdoc}
Chris@0 120 */
Chris@0 121 public function count()
Chris@0 122 {
Chris@17 123 return \count($this->violations);
Chris@0 124 }
Chris@0 125
Chris@0 126 /**
Chris@0 127 * {@inheritdoc}
Chris@0 128 */
Chris@0 129 public function offsetExists($offset)
Chris@0 130 {
Chris@0 131 return $this->has($offset);
Chris@0 132 }
Chris@0 133
Chris@0 134 /**
Chris@0 135 * {@inheritdoc}
Chris@0 136 */
Chris@0 137 public function offsetGet($offset)
Chris@0 138 {
Chris@0 139 return $this->get($offset);
Chris@0 140 }
Chris@0 141
Chris@0 142 /**
Chris@0 143 * {@inheritdoc}
Chris@0 144 */
Chris@0 145 public function offsetSet($offset, $violation)
Chris@0 146 {
Chris@0 147 if (null === $offset) {
Chris@0 148 $this->add($violation);
Chris@0 149 } else {
Chris@0 150 $this->set($offset, $violation);
Chris@0 151 }
Chris@0 152 }
Chris@0 153
Chris@0 154 /**
Chris@0 155 * {@inheritdoc}
Chris@0 156 */
Chris@0 157 public function offsetUnset($offset)
Chris@0 158 {
Chris@0 159 $this->remove($offset);
Chris@0 160 }
Chris@14 161
Chris@14 162 /**
Chris@14 163 * Creates iterator for errors with specific codes.
Chris@14 164 *
Chris@14 165 * @param string|string[] $codes The codes to find
Chris@14 166 *
Chris@14 167 * @return static new instance which contains only specific errors
Chris@14 168 */
Chris@14 169 public function findByCodes($codes)
Chris@14 170 {
Chris@14 171 $codes = (array) $codes;
Chris@17 172 $violations = [];
Chris@14 173 foreach ($this as $violation) {
Chris@17 174 if (\in_array($violation->getCode(), $codes, true)) {
Chris@14 175 $violations[] = $violation;
Chris@14 176 }
Chris@14 177 }
Chris@14 178
Chris@14 179 return new static($violations);
Chris@14 180 }
Chris@0 181 }