ReservedKeywordHandler::isReservedKeyword() - Code Metrics - Inspection of "Refactor" - yiisoft/yii-gii - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#58)

by Dmitriy

created 2022-10-18 12:15 UTC

ReservedKeywordHandler::isReservedKeyword() A

↳ Parent: ReservedKeywordHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Gii\Validator;

use Yiisoft\Validator\Exception\UnexpectedRuleException;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\RuleHandlerInterface;
use Yiisoft\Validator\ValidationContext;

final class ReservedKeywordHandler implements RuleHandlerInterface
{
    private const KEYWORDS = [
        '__class__',
        '__dir__',
        '__file__',
        '__function__',
        '__line__',
        '__method__',
        '__namespace__',
        '__trait__',
        'abstract',
        'and',
        'array',
        'as',
        'break',
        'case',
        'catch',
        'callable',
        'cfunction',
        'class',
        'clone',
        'const',
        'continue',
        'declare',
        'default',
        'die',
        'do',
        'echo',
        'else',
        'elseif',
        'empty',
        'enddeclare',
        'endfor',
        'endforeach',
        'endif',
        'endswitch',
        'endwhile',
        'eval',
        'exception',
        'exit',
        'extends',
        'final',
        'finally',
        'for',
        'foreach',
        'function',
        'global',
        'goto',
        'if',
        'implements',
        'include',
        'include_once',
        'instanceof',
        'insteadof',
        'interface',
        'isset',
        'list',
        'namespace',
        'new',
        'old_function',
        'or',
        'parent',
        'php_user_filter',
        'print',
        'private',
        'protected',
        'public',
        'require',
        'require_once',
        'return',
        'static',
        'switch',
        'this',
        'throw',
        'trait',
        'try',
        'unset',
        'use',
        'var',
        'while',
        'xor',
        'fn',
    ];

    public function validate(mixed $value, object $rule, ValidationContext $context): Result
    {
        if (!$rule instanceof ReservedKeywordRule) {
            throw new UnexpectedRuleException(ReservedKeywordRule::class, $rule);
        }

        $result = new Result();
        if (self::isReservedKeyword($value)) {
            $result->addError(
                message: 'The value {value} is reserved keyword.',
                parameters: ['value' => $value],
            );
        }

        return $result;
    }

    /**
     * @param string $value the attribute to be validated
     *
     * @return bool whether the value is a reserved PHP keyword.
     */
    private static function isReservedKeyword(string $value): bool
    {
        return in_array(strtolower($value), self::KEYWORDS, true);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Yiisoft\Yii\Gii\Validator;
6
7			use Yiisoft\Validator\Exception\UnexpectedRuleException;
8			use Yiisoft\Validator\Result;
9			use Yiisoft\Validator\RuleHandlerInterface;
10			use Yiisoft\Validator\ValidationContext;
11
12			final class ReservedKeywordHandler implements RuleHandlerInterface
13			{
14			private const KEYWORDS = [
15			'__class__',
16			'__dir__',
17			'__file__',
18			'__function__',
19			'__line__',
20			'__method__',
21			'__namespace__',
22			'__trait__',
23			'abstract',
24			'and',
25			'array',
26			'as',
27			'break',
28			'case',
29			'catch',
30			'callable',
31			'cfunction',
32			'class',
33			'clone',
34			'const',
35			'continue',
36			'declare',
37			'default',
38			'die',
39			'do',
40			'echo',
41			'else',
42			'elseif',
43			'empty',
44			'enddeclare',
45			'endfor',
46			'endforeach',
47			'endif',
48			'endswitch',
49			'endwhile',
50			'eval',
51			'exception',
52			'exit',
53			'extends',
54			'final',
55			'finally',
56			'for',
57			'foreach',
58			'function',
59			'global',
60			'goto',
61			'if',
62			'implements',
63			'include',
64			'include_once',
65			'instanceof',
66			'insteadof',
67			'interface',
68			'isset',
69			'list',
70			'namespace',
71			'new',
72			'old_function',
73			'or',
74			'parent',
75			'php_user_filter',
76			'print',
77			'private',
78			'protected',
79			'public',
80			'require',
81			'require_once',
82			'return',
83			'static',
84			'switch',
85			'this',
86			'throw',
87			'trait',
88			'try',
89			'unset',
90			'use',
91			'var',
92			'while',
93			'xor',
94			'fn',
95			];
96
97			public function validate(mixed $value, object $rule, ValidationContext $context): Result
98			{
99			if (!$rule instanceof ReservedKeywordRule) {
100			throw new UnexpectedRuleException(ReservedKeywordRule::class, $rule);
101			}
102
103			$result = new Result();
104			if (self::isReservedKeyword($value)) {
105			$result->addError(
106			message: 'The value {value} is reserved keyword.',
107			parameters: ['value' => $value],
108			);
109			}
110
111			return $result;
112			}
113
114			/**
115			* @param string $value the attribute to be validated
116			*
117			* @return bool whether the value is a reserved PHP keyword.
118			*/
119			private static function isReservedKeyword(string $value): bool
120			{
121			return in_array(strtolower($value), self::KEYWORDS, true);
122			}
123			}
124

yiisoft / yii-gii

Pull Request — master (#58)

ReservedKeywordHandler::isReservedKeyword() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like