ValidationException::setName() - Code Metrics - Inspection of "Avoid using unset keys in IpException" - Respect/Validation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 1.1 (#1035)

by Henrique

created 2018-06-23 19:02 UTC

ValidationException::setName() A

↳ Parent: ValidationException

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?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 DateTime;
use Exception;
use InvalidArgumentException;
use Traversable;

class ValidationException extends InvalidArgumentException implements ExceptionInterface
{
    const MODE_DEFAULT = 1;
    const MODE_NEGATIVE = 2;
    const STANDARD = 0;
    public static $defaultTemplates = [
        self::MODE_DEFAULT => [
            self::STANDARD => 'Data validation failed for %s',
        ],
        self::MODE_NEGATIVE => [
            self::STANDARD => 'Data validation failed for %s',
        ],
    ];

    /**
     * @var int
     */
    private static $maxDepthStringify = 5;

    /**
     * @var int
     */
    private static $maxCountStringify = 10;

    /**
     * @var string
     */
    private static $maxReplacementStringify = '...';

    protected $id = 'validation';
    protected $mode = self::MODE_DEFAULT;
    protected $name = '';
    protected $template = '';
    protected $params = [];
    private $customTemplate = false;

    public static function format($template, array $vars = [])
    {
        return preg_replace_callback(
            '/{{(\w+)}}/',
            function ($match) use ($vars) {
                if (!isset($vars[$match[1]])) {
                    return $match[0];
                }

                $value = $vars[$match[1]];
                if ('name' == $match[1] && is_string($value)) {
                    return $value;
                }

                return ValidationException::stringify($value);
            },
            $template
        );
    }

    /**
     * @param mixed $value
     * @param int   $depth
     *
     * @return string
     */
    public static function stringify($value, $depth = 1)
    {
        if ($depth >= self::$maxDepthStringify) {
            return self::$maxReplacementStringify;
        }

        if (is_array($value)) {
            return static::stringifyArray($value, $depth);
        }

        if (is_object($value)) {
            return static::stringifyObject($value, $depth);
        }

        if (is_resource($value)) {
            return sprintf('`[resource] (%s)`', get_resource_type($value));
        }

        if (is_float($value)) {
            if (is_infinite($value)) {
                return ($value > 0 ? '' : '-').'INF';
            }

            if (is_nan($value)) {
                return 'NaN';
            }
        }

        return (@json_encode($value, (JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE)) ?: $value);
    }

    /**
     * @param array $value
     * @param int   $depth
     *
     * @return string
     */
    public static function stringifyArray(array $value, $depth = 1)
    {
        $nextDepth = ($depth + 1);
        if ($nextDepth >= self::$maxDepthStringify) {
            return self::$maxReplacementStringify;
        }

        if (empty($value)) {
            return '{ }';
        }

        $total = count($value);
        $string = '';
        $current = 0;
        foreach ($value as $childKey => $childValue) {
            if ($current++ >= self::$maxCountStringify) {
                $string .= self::$maxReplacementStringify;
                break;
            }

            if (!is_int($childKey)) {
                $string .= sprintf('%s: ', static::stringify($childKey, $nextDepth));
            }

            $string .= static::stringify($childValue, $nextDepth);

            if ($current !== $total) {
                $string .= ', ';
            }
        }

        return sprintf('{ %s }', $string);
    }

    /**
     * @param mixed $value
     * @param int   $depth
     *
     * @return string
     */
    public static function stringifyObject($value, $depth = 2)
    {
        $nextDepth = $depth + 1;

        if ($value instanceof DateTime) {
            return sprintf('"%s"', $value->format('Y-m-d H:i:s'));
        }

        $class = get_class($value);

        if ($value instanceof Traversable) {
            return sprintf('`[traversable] (%s: %s)`', $class, static::stringify(iterator_to_array($value), $nextDepth));
        }

        if ($value instanceof Exception) {
            $properties = [
                'message' => $value->getMessage(),
                'code' => $value->getCode(),
                'file' => $value->getFile().':'.$value->getLine(),
            ];

            return sprintf('`[exception] (%s: %s)`', $class, static::stringify($properties, $nextDepth));
        }

        if (method_exists($value, '__toString')) {
            return static::stringify($value->__toString(), $nextDepth);
        }

        $properties = static::stringify(get_object_vars($value), $nextDepth);

        return sprintf('`[object] (%s: %s)`', $class, str_replace('`', '', $properties));
    }

    public function __toString()
    {
        return $this->getMainMessage();
    }

    public function chooseTemplate()
    {
        return key(static::$defaultTemplates[$this->mode]);
    }

    public function configure($name, array $params = [])
    {
        $this->setName($name);
        $this->setId($this->guessId());
        $this->setParams($params);

        return $this;
    }

    public function getName()
    {
        return $this->name;
    }

    public function getId()
    {
        return $this->id;
    }

    public function getMainMessage()
    {
        $vars = $this->getParams();
        $vars['name'] = $this->getName();
        $template = $this->getTemplate();
        if (isset($vars['translator']) && is_callable($vars['translator'])) {
            $template = call_user_func($vars['translator'], $template);
        }

        return static::format($template, $vars);
    }

    public function getParam($name)
    {
        return $this->hasParam($name) ? $this->params[$name] : false;
    }

    public function getParams()
    {
        return $this->params;
    }

    public function getTemplate()
    {
        if (!empty($this->template)) {
            return $this->template;
        } else {
            return $this->template = $this->buildTemplate();
        }
    }

    public function hasParam($name)
    {
        return isset($this->params[$name]);
    }

    public function setId($id)
    {
        $this->id = $id;

        return $this;
    }

    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    public function setMode($mode)
    {
        $this->mode = $mode;
        $this->template = $this->buildTemplate();

        $this->buildMessage();

        return $this;
    }

    public function setParam($key, $value)
    {
        $this->params[$key] = $value;

        $this->buildMessage();

        return $this;
    }

    public function setParams(array $params)
    {
        foreach ($params as $key => $value) {
            $this->params[$key] = $value;
        }

        $this->buildMessage();

        return $this;
    }

    public function hasCustomTemplate()
    {
        return (true === $this->customTemplate);
    }

    public function setTemplate($template)
    {
        $this->customTemplate = true;
        if (isset(static::$defaultTemplates[$this->mode][$template])) {
            $template = static::$defaultTemplates[$this->mode][$template];
        }
        $this->template = $template;

        $this->buildMessage();

        return $this;
    }

    private function buildMessage()
    {
        $this->message = $this->getMainMessage();
    }

    protected function buildTemplate()
    {
        $templateKey = $this->chooseTemplate();

        return static::$defaultTemplates[$this->mode][$templateKey];
    }

    public function guessId()
    {
        if (!empty($this->id) && $this->id != 'validation') {
            return $this->id;
        }

        $pieces = explode('\\', get_called_class());
        $exceptionClassShortName = end($pieces);
        $ruleClassShortName = str_replace('Exception', '', $exceptionClassShortName);
        $ruleName = lcfirst($ruleClassShortName);

        return $ruleName;
    }
}


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 DateTime;
15		use Exception;
16		use InvalidArgumentException;
17		use Traversable;
18
19		class ValidationException extends InvalidArgumentException implements ExceptionInterface
20		{
21		const MODE_DEFAULT = 1;
22		const MODE_NEGATIVE = 2;
23		const STANDARD = 0;
24		public static $defaultTemplates = [
25		self::MODE_DEFAULT => [
26		self::STANDARD => 'Data validation failed for %s',
27		],
28		self::MODE_NEGATIVE => [
29		self::STANDARD => 'Data validation failed for %s',
30		],
31		];
32
33		/**
34		* @var int
35		*/
36		private static $maxDepthStringify = 5;
37
38		/**
39		* @var int
40		*/
41		private static $maxCountStringify = 10;
42
43		/**
44		* @var string
45		*/
46		private static $maxReplacementStringify = '...';
47
48		protected $id = 'validation';
49		protected $mode = self::MODE_DEFAULT;
50		protected $name = '';
51		protected $template = '';
52		protected $params = [];
53		private $customTemplate = false;
54
55	8	public static function format($template, array $vars = [])
56		{
57	8	return preg_replace_callback(
58	8	'/{{(\w+)}}/',
59	8	function ($match) use ($vars) {
60	7	if (!isset($vars[$match[1]])) {
61	2	return $match[0];
62		}
63
64	7	$value = $vars[$match[1]];
65	7	if ('name' == $match[1] && is_string($value)) {
66	4	return $value;
67		}
68
69	4	return ValidationException::stringify($value);
70	8	},
71		$template
72	8	);
73		}
74
75		/**
76		* @param mixed $value
77		* @param int $depth
78		*
79		* @return string
80		*/
81	36	public static function stringify($value, $depth = 1)
82		{
83	36	if ($depth >= self::$maxDepthStringify) {
84		return self::$maxReplacementStringify;
85		}
86
87	36	if (is_array($value)) {
88	20	return static::stringifyArray($value, $depth);
89		}
90
91	35	if (is_object($value)) {
92	9	return static::stringifyObject($value, $depth);
93		}
94
95	33	if (is_resource($value)) {
96	4	return sprintf('`[resource] (%s)`', get_resource_type($value));
97		}
98
99	30	if (is_float($value)) {
100	4	if (is_infinite($value)) {
101	2	return ($value > 0 ? '' : '-').'INF';
102		}
103
104	2	if (is_nan($value)) {
105	1	return 'NaN';
106		}
107	1	}
108
109	27	return (@json_encode($value, (JSON_UNESCAPED_SLASHES \| JSON_UNESCAPED_UNICODE)) ?: $value);
110		}
111
112		/**
113		* @param array $value
114		* @param int $depth
115		*
116		* @return string
117		*/
118	20	public static function stringifyArray(array $value, $depth = 1)
119		{
120	20	$nextDepth = ($depth + 1);
121	20	if ($nextDepth >= self::$maxDepthStringify) {
122	4	return self::$maxReplacementStringify;
123		}
124
125	20	if (empty($value)) {
126	3	return '{ }';
127		}
128
129	18	$total = count($value);
130	18	$string = '';
131	18	$current = 0;
132	18	foreach ($value as $childKey => $childValue) {
133	18	if ($current++ >= self::$maxCountStringify) {
134	1	$string .= self::$maxReplacementStringify;
135	1	break;
136		}
137
138	18	if (!is_int($childKey)) {
139	7	$string .= sprintf('%s: ', static::stringify($childKey, $nextDepth));
140	7	}
141
142	18	$string .= static::stringify($childValue, $nextDepth);
143
144	18	if ($current !== $total) {
145	16	$string .= ', ';
146	16	}
147	18	}
148
149	18	return sprintf('{ %s }', $string);
150		}
151
152		/**
153		* @param mixed $value
154		* @param int $depth
155		*
156		* @return string
157		*/
158	9	public static function stringifyObject($value, $depth = 2)
159		{
160	9	$nextDepth = $depth + 1;
161
162	9	if ($value instanceof DateTime) {
163	1	return sprintf('"%s"', $value->format('Y-m-d H:i:s'));
164		}
165
166	8	$class = get_class($value);
167
168	8	if ($value instanceof Traversable) {
169	2	return sprintf('`[traversable] (%s: %s)`', $class, static::stringify(iterator_to_array($value), $nextDepth));
170		}
171
172	6	if ($value instanceof Exception) {
173		$properties = [
174	1	'message' => $value->getMessage(),
175	1	'code' => $value->getCode(),
176	1	'file' => $value->getFile().':'.$value->getLine(),
177	1	];
178
179	1	return sprintf('`[exception] (%s: %s)`', $class, static::stringify($properties, $nextDepth));
180		}
181
182	5	if (method_exists($value, '__toString')) {
183	1	return static::stringify($value->__toString(), $nextDepth);
184		}
185
186	4	$properties = static::stringify(get_object_vars($value), $nextDepth);
187
188	4	return sprintf('`[object] (%s: %s)`', $class, str_replace('`', '', $properties));
189		}
190
191	2	public function __toString()
192		{
193	2	return $this->getMainMessage();
194		}
195
196	4	public function chooseTemplate()
197		{
198	4	return key(static::$defaultTemplates[$this->mode]);
199		}
200
201	3	public function configure($name, array $params = [])
202		{
203	3	$this->setName($name);
204	3	$this->setId($this->guessId());
205	3	$this->setParams($params);
206
207	3	return $this;
208		}
209
210	5	public function getName()
211		{
212	5	return $this->name;
213		}
214
215	1	public function getId()
216		{
217	1	return $this->id;
218		}
219
220	5	public function getMainMessage()
221		{
222	5	$vars = $this->getParams();
223	5	$vars['name'] = $this->getName();
224	5	$template = $this->getTemplate();
225	5	if (isset($vars['translator']) && is_callable($vars['translator'])) {
226		$template = call_user_func($vars['translator'], $template);
227		}
228
229	5	return static::format($template, $vars);
230		}
231
232	1	public function getParam($name)
233		{
234	1	return $this->hasParam($name) ? $this->params[$name] : false;
235		}
236
237	5	public function getParams()
238		{
239	5	return $this->params;
240		}
241
242	5	public function getTemplate()
243		{
244	5	if (!empty($this->template)) {
245	4	return $this->template;
246		} else {
247	5	return $this->template = $this->buildTemplate();
248		}
249		}
250
251	1	public function hasParam($name)
252		{
253	1	return isset($this->params[$name]);
254		}
255
256	3	public function setId($id)
257		{
258	3	$this->id = $id;
259
260	3	return $this;
261		}
262
263	3	public function setName($name)
264		{
265	3	$this->name = $name;
266
267	3	return $this;
268		}
269
270		public function setMode($mode)
271		{
272		$this->mode = $mode;
273		$this->template = $this->buildTemplate();
274
275		$this->buildMessage();
276
277		return $this;
278		}
279
280		public function setParam($key, $value)
281		{
282		$this->params[$key] = $value;
283
284		$this->buildMessage();
285
286		return $this;
287		}
288
289	3	public function setParams(array $params)
290		{
291	3	foreach ($params as $key => $value) {
292	1	$this->params[$key] = $value;
293	3	}
294
295	3	$this->buildMessage();
296
297	3	return $this;
298		}
299
300		public function hasCustomTemplate()
301		{
302		return (true === $this->customTemplate);
303		}
304
305	2	public function setTemplate($template)
306		{
307	2	$this->customTemplate = true;
308	2	if (isset(static::$defaultTemplates[$this->mode][$template])) {
309		$template = static::$defaultTemplates[$this->mode][$template];
310		}
311	2	$this->template = $template;
312
313	2	$this->buildMessage();
314
315	2	return $this;
316		}
317
318	3	private function buildMessage()
319		{
320	3	$this->message = $this->getMainMessage();
321	3	}
322
323	5	protected function buildTemplate()
324		{
325	5	$templateKey = $this->chooseTemplate();
326
327	5	return static::$defaultTemplates[$this->mode][$templateKey];
328		}
329
330	3	public function guessId()
331		{
332	3	if (!empty($this->id) && $this->id != 'validation') {
333		return $this->id;
334		}
335
336	3	$pieces = explode('\\', get_called_class());
337	3	$exceptionClassShortName = end($pieces);
338	3	$ruleClassShortName = str_replace('Exception', '', $exceptionClassShortName);
339	3	$ruleName = lcfirst($ruleClassShortName);
340
341	3	return $ruleName;
342		}
343		}
344

Respect / Validation

Scrutinizer GitHub App not installed

Pull Request — 1.1 (#1035)

ValidationException::setName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like