NestedValidationException::getRelated() - Code Metrics - Inspection of "Update Alnum.md" - Respect/Validation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#893)

by Islam

created 2017-12-19 15:23 UTC

NestedValidationException::getRelated() A

↳ Parent: NestedValidationException

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	4
cts	4
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	0
crap	2

<?php

/*
 * This file is part of Respect/Validation.
 *
 * (c) Alexandre Gomes Gaigalas <[email protected]>
 *
 * For the full copyright and license information, please view the "LICENSE.md"
 * file that was distributed with this source code.
 */

namespace Respect\Validation\Exceptions;

use IteratorAggregate;
use RecursiveIteratorIterator;
use SplObjectStorage;

class NestedValidationException extends ValidationException implements IteratorAggregate
{
    /**
     * @var SplObjectStorage
     */
    private $exceptions = [];

    /**
     * @param ValidationException $exception
     *
     * @return self
     */
    public function addRelated(ValidationException $exception)
    {
        $this->getRelated()->attach($exception);

        return $this;
    }

    /**
     * @param string              $path
     * @param ValidationException $exception
     *
     * @return ValidationException
     */
    private function getExceptionForPath($path, ValidationException $exception)
    {
        if ($path === $exception->guessId()) {
            return $exception;
        }

        if (!$exception instanceof self) {
            return $exception;
        }

        foreach ($exception as $subException) {
            return $subException;
        }

        return $exception;
    }

    /**
     * @param array $paths
     *
     * @return string[]
     */
    public function findMessages(array $paths)
    {
        $messages = [];

        foreach ($paths as $key => $value) {
            $numericKey = is_numeric($key);
            $path = $numericKey ? $value : $key;

            if (!($exception = $this->getRelatedByName($path))) {
                $exception = $this->findRelated($path);
            }

            $path = str_replace('.', '_', $path);

            if (!$exception) {
                $messages[$path] = '';
                continue;
            }

            $exception = $this->getExceptionForPath($path, $exception);
            if (!$numericKey) {
                $exception->setTemplate($value);
            }

            $messages[$path] = $exception->getMainMessage();
        }

        return $messages;
    }

    /**
     * @return Exception
     */
    public function findRelated($path)
    {
        $target = $this;
        $pieces = explode('.', $path);

        while (!empty($pieces) && $target) {
            $piece = array_shift($pieces);
            $target = $target->getRelatedByName($piece);
        }

        return $target;
    }

    /**
     * @return RecursiveIteratorIterator
     */
    private function getRecursiveIterator()
    {
        $exceptionIterator = new RecursiveExceptionIterator($this);
        $recursiveIteratorIterator = new RecursiveIteratorIterator(
            $exceptionIterator,
            RecursiveIteratorIterator::SELF_FIRST
        );

        return $recursiveIteratorIterator;
    }

    /**
     * Returns weather an exception should be omitted or not.
     *
     * @param ExceptionInterface $exception
     *
     * @return bool
     */
    private function isOmissible(ExceptionInterface $exception)
    {
        if (!$exception instanceof self) {
            return false;
        }

        $relatedExceptions = $exception->getRelated();
        $relatedExceptions->rewind();
        $childException = $relatedExceptions->current();

        return $relatedExceptions->count() === 1 && !$childException instanceof NonOmissibleExceptionInterface;
    }

    /**
     * @return SplObjectStorage
     */
    public function getIterator()
    {
        $childrenExceptions = new SplObjectStorage();

        $recursiveIteratorIterator = $this->getRecursiveIterator();
        $exceptionIterator = $recursiveIteratorIterator->getInnerIterator();

        $lastDepth = 0;
        $lastDepthOriginal = 0;
        $knownDepths = [];
        foreach ($recursiveIteratorIterator as $childException) {
            if ($this->isOmissible($childException)) {
                continue;
            }

            $currentDepth = $lastDepth;
            $currentDepthOriginal = $recursiveIteratorIterator->getDepth() + 1;

            if (isset($knownDepths[$currentDepthOriginal])) {
                $currentDepth = $knownDepths[$currentDepthOriginal];
            } elseif ($currentDepthOriginal > $lastDepthOriginal
                && ($this->hasCustomTemplate() || $exceptionIterator->count() != 1)) {
                ++$currentDepth;
            }

            if (!isset($knownDepths[$currentDepthOriginal])) {
                $knownDepths[$currentDepthOriginal] = $currentDepth;
            }

            $lastDepth = $currentDepth;
            $lastDepthOriginal = $currentDepthOriginal;

            $childrenExceptions->attach(
                $childException,
                [
                    'depth' => $currentDepth,
                    'depth_original' => $currentDepthOriginal,
                    'previous_depth' => $lastDepth,
                    'previous_depth_original' => $lastDepthOriginal,
                ]
            );
        }

        return $childrenExceptions;
    }

    /**
     * @return array
     */
    public function getMessages()
    {
        $messages = [$this->getMessage()];
        foreach ($this as $exception) {
            $messages[] = $exception->getMessage();
        }

        if (count($messages) > 1) {
            array_shift($messages);
        }

        return $messages;
    }

    /**
     * @return string
     */
    public function getFullMessage()
    {
        $marker = '-';
        $messages = [];
        $exceptions = $this->getIterator();

        if ($this->hasCustomTemplate() || count($exceptions) != 1) {
            $messages[] = sprintf('%s %s', $marker, $this->getMessage());
        }

        foreach ($exceptions as $exception) {
            $depth = $exceptions[$exception]['depth'];
            $prefix = str_repeat(' ', $depth * 2);
            $messages[] = sprintf('%s%s %s', $prefix, $marker, $exception->getMessage());
        }

        return implode(PHP_EOL, $messages);
    }

    /**
     * @return SplObjectStorage
     */
    public function getRelated()
    {
        if (!$this->exceptions instanceof SplObjectStorage) {
            $this->exceptions = new SplObjectStorage();
        }

        return $this->exceptions;
    }

    /**
     * @param string $name
     * @param mixed  $value
     *
     * @return self
     */
    public function setParam($name, $value)
    {
        if ('translator' === $name) {
            foreach ($this->getRelated() as $exception) {
                $exception->setParam($name, $value);
            }
        }

        parent::setParam($name, $value);

        return $this;
    }

    /**
     * @return bool
     */
    private function isRelated($name, ValidationException $exception)
    {
        return $exception->getId() === $name || $exception->getName() === $name;
    }

    /**
     * @return ValidationException
     */
    public function getRelatedByName($name)
    {
        if ($this->isRelated($name, $this)) {
            return $this;
        }

        foreach ($this->getRecursiveIterator() as $exception) {
            if ($this->isRelated($name, $exception)) {
                return $exception;
            }
        }
    }

    /**
     * @param array $exceptions
     *
     * @return self
     */
    public function setRelated(array $exceptions)
    {
        foreach ($exceptions as $exception) {
            $this->addRelated($exception);
        }

        return $this;
    }
}


1		<?php
2
3		/*
4		* This file is part of Respect/Validation.
5		*
6		* (c) Alexandre Gomes Gaigalas <[email protected]>
7		*
8		* For the full copyright and license information, please view the "LICENSE.md"
9		* file that was distributed with this source code.
10		*/
11
12		namespace Respect\Validation\Exceptions;
13
14		use IteratorAggregate;
15		use RecursiveIteratorIterator;
16		use SplObjectStorage;
17
18		class NestedValidationException extends ValidationException implements IteratorAggregate
19		{
20		/**
21		* @var SplObjectStorage
22		*/
23		private $exceptions = [];
24
25		/**
26		* @param ValidationException $exception
27		*
28		* @return self
29		*/
30	127	public function addRelated(ValidationException $exception)
31		{
32	127	$this->getRelated()->attach($exception);
33
34	127	return $this;
35		}
36
37		/**
38		* @param string $path
39		* @param ValidationException $exception
40		*
41		* @return ValidationException
42		*/
43	8	private function getExceptionForPath($path, ValidationException $exception)
44		{
45	8	if ($path === $exception->guessId()) {
46	5	return $exception;
47		}
48
49	6	if (!$exception instanceof self) {
50	2	return $exception;
51		}
52
53	4	foreach ($exception as $subException) {
54	4	return $subException;
55		}
56
57	1	return $exception;
58		}
59
60		/**
61		* @param array $paths
62		*
63		* @return string[]
64		*/
65	8	public function findMessages(array $paths)
66		{
67	8	$messages = [];
68
69	8	foreach ($paths as $key => $value) {
70	8	$numericKey = is_numeric($key);
71	8	$path = $numericKey ? $value : $key;
72
73	8	if (!($exception = $this->getRelatedByName($path))) {
74	4	$exception = $this->findRelated($path);
75		}
76
77	8	$path = str_replace('.', '_', $path);
78
79	8	if (!$exception) {
80	1	$messages[$path] = '';
81	1	continue;
82		}
83
84	8	$exception = $this->getExceptionForPath($path, $exception);
85	8	if (!$numericKey) {
86	4	$exception->setTemplate($value);
87		}
88
89	8	$messages[$path] = $exception->getMainMessage();
90		}
91
92	8	return $messages;
93		}
94
95		/**
96		* @return Exception
97		*/
98	5	public function findRelated($path)
99		{
100	5	$target = $this;
101	5	$pieces = explode('.', $path);
102
103	5	while (!empty($pieces) && $target) {
104	5	$piece = array_shift($pieces);
105	5	$target = $target->getRelatedByName($piece);
106		}
107
108	5	return $target;
109		}
110
111		/**
112		* @return RecursiveIteratorIterator
113		*/
114	122	private function getRecursiveIterator()
115		{
116	122	$exceptionIterator = new RecursiveExceptionIterator($this);
117	122	$recursiveIteratorIterator = new RecursiveIteratorIterator(
118	122	$exceptionIterator,
119	122	RecursiveIteratorIterator::SELF_FIRST
120		);
121
122	122	return $recursiveIteratorIterator;
123		}
124
125		/**
126		* Returns weather an exception should be omitted or not.
127		*
128		* @param ExceptionInterface $exception
129		*
130		* @return bool
131		*/
132	116	private function isOmissible(ExceptionInterface $exception)
133		{
134	116	if (!$exception instanceof self) {
135	114	return false;
136		}
137
138	17	$relatedExceptions = $exception->getRelated();
139	17	$relatedExceptions->rewind();
140	17	$childException = $relatedExceptions->current();
141
142	17	return $relatedExceptions->count() === 1 && !$childException instanceof NonOmissibleExceptionInterface;
143		}
144
145		/**
146		* @return SplObjectStorage
147		*/
148	117	public function getIterator()
149		{
150	117	$childrenExceptions = new SplObjectStorage();
151
152	117	$recursiveIteratorIterator = $this->getRecursiveIterator();
153	117	$exceptionIterator = $recursiveIteratorIterator->getInnerIterator();
154
155	117	$lastDepth = 0;
156	117	$lastDepthOriginal = 0;
157	117	$knownDepths = [];
158	117	foreach ($recursiveIteratorIterator as $childException) {
159	116	if ($this->isOmissible($childException)) {
160	15	continue;
161		}
162
163	116	$currentDepth = $lastDepth;
164	116	$currentDepthOriginal = $recursiveIteratorIterator->getDepth() + 1;
165
166	116	if (isset($knownDepths[$currentDepthOriginal])) {
167	13	$currentDepth = $knownDepths[$currentDepthOriginal];
168	116	} elseif ($currentDepthOriginal > $lastDepthOriginal
169	116	&& ($this->hasCustomTemplate() \|\| $exceptionIterator->count() != 1)) {
170	13	++$currentDepth;
171		}
172
173	116	if (!isset($knownDepths[$currentDepthOriginal])) {
174	116	$knownDepths[$currentDepthOriginal] = $currentDepth;
175		}
176
177	116	$lastDepth = $currentDepth;
178	116	$lastDepthOriginal = $currentDepthOriginal;
179
180	116	$childrenExceptions->attach(
181	116	$childException,
182		[
183	116	'depth' => $currentDepth,
184	116	'depth_original' => $currentDepthOriginal,
185	116	'previous_depth' => $lastDepth,
186	116	'previous_depth_original' => $lastDepthOriginal,
187		]
188		);
189		}
190
191	117	return $childrenExceptions;
192		}
193
194		/**
195		* @return array
196		*/
197	4	public function getMessages()
198		{
199	4	$messages = [$this->getMessage()];
200	4	foreach ($this as $exception) {
201	4	$messages[] = $exception->getMessage();
202		}
203
204	4	if (count($messages) > 1) {
205	4	array_shift($messages);
206		}
207
208	4	return $messages;
209		}
210
211		/**
212		* @return string
213		*/
214	110	public function getFullMessage()
215		{
216	110	$marker = '-';
217	110	$messages = [];
218	110	$exceptions = $this->getIterator();
219
220	110	if ($this->hasCustomTemplate() \|\| count($exceptions) != 1) {
221	11	$messages[] = sprintf('%s %s', $marker, $this->getMessage());
222		}
223
224	110	foreach ($exceptions as $exception) {
225	109	$depth = $exceptions[$exception]['depth'];
226	109	$prefix = str_repeat(' ', $depth * 2);
227	109	$messages[] = sprintf('%s%s %s', $prefix, $marker, $exception->getMessage());
228		}
229
230	110	return implode(PHP_EOL, $messages);
231		}
232
233		/**
234		* @return SplObjectStorage
235		*/
236	128	public function getRelated()
237		{
238	128	if (!$this->exceptions instanceof SplObjectStorage) {
239	128	$this->exceptions = new SplObjectStorage();
240		}
241
242	128	return $this->exceptions;
243		}
244
245		/**
246		* @param string $name
247		* @param mixed $value
248		*
249		* @return self
250		*/
251	1	public function setParam($name, $value)
252		{
253	1	if ('translator' === $name) {
254	1	foreach ($this->getRelated() as $exception) {
255	1	$exception->setParam($name, $value);
256		}
257		}
258
259	1	parent::setParam($name, $value);
260
261	1	return $this;
262		}
263
264		/**
265		* @return bool
266		*/
267	9	private function isRelated($name, ValidationException $exception)
268		{
269	9	return $exception->getId() === $name \|\| $exception->getName() === $name;
270		}
271
272		/**
273		* @return ValidationException
274		*/
275	9	public function getRelatedByName($name)
276		{
277	9	if ($this->isRelated($name, $this)) {
278	2	return $this;
279		}
280
281	9	foreach ($this->getRecursiveIterator() as $exception) {
282	9	if ($this->isRelated($name, $exception)) {
283	9	return $exception;
284		}
285		}
286	5	}
287
288		/**
289		* @param array $exceptions
290		*
291		* @return self
292		*/
293	124	public function setRelated(array $exceptions)
294		{
295	124	foreach ($exceptions as $exception) {
296	124	$this->addRelated($exception);
297		}
298
299	124	return $this;
300		}
301		}
302

Respect / Validation

Scrutinizer GitHub App not installed

Pull Request — master (#893)

NestedValidationException::getRelated() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like