FormModel::isValidated() - Code Metrics - Inspection of "WIP: Ability to handle uploaded files" - yiisoft/form - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#222)

unknown

created 2022-08-03 19:43 UTC

FormModel::isValidated() A

↳ Parent: FormModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Yiisoft\Form;

use Closure;
use InvalidArgumentException;
use Psr\Http\Message\ServerRequestInterface;
use ReflectionClass;
use ReflectionNamedType;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Strings\Inflector;
use Yiisoft\Strings\StringHelper;
use Yiisoft\Validator\PostValidationHookInterface;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\RulesProviderInterface;

use function array_key_exists;
use function array_keys;
use function explode;
use function is_subclass_of;
use function property_exists;
use function str_contains;
use function strrchr;
use function substr;

/**
 * Form model represents an HTML form: its data, validation and presentation.
 */
abstract class FormModel implements FormModelInterface, PostValidationHookInterface, RulesProviderInterface
{
    private array $attributes;
    private ?FormErrorsInterface $formErrors = null;
    private ?Inflector $inflector = null;
    private array $rawData = [];
    private bool $validated = false;

    public function __construct()
    {
        $this->attributes = $this->collectAttributes();
    }

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

    public function getAttributeHint(string $attribute): string
    {
        $attributeHints = $this->getAttributeHints();
        $hint = $attributeHints[$attribute] ?? '';
        $nestedAttributeHint = $this->getNestedAttributeValue('getAttributeHint', $attribute);

        return $nestedAttributeHint !== '' ? $nestedAttributeHint : $hint;
    }

    /**
     * @return string[]
     */
    public function getAttributeHints(): array
    {
        return [];
    }

    public function getAttributeLabel(string $attribute): string
    {
        $label = $this->generateAttributeLabel($attribute);
        $labels = $this->getAttributeLabels();

        if (array_key_exists($attribute, $labels)) {
            $label = $labels[$attribute];
        }

        $nestedAttributeLabel = $this->getNestedAttributeValue('getAttributeLabel', $attribute);

        return $nestedAttributeLabel !== '' ? $nestedAttributeLabel : $label;
    }

    /**
     * @return string[]
     */
    public function getAttributeLabels(): array
    {
        return [];
    }

    public function getAttributePlaceholder(string $attribute): string
    {
        $attributePlaceHolders = $this->getAttributePlaceholders();
        $placeholder = $attributePlaceHolders[$attribute] ?? '';
        $nestedAttributePlaceholder = $this->getNestedAttributeValue('getAttributePlaceholder', $attribute);

        return $nestedAttributePlaceholder !== '' ? $nestedAttributePlaceholder : $placeholder;
    }

    /**
     * @return string[]
     */
    public function getAttributePlaceholders(): array
    {
        return [];
    }

    public function getAttributeCastValue(string $attribute): mixed
    {
        return $this->readProperty($attribute);
    }

    public function getAttributeValue(string $attribute): mixed
    {
        return $this->rawData[$attribute] ?? $this->getAttributeCastValue($attribute);
    }

    /**
     * @return FormErrorsInterface Get FormErrors object.
     */
    public function getFormErrors(): FormErrorsInterface
    {
        if ($this->formErrors === null) {
            $this->formErrors = new FormErrors();
        }

        return $this->formErrors;

    }

    /**
     * @return string Returns classname without a namespace part or empty string when class is anonymous
     */
    public function getFormName(): string
    {
        if (str_contains(static::class, '@anonymous')) {
            return '';
        }

        $className = strrchr(static::class, '\\');
        if ($className === false) {
            return static::class;
        }

        return substr($className, 1);
    }

    public function hasAttribute(string $attribute): bool
    {
        [$attribute, $nested] = $this->getNestedAttribute($attribute);

        return $nested !== null || array_key_exists($attribute, $this->attributes);
    }

    public function handleRequest(ServerRequestInterface $request, ?string $formName = null): bool
    {
        $parsedBody = $request->getParsedBody();
        if (is_array($parsedBody)) {
            $data = ArrayHelper::merge(
                $parsedBody,
                $request->getUploadedFiles()
            );
        } else {
            $data = $request->getUploadedFiles();
        }

        return $this->load($data, $formName);
    }

    public function load(array|object|null $data, ?string $formName = null): bool
    {
        if (!is_array($data)) {

            return false;
        }

        $this->rawData = [];
        $scope = $formName ?? $this->getFormName();

        if ($scope === '' && !empty($data)) {
            $this->rawData = $data;
        } elseif (isset($data[$scope])) {
            if (!is_array($data[$scope])) {
                return false;
            }
            $this->rawData = $data[$scope];
        }

        /**
         * @var mixed $value
         */
        foreach ($this->rawData as $name => $value) {
            $this->setAttribute((string)$name, $value);
        }

        return $this->rawData !== [];
    }

    public function setAttribute(string $name, mixed $value): void
    {
        if ($this->hasAttribute($name) === false) {
            return;
        }

        [$realName] = $this->getNestedAttribute($name);

        if ($value !== null) {
            /** @var string $expectedType */
            $expectedType = $this->attributes[$realName];
            if ($expectedType === 'Yiisoft\Form\Files') {
                try {
                    $value = new Files($value);
                } catch (InvalidArgumentException) {
                    return;
                }
            } else {
                $value = match ($expectedType) {
                    'bool' => (bool)$value,
                    'float' => (float)$value,
                    'int' => (int)$value,
                    'string' => (string)$value,
                    default => $value,
                };
            }
        }

        $this->writeProperty($name, $value);
    }

    public function processValidationResult(Result $result): void
    {
        foreach ($result->getErrorMessagesIndexedByAttribute() as $attribute => $errors) {
            if ($this->hasAttribute($attribute)) {
                $this->addErrors([$attribute => $errors]);
            }
        }

        $this->validated = true;
    }

    public function getRules(): array
    {
        return [];
    }

    public function setFormErrors(FormErrorsInterface $formErrors): void
    {
        $this->formErrors = $formErrors;
    }

    /**
     * Returns the list of attribute types indexed by attribute names.
     *
     * By default, this method returns all non-static properties of the class.
     *
     * @return array list of attribute types indexed by attribute names.
     */
    protected function collectAttributes(): array
    {
        $class = new ReflectionClass($this);
        $attributes = [];

        foreach ($class->getProperties() as $property) {
            if ($property->isStatic()) {
                continue;
            }

            /** @var ReflectionNamedType|null $type */
            $type = $property->getType();

            $attributes[$property->getName()] = $type !== null ? $type->getName() : '';
        }

        return $attributes;
    }

    /**
     * @psalm-param  non-empty-array<string, non-empty-list<string>> $items
     */
    private function addErrors(array $items): void
    {
        foreach ($items as $attribute => $errors) {
            foreach ($errors as $error) {
                $this
                    ->getFormErrors()
                    ->addError($attribute, $error);
            }
        }
    }

    private function getInflector(): Inflector
    {
        if ($this->inflector === null) {
            $this->inflector = new Inflector();
        }
        return $this->inflector;

    }

    /**
     * Generates a user-friendly attribute label based on the give attribute name.
     *
     * This is done by replacing underscores, dashes and dots with blanks and changing the first letter of each word to
     * upper case.
     *
     * For example, 'department_name' or 'DepartmentName' will generate 'Department Name'.
     *
     * @param string $name the column name.
     *
     * @return string the attribute label.
     */
    private function generateAttributeLabel(string $name): string
    {
        return StringHelper::uppercaseFirstCharacterInEachWord(
            $this
                ->getInflector()
                ->toWords($name)
        );
    }

    private function readProperty(string $attribute): mixed
    {
        $class = static::class;

        [$attribute, $nested] = $this->getNestedAttribute($attribute);

        if (!property_exists($class, $attribute)) {
            throw new InvalidArgumentException("Undefined property: \"$class::$attribute\".");
        }

        /** @psalm-suppress MixedMethodCall */
        $getter = static function (FormModelInterface $class, string $attribute, ?string $nested): mixed {
            return match ($nested) {
                null => $class->$attribute,
                default => $class->$attribute->getAttributeCastValue($nested),
            };
        };

        $getter = Closure::bind($getter, null, $this);

        /** @var Closure $getter */
        return $getter($this, $attribute, $nested);
    }

    private function writeProperty(string $attribute, mixed $value): void
    {
        [$attribute, $nested] = $this->getNestedAttribute($attribute);

        /** @psalm-suppress MixedMethodCall */
        $setter = static function (FormModelInterface $class, string $attribute, mixed $value, ?string $nested): void {
            match ($nested) {
                null => $class->$attribute = $value,
                default => $class->$attribute->setAttribute($nested, $value),
            };
        };

        $setter = Closure::bind($setter, null, $this);

        /** @var Closure $setter */
        $setter($this, $attribute, $value, $nested);
    }

    /**
     * @return string[]
     *
     * @psalm-return array{0: string, 1: null|string}
     */
    private function getNestedAttribute(string $attribute): array
    {
        if (!str_contains($attribute, '.')) {
            return [$attribute, null];
        }

        [$attribute, $nested] = explode('.', $attribute, 2);

        /** @var string */
        $attributeNested = $this->attributes[$attribute] ?? '';

        if (!is_subclass_of($attributeNested, self::class)) {
            throw new InvalidArgumentException("Attribute \"$attribute\" is not a nested attribute.");
        }

        if (!property_exists($attributeNested, $nested)) {
            throw new InvalidArgumentException("Undefined property: \"$attributeNested::$nested\".");
        }

        return [$attribute, $nested];
    }

    private function getNestedAttributeValue(string $method, string $attribute): string
    {
        $result = '';

        [$attribute, $nested] = $this->getNestedAttribute($attribute);

        if ($nested !== null) {
            /** @var FormModelInterface $attributeNestedValue */
            $attributeNestedValue = $this->getAttributeCastValue($attribute);
            /** @var string */
            $result = $attributeNestedValue->$method($nested);
        }

        return $result;
    }

    public function isValidated(): bool
    {
        return $this->validated;
    }

    public function getData(): mixed
    {
        return $this->rawData;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Form;
6
7		use Closure;
8		use InvalidArgumentException;
9		use Psr\Http\Message\ServerRequestInterface;
10		use ReflectionClass;
11		use ReflectionNamedType;
12		use Yiisoft\Arrays\ArrayHelper;
13		use Yiisoft\Strings\Inflector;
14		use Yiisoft\Strings\StringHelper;
15		use Yiisoft\Validator\PostValidationHookInterface;
16		use Yiisoft\Validator\Result;
17		use Yiisoft\Validator\RulesProviderInterface;
18
19		use function array_key_exists;
20		use function array_keys;
21		use function explode;
22		use function is_subclass_of;
23		use function property_exists;
24		use function str_contains;
25		use function strrchr;
26		use function substr;
27
28		/**
29		* Form model represents an HTML form: its data, validation and presentation.
30		*/
31		abstract class FormModel implements FormModelInterface, PostValidationHookInterface, RulesProviderInterface
32		{
33		private array $attributes;
34		private ?FormErrorsInterface $formErrors = null;
35		private ?Inflector $inflector = null;
36		private array $rawData = [];
37		private bool $validated = false;
38
39	560	public function __construct()
40		{
41	560	$this->attributes = $this->collectAttributes();
42		}
43
44	1	public function attributes(): array
45		{
46	1	return array_keys($this->attributes);
47		}
48
49	403	public function getAttributeHint(string $attribute): string
50		{
51	403	$attributeHints = $this->getAttributeHints();
52	403	$hint = $attributeHints[$attribute] ?? '';
53	403	$nestedAttributeHint = $this->getNestedAttributeValue('getAttributeHint', $attribute);
54
55	403	return $nestedAttributeHint !== '' ? $nestedAttributeHint : $hint;
56		}
57
58		/**
59		* @return string[]
60		*/
61	99	public function getAttributeHints(): array
62		{
63	99	return [];
64		}
65
66	202	public function getAttributeLabel(string $attribute): string
67		{
68	202	$label = $this->generateAttributeLabel($attribute);
69	202	$labels = $this->getAttributeLabels();
70
71	202	if (array_key_exists($attribute, $labels)) {
72	180	$label = $labels[$attribute];
73		}
74
75	202	$nestedAttributeLabel = $this->getNestedAttributeValue('getAttributeLabel', $attribute);
76
77	202	return $nestedAttributeLabel !== '' ? $nestedAttributeLabel : $label;
78		}
79
80		/**
81		* @return string[]
82		*/
83	3	public function getAttributeLabels(): array
84		{
85	3	return [];
86		}
87
88	183	public function getAttributePlaceholder(string $attribute): string
89		{
90	183	$attributePlaceHolders = $this->getAttributePlaceholders();
91	183	$placeholder = $attributePlaceHolders[$attribute] ?? '';
92	183	$nestedAttributePlaceholder = $this->getNestedAttributeValue('getAttributePlaceholder', $attribute);
93
94	183	return $nestedAttributePlaceholder !== '' ? $nestedAttributePlaceholder : $placeholder;
95		}
96
97		/**
98		* @return string[]
99		*/
100	122	public function getAttributePlaceholders(): array
101		{
102	122	return [];
103		}
104
105	430	public function getAttributeCastValue(string $attribute): mixed
106		{
107	430	return $this->readProperty($attribute);
108		}
109
110	435	public function getAttributeValue(string $attribute): mixed
111		{
112	435	return $this->rawData[$attribute] ?? $this->getAttributeCastValue($attribute);
113		}
114
115		/**
116		* @return FormErrorsInterface Get FormErrors object.
117		*/
118	433	public function getFormErrors(): FormErrorsInterface
119		{
120	433	if ($this->formErrors === null) {
121	432	$this->formErrors = new FormErrors();
122		}
123
124	433	return $this->formErrors;
		0 ignored issues – show Bug Best Practice introduced 2022-02-11 20:01 UTC by Report Bug Copy Issue Report The expression `return $this->formErrors` could return the type `null` which is incompatible with the type-hinted return `Yiisoft\Form\FormErrorsInterface`. Consider adding an additional type-check to rule them out. Loading history...
125		}
126
127		/**
128		* @return string Returns classname without a namespace part or empty string when class is anonymous
129		*/
130	430	public function getFormName(): string
131		{
132	430	if (str_contains(static::class, '@anonymous')) {
133	8	return '';
134		}
135
136	423	$className = strrchr(static::class, '\\');
137	423	if ($className === false) {
138	1	return static::class;
139		}
140
141	422	return substr($className, 1);
142		}
143
144	520	public function hasAttribute(string $attribute): bool
145		{
146	520	[$attribute, $nested] = $this->getNestedAttribute($attribute);
147
148	519	return $nested !== null \|\| array_key_exists($attribute, $this->attributes);
149		}
150
151	1	public function handleRequest(ServerRequestInterface $request, ?string $formName = null): bool
152		{
153	1	$parsedBody = $request->getParsedBody();
154	1	if (is_array($parsedBody)) {
155	1	$data = ArrayHelper::merge(
156		$parsedBody,
157	1	$request->getUploadedFiles()
158		);
159		} else {
160		$data = $request->getUploadedFiles();
161		}
162
163	1	return $this->load($data, $formName);
164		}
165
166	22	public function load(array\|object\|null $data, ?string $formName = null): bool
167		{
168	22	if (!is_array($data)) {
		0 ignored issues – show introduced 2022-06-06 10:25 UTC by Report Bug Copy Issue Report The condition `is_array($data)` is always `true`. Loading history...
169	2	return false;
170		}
171
172	20	$this->rawData = [];
173	20	$scope = $formName ?? $this->getFormName();
174
175	20	if ($scope === '' && !empty($data)) {
176	7	$this->rawData = $data;
177	14	} elseif (isset($data[$scope])) {
178	12	if (!is_array($data[$scope])) {
179		return false;
180		}
181	12	$this->rawData = $data[$scope];
182		}
183
184		/**
185		* @var mixed $value
186		*/
187	20	foreach ($this->rawData as $name => $value) {
188	19	$this->setAttribute((string)$name, $value);
189		}
190
191	20	return $this->rawData !== [];
192		}
193
194	22	public function setAttribute(string $name, mixed $value): void
195		{
196	22	if ($this->hasAttribute($name) === false) {
197	2	return;
198		}
199
200	21	[$realName] = $this->getNestedAttribute($name);
201
202	21	if ($value !== null) {
203		/** @var string $expectedType */
204	19	$expectedType = $this->attributes[$realName];
205	19	if ($expectedType === 'Yiisoft\Form\Files') {
206		try {
207	3	$value = new Files($value);
208	2	} catch (InvalidArgumentException) {
209	3	return;
210		}
211		} else {
212	17	$value = match ($expectedType) {
213	3	'bool' => (bool)$value,
214	1	'float' => (float)$value,
215	2	'int' => (int)$value,
216	15	'string' => (string)$value,
217	3	default => $value,
218		};
219		}
220		}
221
222	20	$this->writeProperty($name, $value);
223		}
224
225	96	public function processValidationResult(Result $result): void
226		{
227	96	foreach ($result->getErrorMessagesIndexedByAttribute() as $attribute => $errors) {
228	96	if ($this->hasAttribute($attribute)) {
229	96	$this->addErrors([$attribute => $errors]);
230		}
231		}
232
233	96	$this->validated = true;
234		}
235
236	1	public function getRules(): array
237		{
238	1	return [];
239		}
240
241	1	public function setFormErrors(FormErrorsInterface $formErrors): void
242		{
243	1	$this->formErrors = $formErrors;
244		}
245
246		/**
247		* Returns the list of attribute types indexed by attribute names.
248		*
249		* By default, this method returns all non-static properties of the class.
250		*
251		* @return array list of attribute types indexed by attribute names.
252		*/
253	560	protected function collectAttributes(): array
254		{
255	560	$class = new ReflectionClass($this);
256	560	$attributes = [];
257
258	560	foreach ($class->getProperties() as $property) {
259	555	if ($property->isStatic()) {
260	40	continue;
261		}
262
263		/** @var ReflectionNamedType\|null $type */
264	555	$type = $property->getType();
265
266	555	$attributes[$property->getName()] = $type !== null ? $type->getName() : '';
267		}
268
269	560	return $attributes;
270		}
271
272		/**
273		* @psalm-param non-empty-array<string, non-empty-list<string>> $items
274		*/
275	96	private function addErrors(array $items): void
276		{
277	96	foreach ($items as $attribute => $errors) {
278	96	foreach ($errors as $error) {
279		$this
280	96	->getFormErrors()
281	96	->addError($attribute, $error);
282		}
283		}
284		}
285
286	202	private function getInflector(): Inflector
287		{
288	202	if ($this->inflector === null) {
289	202	$this->inflector = new Inflector();
290		}
291	202	return $this->inflector;
		0 ignored issues – show Bug Best Practice introduced 2020-10-01 12:42 UTC by Report Bug Copy Issue Report The expression `return $this->inflector` could return the type `null` which is incompatible with the type-hinted return `Yiisoft\Strings\Inflector`. Consider adding an additional type-check to rule them out. Loading history...
292		}
293
294		/**
295		* Generates a user-friendly attribute label based on the give attribute name.
296		*
297		* This is done by replacing underscores, dashes and dots with blanks and changing the first letter of each word to
298		* upper case.
299		*
300		* For example, 'department_name' or 'DepartmentName' will generate 'Department Name'.
301		*
302		* @param string $name the column name.
303		*
304		* @return string the attribute label.
305		*/
306	202	private function generateAttributeLabel(string $name): string
307		{
308	202	return StringHelper::uppercaseFirstCharacterInEachWord(
309		$this
310	202	->getInflector()
311	202	->toWords($name)
312		);
313		}
314
315	430	private function readProperty(string $attribute): mixed
316		{
317	430	$class = static::class;
318
319	430	[$attribute, $nested] = $this->getNestedAttribute($attribute);
320
321	429	if (!property_exists($class, $attribute)) {
322	1	throw new InvalidArgumentException("Undefined property: \"$class::$attribute\".");
323		}
324
325		/** @psalm-suppress MixedMethodCall */
326	428	$getter = static function (FormModelInterface $class, string $attribute, ?string $nested): mixed {
327	428	return match ($nested) {
328	428	null => $class->$attribute,
329	428	default => $class->$attribute->getAttributeCastValue($nested),
330		};
331		};
332
333	428	$getter = Closure::bind($getter, null, $this);
334
335		/** @var Closure $getter */
336	428	return $getter($this, $attribute, $nested);
337		}
338
339	20	private function writeProperty(string $attribute, mixed $value): void
340		{
341	20	[$attribute, $nested] = $this->getNestedAttribute($attribute);
342
343		/** @psalm-suppress MixedMethodCall */
344	20	$setter = static function (FormModelInterface $class, string $attribute, mixed $value, ?string $nested): void {
345	20	match ($nested) {
346	20	null => $class->$attribute = $value,
347	2	default => $class->$attribute->setAttribute($nested, $value),
348		};
349		};
350
351	20	$setter = Closure::bind($setter, null, $this);
352
353		/** @var Closure $setter */
354	20	$setter($this, $attribute, $value, $nested);
355		}
356
357		/**
358		* @return string[]
359		*
360		* @psalm-return array{0: string, 1: null\|string}
361		*/
362	530	private function getNestedAttribute(string $attribute): array
363		{
364	530	if (!str_contains($attribute, '.')) {
365	528	return [$attribute, null];
366		}
367
368	9	[$attribute, $nested] = explode('.', $attribute, 2);
369
370		/** @var string */
371	9	$attributeNested = $this->attributes[$attribute] ?? '';
372
373	9	if (!is_subclass_of($attributeNested, self::class)) {
374	1	throw new InvalidArgumentException("Attribute \"$attribute\" is not a nested attribute.");
375		}
376
377	8	if (!property_exists($attributeNested, $nested)) {
378	1	throw new InvalidArgumentException("Undefined property: \"$attributeNested::$nested\".");
379		}
380
381	7	return [$attribute, $nested];
382		}
383
384	438	private function getNestedAttributeValue(string $method, string $attribute): string
385		{
386	438	$result = '';
387
388	438	[$attribute, $nested] = $this->getNestedAttribute($attribute);
389
390	438	if ($nested !== null) {
391		/** @var FormModelInterface $attributeNestedValue */
392	3	$attributeNestedValue = $this->getAttributeCastValue($attribute);
393		/** @var string */
394	3	$result = $attributeNestedValue->$method($nested);
395		}
396
397	438	return $result;
398		}
399
400	333	public function isValidated(): bool
401		{
402	333	return $this->validated;
403		}
404
405	1	public function getData(): mixed
406		{
407	1	return $this->rawData;
408		}
409		}
410

yiisoft / form

Pull Request — master (#222)

FormModel::isValidated() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like