annotate vendor/symfony/validator/Validator/TraceableValidator.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@14 1 <?php
Chris@14 2
Chris@14 3 /*
Chris@14 4 * This file is part of the Symfony package.
Chris@14 5 *
Chris@14 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@14 7 *
Chris@14 8 * For the full copyright and license information, please view the LICENSE
Chris@14 9 * file that was distributed with this source code.
Chris@14 10 */
Chris@14 11
Chris@14 12 namespace Symfony\Component\Validator\Validator;
Chris@14 13
Chris@14 14 use Symfony\Component\Validator\Context\ExecutionContextInterface;
Chris@14 15
Chris@14 16 /**
Chris@14 17 * Collects some data about validator calls.
Chris@14 18 *
Chris@14 19 * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
Chris@14 20 */
Chris@14 21 class TraceableValidator implements ValidatorInterface
Chris@14 22 {
Chris@14 23 private $validator;
Chris@17 24 private $collectedData = [];
Chris@14 25
Chris@14 26 public function __construct(ValidatorInterface $validator)
Chris@14 27 {
Chris@14 28 $this->validator = $validator;
Chris@14 29 }
Chris@14 30
Chris@14 31 /**
Chris@14 32 * @return array
Chris@14 33 */
Chris@14 34 public function getCollectedData()
Chris@14 35 {
Chris@14 36 return $this->collectedData;
Chris@14 37 }
Chris@14 38
Chris@14 39 public function reset()
Chris@14 40 {
Chris@17 41 $this->collectedData = [];
Chris@14 42 }
Chris@14 43
Chris@14 44 /**
Chris@14 45 * {@inheritdoc}
Chris@14 46 */
Chris@14 47 public function getMetadataFor($value)
Chris@14 48 {
Chris@14 49 return $this->validator->getMetadataFor($value);
Chris@14 50 }
Chris@14 51
Chris@14 52 /**
Chris@14 53 * {@inheritdoc}
Chris@14 54 */
Chris@14 55 public function hasMetadataFor($value)
Chris@14 56 {
Chris@14 57 return $this->validator->hasMetadataFor($value);
Chris@14 58 }
Chris@14 59
Chris@14 60 /**
Chris@14 61 * {@inheritdoc}
Chris@14 62 */
Chris@14 63 public function validate($value, $constraints = null, $groups = null)
Chris@14 64 {
Chris@14 65 $violations = $this->validator->validate($value, $constraints, $groups);
Chris@14 66
Chris@14 67 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 7);
Chris@14 68
Chris@14 69 $file = $trace[0]['file'];
Chris@14 70 $line = $trace[0]['line'];
Chris@14 71
Chris@14 72 for ($i = 1; $i < 7; ++$i) {
Chris@14 73 if (isset($trace[$i]['class'], $trace[$i]['function'])
Chris@14 74 && 'validate' === $trace[$i]['function']
Chris@14 75 && is_a($trace[$i]['class'], ValidatorInterface::class, true)
Chris@14 76 ) {
Chris@14 77 $file = $trace[$i]['file'];
Chris@14 78 $line = $trace[$i]['line'];
Chris@14 79
Chris@14 80 while (++$i < 7) {
Chris@14 81 if (isset($trace[$i]['function'], $trace[$i]['file']) && empty($trace[$i]['class']) && 0 !== strpos($trace[$i]['function'], 'call_user_func')) {
Chris@14 82 $file = $trace[$i]['file'];
Chris@14 83 $line = $trace[$i]['line'];
Chris@14 84
Chris@14 85 break;
Chris@14 86 }
Chris@14 87 }
Chris@14 88 break;
Chris@14 89 }
Chris@14 90 }
Chris@14 91
Chris@14 92 $name = str_replace('\\', '/', $file);
Chris@14 93 $name = substr($name, strrpos($name, '/') + 1);
Chris@14 94
Chris@17 95 $this->collectedData[] = [
Chris@14 96 'caller' => compact('name', 'file', 'line'),
Chris@14 97 'context' => compact('value', 'constraints', 'groups'),
Chris@14 98 'violations' => iterator_to_array($violations),
Chris@17 99 ];
Chris@14 100
Chris@14 101 return $violations;
Chris@14 102 }
Chris@14 103
Chris@14 104 /**
Chris@14 105 * {@inheritdoc}
Chris@14 106 */
Chris@14 107 public function validateProperty($object, $propertyName, $groups = null)
Chris@14 108 {
Chris@14 109 return $this->validator->validateProperty($object, $propertyName, $groups);
Chris@14 110 }
Chris@14 111
Chris@14 112 /**
Chris@14 113 * {@inheritdoc}
Chris@14 114 */
Chris@14 115 public function validatePropertyValue($objectOrClass, $propertyName, $value, $groups = null)
Chris@14 116 {
Chris@14 117 return $this->validator->validatePropertyValue($objectOrClass, $propertyName, $value, $groups);
Chris@14 118 }
Chris@14 119
Chris@14 120 /**
Chris@14 121 * {@inheritdoc}
Chris@14 122 */
Chris@14 123 public function startContext()
Chris@14 124 {
Chris@14 125 return $this->validator->startContext();
Chris@14 126 }
Chris@14 127
Chris@14 128 /**
Chris@14 129 * {@inheritdoc}
Chris@14 130 */
Chris@14 131 public function inContext(ExecutionContextInterface $context)
Chris@14 132 {
Chris@14 133 return $this->validator->inContext($context);
Chris@14 134 }
Chris@14 135 }