SchemaAttribute::usedInIndex() - Code Metrics - Inspection of "Updated actions methods" - flexphp/flex-schema - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 59d538...3bdea0 )

by Freddie

created 2021-05-23 19:14 UTC

SchemaAttribute::usedInIndex() A

↳ Parent: SchemaAttribute

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

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

<?php declare(strict_types=1);
/*
 * This file is part of FlexPHP.
 *
 * (c) Freddie Gar <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace FlexPHP\Schema;

use Exception;
use FlexPHP\Schema\Constants\Action;
use FlexPHP\Schema\Constants\Keyword;
use FlexPHP\Schema\Constants\Rule;
use FlexPHP\Schema\Exception\InvalidSchemaAttributeException;
use FlexPHP\Schema\Validations\SchemaAttributeLogicValidation;
use FlexPHP\Schema\Validations\SchemaAttributeValidation;

final class SchemaAttribute implements SchemaAttributeInterface
{
    private string $name;

    private string $dataType;

    /**
     * @var array<string, mixed>
     */
    private array $constraints = [];

    /**
     * @param mixed $constraints
     */
    public function __construct(string $name, string $dataType, $constraints = null)
    {
        $this->setName($name);
        $this->setDataType($dataType);
        $this->setConstraints($constraints);

        $this->validate();
    }

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

    public function dataType(): string
    {
        return $this->dataType;
    }

    public function constraints(): array
    {
        return $this->constraints;
    }

    public function type(): ?string
    {
        return $this->constraints[Rule::TYPE] ?? null;
    }

    public function isRequired(): bool
    {
        return (bool)($this->constraints[Rule::REQUIRED] ?? false);
    }

    public function minLength(): ?int
    {
        return $this->constraints[Rule::MINLENGTH] ?? null;
    }

    public function maxLength(): ?int
    {
        return $this->constraints[Rule::MAXLENGTH] ?? null;
    }

    public function minCheck(): ?int
    {
        return $this->constraints[Rule::MINCHECK] ?? null;
    }

    public function maxCheck(): ?int
    {
        return $this->constraints[Rule::MAXCHECK] ?? null;
    }

    public function min(): ?int
    {
        return $this->constraints[Rule::MIN] ?? null;
    }

    public function max(): ?int
    {
        return $this->constraints[Rule::MAX] ?? null;
    }

    public function equalTo(): ?string
    {
        return $this->constraints[Rule::EQUALTO] ?? null;
    }

    public function isPk(): bool
    {
        return (bool)($this->constraints[Rule::PRIMARYKEY] ?? false);
    }

    public function isAi(): bool
    {
        return (bool)($this->constraints[Rule::AUTOINCREMENT] ?? false);
    }

    public function isFk(): bool
    {
        return (bool)($this->constraints[Rule::FOREIGNKEY] ?? false);
    }

    public function fkTable(): ?string
    {
        return $this->constraints[Rule::FOREIGNKEY]['table'] ?? null;
    }

    public function fkId(): ?string
    {
        return $this->constraints[Rule::FOREIGNKEY]['id'] ?? null;
    }

    public function fkName(): ?string
    {
        return $this->constraints[Rule::FOREIGNKEY]['name'] ?? null;
    }

    public function isCa(): bool
    {
        return (bool)($this->constraints[Rule::CREATEDAT] ?? false);
    }

    public function isUa(): bool
    {
        return (bool)($this->constraints[Rule::UPDATEDAT] ?? false);
    }

    public function isCb(): bool
    {
        return (bool)($this->constraints[Rule::CREATEDBY] ?? false);
    }

    public function isUb(): bool
    {
        return (bool)($this->constraints[Rule::UPDATEDBY] ?? false);
    }

    public function isBlameAt(): bool
    {
        return $this->isCa() || $this->isUa();
    }

    public function isBlameBy(): bool
    {
        return $this->isCb() || $this->isUb();
    }

    public function isBlame(): bool
    {
        return $this->isBlameAt() || $this->isBlameBy();
    }

    public function filter(): ?string
    {
        return $this->constraints[Rule::FILTER] ?? null;
    }

    public function format(): ?string
    {
        return $this->constraints[Rule::FORMAT] ?? null;
    }

    public function isFormat(string $format): bool
    {
        return $this->format() === $format;
    }

    public function trim(): bool
    {
        return (bool)($this->constraints[Rule::TRIM] ?? false);
    }

    public function fchars(): ?int
    {
        return $this->constraints[Rule::FCHARS] ?? null;
    }

    public function fkcheck(): bool
    {
        return (bool)($this->constraints[Rule::FKCHECK] ?? false);
    }

    public function link(): bool
    {
        return (bool)($this->constraints[Rule::LINK] ?? false);
    }

    public function show(): array
    {
        $default = $this->isBlame()
            ? Action::READ
            : Action::ALL;

        $hideConstraint = $this->constraints[Rule::HIDE] ?? '';

        if (\strpos($hideConstraint, Action::ALL) !== false) {
            $default = \str_replace(Action::ALL, '', $default);
        }

        if (\strpos($hideConstraint, Action::READ) !== false) {
            $default = \str_replace(Action::READ, '', $default);
        }

        return \explode(',', $this->constraints[Rule::SHOW] ?? $default);
    }

    public function hide(): array
    {
        $default = $this->isBlame()
            ? Action::INDEX . Action::CREATE . Action::UPDATE . Action::DELETE
            : '';

        return \explode(',', $this->constraints[Rule::HIDE] ?? $default);
    }

    /**
     * @return mixed
     */
    public function default()
    {
        if (!isset($this->constraints[Rule::DEFAULT])) {
            return null;
        }

        return $this->constraints[Rule::DEFAULT];
    }

    public function usedIn(string $action): bool
    {
        return \in_array($action, $this->show(), true);
    }

    public function properties(): array
    {
        return [
            Keyword::NAME => $this->name(),
            Keyword::DATATYPE => $this->dataType(),
            Keyword::CONSTRAINTS => $this->constraints(),
        ];
    }

    public function typeHint(): string
    {
        $typeHintByDataType = [
            'smallint' => 'int',
            'integer' => 'int',
            'float' => 'float',
            'double' => 'float',
            'bool' => 'bool',
            'boolean' => 'bool',
            'date' => '\DateTime',
            'date_immutable' => '\DateTimeImmutable',
            'datetime' => '\DateTime',
            'datetime_immutable' => '\DateTimeImmutable',
            'datetimetz' => '\DateTime',
            'datetimetz_immutable' => '\DateTimeImmutable',
            'time' => '\DateTime',
            'time_immutable' => '\DateTimeImmutable',
            'array' => 'array',
            'simple_array' => 'array',
            'json' => 'array',
        ];

        if (isset($typeHintByDataType[$this->dataType()])) {
            return $typeHintByDataType[$this->dataType()];
        }

        return 'string';
    }

    private function validate(): void
    {
        try {
            (new SchemaAttributeValidation($this->properties()))->validate();
            (new SchemaAttributeLogicValidation($this))->validate();
        } catch (Exception $exception) {
            throw new InvalidSchemaAttributeException(
                \sprintf('Attribute %s > %s', $this->name(), $exception->getMessage())
            );
        }
    }

    private function setName(string $name): void
    {
        $this->name = $name;
    }

    private function setDataType(string $dataType): void
    {
        $this->dataType = $dataType;
    }

    /**
     * @param mixed $constraints
     */
    private function setConstraints($constraints): void
    {
        if (!empty($constraints)) {
            if (\is_string($constraints)) {
                $this->setConstraintsFromString($constraints);
            } else {
                $this->setConstraintsFromArray($constraints);
            }
        }
    }

    private function setConstraintsFromString(string $constraints): void
    {
        $this->setConstraintsFromArray($this->getConstraintsFromString($constraints));
    }

    private function setConstraintsFromArray(array $constraints): void
    {
        $this->constraints = $this->getConstraintsCast($constraints);
    }

    private function getConstraintsFromString(string $constraints): array
    {
        $_constraints = \explode('|', $constraints);

        /** @var mixed $_constraint */
        foreach ($_constraints as $index => $_constraint) {
            $_rule = \explode(':', $_constraint);

            if (\count($_rule) === 2) {
                [$_name, $_options] = $_rule;

                if (Rule::FOREIGNKEY !== $_name && \strpos($_options, ',') !== false) { // Range
                    [$min, $max] = \explode(',', $_options);
                    $_options = ['min' => $min, 'max' => $max];
                } elseif (\preg_match('#^false$#i', $_options)) { // False as string
                    $_options = false;
                } elseif (\preg_match('#^true$#i', $_options)) { // True as string
                    $_options = true;
                }

                $_constraints[$_name] = $_options;
            } else {
                $_constraints[$_rule[0]] = true;
            }

            unset($_constraints[$index]);
        }

        return $_constraints;
    }

    private function getConstraintsCast(array $constraints): array
    {
        foreach ($constraints as $name => $value) {
            if (\is_int($name)) {
                $constraints[$value] = true;
                unset($constraints[$name]);
            } elseif ($name === Rule::CHECK || $name === Rule::LENGTH) {
                $constraints['min' . $name] = (int)$value['min'];
                $constraints['max' . $name] = (int)$value['max'];
                unset($constraints[$name]);
            } elseif ($name === Rule::FOREIGNKEY && \is_string($value)) {
                $constraints[$name] = $this->getFkOptions($value);
            } elseif ($name === Rule::DEFAULT && !\is_bool($value) && \preg_match('#^\d.\d#', $value)) {
                $constraints[$name] = (float)$value;
            } else {
                $constraints[$name] = \is_numeric($value) ? (int)$value : $value;
            }
        }

        return $constraints;
    }

    private function getFkOptions(string $constraint): array
    {
        $_vars = \explode(',', $constraint);
        $fkName = 'name';
        $fkId = 'id';

        switch (\count($_vars)) {
            case 3:
                [$fkTable, $fkName, $fkId] = $_vars;

                break;
            case 2:
                [$fkTable, $fkName] = $_vars;

                break;
            default:
                [$fkTable] = $_vars;

                break;
        }

        return [
            'table' => $fkTable,
            'name' => $fkName,
            'id' => $fkId,
        ];
    }
}


1		<?php declare(strict_types=1);
2		/*
3		* This file is part of FlexPHP.
4		*
5		* (c) Freddie Gar <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10		namespace FlexPHP\Schema;
11
12		use Exception;
13		use FlexPHP\Schema\Constants\Action;
14		use FlexPHP\Schema\Constants\Keyword;
15		use FlexPHP\Schema\Constants\Rule;
16		use FlexPHP\Schema\Exception\InvalidSchemaAttributeException;
17		use FlexPHP\Schema\Validations\SchemaAttributeLogicValidation;
18		use FlexPHP\Schema\Validations\SchemaAttributeValidation;
19
20		final class SchemaAttribute implements SchemaAttributeInterface
21		{
22		private string $name;
23
24		private string $dataType;
25
26		/**
27		* @var array<string, mixed>
28		*/
29		private array $constraints = [];
30
31		/**
32		* @param mixed $constraints
33		*/
34	289	public function __construct(string $name, string $dataType, $constraints = null)
35		{
36	289	$this->setName($name);
37	289	$this->setDataType($dataType);
38	289	$this->setConstraints($constraints);
39
40	289	$this->validate();
41	190	}
42
43	289	public function name(): string
44		{
45	289	return $this->name;
46		}
47
48	289	public function dataType(): string
49		{
50	289	return $this->dataType;
51		}
52
53	289	public function constraints(): array
54		{
55	289	return $this->constraints;
56		}
57
58	6	public function type(): ?string
59		{
60	6	return $this->constraints[Rule::TYPE] ?? null;
61		}
62
63	40	public function isRequired(): bool
64		{
65	40	return (bool)($this->constraints[Rule::REQUIRED] ?? false);
66		}
67
68	150	public function minLength(): ?int
69		{
70	150	return $this->constraints[Rule::MINLENGTH] ?? null;
71		}
72
73	145	public function maxLength(): ?int
74		{
75	145	return $this->constraints[Rule::MAXLENGTH] ?? null;
76		}
77
78	78	public function minCheck(): ?int
79		{
80	78	return $this->constraints[Rule::MINCHECK] ?? null;
81		}
82
83	77	public function maxCheck(): ?int
84		{
85	77	return $this->constraints[Rule::MAXCHECK] ?? null;
86		}
87
88	162	public function min(): ?int
89		{
90	162	return $this->constraints[Rule::MIN] ?? null;
91		}
92
93	159	public function max(): ?int
94		{
95	159	return $this->constraints[Rule::MAX] ?? null;
96		}
97
98	6	public function equalTo(): ?string
99		{
100	6	return $this->constraints[Rule::EQUALTO] ?? null;
101		}
102
103	255	public function isPk(): bool
104		{
105	255	return (bool)($this->constraints[Rule::PRIMARYKEY] ?? false);
106		}
107
108	250	public function isAi(): bool
109		{
110	250	return (bool)($this->constraints[Rule::AUTOINCREMENT] ?? false);
111		}
112
113	46	public function isFk(): bool
114		{
115	46	return (bool)($this->constraints[Rule::FOREIGNKEY] ?? false);
116		}
117
118	9	public function fkTable(): ?string
119		{
120	9	return $this->constraints[Rule::FOREIGNKEY]['table'] ?? null;
121		}
122
123	9	public function fkId(): ?string
124		{
125	9	return $this->constraints[Rule::FOREIGNKEY]['id'] ?? null;
126		}
127
128	9	public function fkName(): ?string
129		{
130	9	return $this->constraints[Rule::FOREIGNKEY]['name'] ?? null;
131		}
132
133	251	public function isCa(): bool
134		{
135	251	return (bool)($this->constraints[Rule::CREATEDAT] ?? false);
136		}
137
138	250	public function isUa(): bool
139		{
140	250	return (bool)($this->constraints[Rule::UPDATEDAT] ?? false);
141		}
142
143	248	public function isCb(): bool
144		{
145	248	return (bool)($this->constraints[Rule::CREATEDBY] ?? false);
146		}
147
148	246	public function isUb(): bool
149		{
150	246	return (bool)($this->constraints[Rule::UPDATEDBY] ?? false);
151		}
152
153	251	public function isBlameAt(): bool
154		{
155	251	return $this->isCa() \|\| $this->isUa();
156		}
157
158	248	public function isBlameBy(): bool
159		{
160	248	return $this->isCb() \|\| $this->isUb();
161		}
162
163	187	public function isBlame(): bool
164		{
165	187	return $this->isBlameAt() \|\| $this->isBlameBy();
166		}
167
168	3	public function filter(): ?string
169		{
170	3	return $this->constraints[Rule::FILTER] ?? null;
171		}
172
173	220	public function format(): ?string
174		{
175	220	return $this->constraints[Rule::FORMAT] ?? null;
176		}
177
178	13	public function isFormat(string $format): bool
179		{
180	13	return $this->format() === $format;
181		}
182
183	7	public function trim(): bool
184		{
185	7	return (bool)($this->constraints[Rule::TRIM] ?? false);
186		}
187
188	188	public function fchars(): ?int
189		{
190	188	return $this->constraints[Rule::FCHARS] ?? null;
191		}
192
193	183	public function fkcheck(): bool
194		{
195	183	return (bool)($this->constraints[Rule::FKCHECK] ?? false);
196		}
197
198	7	public function link(): bool
199		{
200	7	return (bool)($this->constraints[Rule::LINK] ?? false);
201		}
202
203	183	public function show(): array
204		{
205	183	$default = $this->isBlame()
206	42	? Action::READ
207	183	: Action::ALL;
208
209	183	$hideConstraint = $this->constraints[Rule::HIDE] ?? '';
210
211	183	if (\strpos($hideConstraint, Action::ALL) !== false) {
212	2	$default = \str_replace(Action::ALL, '', $default);
213		}
214
215	183	if (\strpos($hideConstraint, Action::READ) !== false) {
216	6	$default = \str_replace(Action::READ, '', $default);
217		}
218
219	183	return \explode(',', $this->constraints[Rule::SHOW] ?? $default);
220		}
221
222	175	public function hide(): array
223		{
224	175	$default = $this->isBlame()
225	38	? Action::INDEX . Action::CREATE . Action::UPDATE . Action::DELETE
226	175	: '';
227
228	175	return \explode(',', $this->constraints[Rule::HIDE] ?? $default);
229		}
230
231		/**
232		* @return mixed
233		*/
234	176	public function default()
235		{
236	176	if (!isset($this->constraints[Rule::DEFAULT])) {
237	157	return null;
238		}
239
240	19	return $this->constraints[Rule::DEFAULT];
241		}
242
243	183	public function usedIn(string $action): bool
244		{
245	183	return \in_array($action, $this->show(), true);
246		}
247
248	289	public function properties(): array
249		{
250		return [
251	289	Keyword::NAME => $this->name(),
252	289	Keyword::DATATYPE => $this->dataType(),
253	289	Keyword::CONSTRAINTS => $this->constraints(),
254		];
255		}
256
257	230	public function typeHint(): string
258		{
259		$typeHintByDataType = [
260	230	'smallint' => 'int',
261		'integer' => 'int',
262		'float' => 'float',
263		'double' => 'float',
264		'bool' => 'bool',
265		'boolean' => 'bool',
266		'date' => '\DateTime',
267		'date_immutable' => '\DateTimeImmutable',
268		'datetime' => '\DateTime',
269		'datetime_immutable' => '\DateTimeImmutable',
270		'datetimetz' => '\DateTime',
271		'datetimetz_immutable' => '\DateTimeImmutable',
272		'time' => '\DateTime',
273		'time_immutable' => '\DateTimeImmutable',
274		'array' => 'array',
275		'simple_array' => 'array',
276		'json' => 'array',
277		];
278
279	230	if (isset($typeHintByDataType[$this->dataType()])) {
280	141	return $typeHintByDataType[$this->dataType()];
281		}
282
283	103	return 'string';
284		}
285
286	289	private function validate(): void
287		{
288		try {
289	289	(new SchemaAttributeValidation($this->properties()))->validate();
290	282	(new SchemaAttributeLogicValidation($this))->validate();
291	100	} catch (Exception $exception) {
292	100	throw new InvalidSchemaAttributeException(
293	100	\sprintf('Attribute %s > %s', $this->name(), $exception->getMessage())
294		);
295		}
296	190	}
297
298	289	private function setName(string $name): void
299		{
300	289	$this->name = $name;
301	289	}
302
303	289	private function setDataType(string $dataType): void
304		{
305	289	$this->dataType = $dataType;
306	289	}
307
308		/**
309		* @param mixed $constraints
310		*/
311	289	private function setConstraints($constraints): void
312		{
313	289	if (!empty($constraints)) {
314	258	if (\is_string($constraints)) {
315	208	$this->setConstraintsFromString($constraints);
316		} else {
317	50	$this->setConstraintsFromArray($constraints);
318		}
319		}
320	289	}
321
322	208	private function setConstraintsFromString(string $constraints): void
323		{
324	208	$this->setConstraintsFromArray($this->getConstraintsFromString($constraints));
325	208	}
326
327	258	private function setConstraintsFromArray(array $constraints): void
328		{
329	258	$this->constraints = $this->getConstraintsCast($constraints);
330	258	}
331
332	208	private function getConstraintsFromString(string $constraints): array
333		{
334	208	$_constraints = \explode('\|', $constraints);
335
336		/** @var mixed $_constraint */
337	208	foreach ($_constraints as $index => $_constraint) {
338	208	$_rule = \explode(':', $_constraint);
339
340	208	if (\count($_rule) === 2) {
341	167	[$_name, $_options] = $_rule;
342
343	167	if (Rule::FOREIGNKEY !== $_name && \strpos($_options, ',') !== false) { // Range
344	3	[$min, $max] = \explode(',', $_options);
345	3	$_options = ['min' => $min, 'max' => $max];
346	164	} elseif (\preg_match('#^false$#i', $_options)) { // False as string
347	25	$_options = false;
348	153	} elseif (\preg_match('#^true$#i', $_options)) { // True as string
349	25	$_options = true;
350		}
351
352	167	$_constraints[$_name] = $_options;
353		} else {
354	73	$_constraints[$_rule[0]] = true;
355		}
356
357	208	unset($_constraints[$index]);
358		}
359
360	208	return $_constraints;
361		}
362
363	258	private function getConstraintsCast(array $constraints): array
364		{
365	258	foreach ($constraints as $name => $value) {
366	258	if (\is_int($name)) {
367	15	$constraints[$value] = true;
368	15	unset($constraints[$name]);
369	249	} elseif ($name === Rule::CHECK \|\| $name === Rule::LENGTH) {
370	4	$constraints['min' . $name] = (int)$value['min'];
371	4	$constraints['max' . $name] = (int)$value['max'];
372	4	unset($constraints[$name]);
373	245	} elseif ($name === Rule::FOREIGNKEY && \is_string($value)) {
374	29	$constraints[$name] = $this->getFkOptions($value);
375	238	} elseif ($name === Rule::DEFAULT && !\is_bool($value) && \preg_match('#^\d.\d#', $value)) {
376	2	$constraints[$name] = (float)$value;
377		} else {
378	236	$constraints[$name] = \is_numeric($value) ? (int)$value : $value;
379		}
380		}
381
382	258	return $constraints;
383		}
384
385	29	private function getFkOptions(string $constraint): array
386		{
387	29	$_vars = \explode(',', $constraint);
388	29	$fkName = 'name';
389	29	$fkId = 'id';
390
391	29	switch (\count($_vars)) {
392	29	case 3:
393	2	[$fkTable, $fkName, $fkId] = $_vars;
394
395	2	break;
396	27	case 2:
397	23	[$fkTable, $fkName] = $_vars;
398
399	23	break;
400		default:
401	4	[$fkTable] = $_vars;
402
403	4	break;
404		}
405
406		return [
407	29	'table' => $fkTable,
408	29	'name' => $fkName,
409	29	'id' => $fkId,
410		];
411		}
412		}
413

flexphp / flex-schema

Push — develop ( 59d538...3bdea0 )

SchemaAttribute::usedInIndex() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like