ObjectDataSet::canCache() - Code Metrics - Inspection of "Set Psalm level to 1" - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#364)

by Alexander

created 2022-11-12 13:41 UTC

ObjectDataSet::canCache() A

↳ Parent: ObjectDataSet

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
eloc	1
c	0
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\DataSet;

use JetBrains\PhpStorm\ArrayShape;
use JetBrains\PhpStorm\ExpectedValues;
use ReflectionAttribute;
use ReflectionObject;
use ReflectionProperty;
use Yiisoft\Validator\AttributeEventInterface;
use Yiisoft\Validator\DataSetInterface;
use Yiisoft\Validator\RuleInterface;
use Yiisoft\Validator\RulesProviderInterface;

use function array_key_exists;

/**
 * This data set makes use of attributes introduced in PHP 8. It simplifies rules configuration process, especially for
 * nested data and relations. Please refer to the guide for examples.
 *
 * @link https://www.php.net/manual/en/language.attributes.overview.php
 */
final class ObjectDataSet implements RulesProviderInterface, DataSetInterface
{
    private bool $dataSetProvided;
    private bool $rulesProvided;

    /**
     * @var array<string, array<string, mixed>>
     */
    #[ArrayShape([
        [
            'rules' => 'iterable',
            'reflectionAttributes' => 'array',
        ],
    ])]
    private static array $cache = [];
    private string|null $cacheKey = null;

    public function __construct(
        private object $object,
        private int $propertyVisibility = ReflectionProperty::IS_PRIVATE |
        ReflectionProperty::IS_PROTECTED |
        ReflectionProperty::IS_PUBLIC,
        private bool $useCache = true
    ) {
        $this->dataSetProvided = $this->object instanceof DataSetInterface;
        $this->rulesProvided = $this->object instanceof RulesProviderInterface;

        if ($this->canCache()) {
            $this->cacheKey = $this->object::class . '_' . $this->propertyVisibility;
        }
    }

    public function getRules(): iterable
    {
        if ($this->rulesProvided) {
            /** @var RulesProviderInterface $object */
            $object = $this->object;

            return $object->getRules();
        }

        // Providing data set assumes object has its own attributes and rules getting logic. So further parsing of
        // Reflection properties and rules is skipped intentionally.
        if ($this->dataSetProvided) {
            return [];
        }

        if ($this->hasCacheItem('rules')) {
            /** @var array<string, RuleInterface> */
            return $this->getCacheItem('rules');
        }

        $rules = [];
        foreach ($this->getReflectionProperties() as $property) {
            // TODO: use Generator to collect attributes.
            $attributes = $property->getAttributes(RuleInterface::class, ReflectionAttribute::IS_INSTANCEOF);
            foreach ($attributes as $attribute) {
                $rule = $attribute->newInstance();
                $rules[$property->getName()][] = $rule;

                if ($rule instanceof AttributeEventInterface) {
                    $rule->afterInitAttribute($this);
                }
            }
        }

        if ($this->canCache()) {
            $this->setCacheItem('rules', $rules);
        }

        return $rules;
    }

    public function getObject(): object
    {
        return $this->object;
    }

    public function getAttributeValue(string $attribute): mixed
    {
        if ($this->dataSetProvided) {
            /** @var DataSetInterface $object */
            $object = $this->object;

            return $object->getAttributeValue($attribute);
        }

        return ($this->getReflectionProperties()[$attribute] ?? null)?->getValue($this->getObject());
    }

    public function hasAttribute(string $attribute): bool
    {
        if (!$this->dataSetProvided) {
            return array_key_exists($attribute, $this->getReflectionProperties());
        }

        /** @var DataSetInterface $object */
        $object = $this->object;

        return $object->hasAttribute($attribute);
    }

    public function getData(): mixed
    {
        if ($this->dataSetProvided) {
            /** @var DataSetInterface $object */
            $object = $this->object;

            return $object->getData();
        }

        $data = [];
        foreach ($this->getReflectionProperties() as $name => $property) {
            /** @psalm-suppress MixedAssignment */
            $data[$name] = $property->getValue($this->object);
        }

        return $data;
    }

    /**
     * @return array<string, ReflectionProperty>
     */
    private function getReflectionProperties(): array
    {
        if ($this->hasCacheItem('reflectionProperties')) {
            /** @var array<string, ReflectionProperty> */
            return $this->getCacheItem('reflectionProperties');
        }

        $reflection = new ReflectionObject($this->object);
        $reflectionProperties = [];

        foreach ($reflection->getProperties($this->propertyVisibility) as $property) {
            if (PHP_VERSION_ID < 80100) {
                $property->setAccessible(true);
            }

            $reflectionProperties[$property->getName()] = $property;
        }

        if ($this->canCache()) {
            $this->setCacheItem('reflectionProperties', $reflectionProperties);
        }

        return $reflectionProperties;
    }

    private function canCache(): bool
    {
        return $this->useCache === true;
    }

    private function hasCacheItem(#[ExpectedValues(['rules', 'reflectionProperties'])] string $name): bool
    {
        if ($this->cacheKey === null) {
            return false;
        }

        if (!array_key_exists($this->cacheKey, self::$cache)) {
            return false;
        }

        return array_key_exists($name, self::$cache[$this->cacheKey]);
    }

    /**
     * @psalm-suppress MixedInferredReturnType
     * @psalm-suppress MixedReturnStatement
     */
    private function getCacheItem(#[ExpectedValues(['rules', 'reflectionProperties'])] string $name): array
    {
        /** @psalm-suppress PossiblyNullArrayOffset */
        return self::$cache[$this->cacheKey][$name];
    }

    private function setCacheItem(#[ExpectedValues(['rules', 'reflectionProperties'])] string $name, array $value): void
    {
        /**
         * @psalm-suppress PossiblyNullArrayOffset
         * @psalm-suppress MixedAssignment
         */
        self::$cache[$this->cacheKey][$name] = $value;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Validator\DataSet;
6
7		use JetBrains\PhpStorm\ArrayShape;
8		use JetBrains\PhpStorm\ExpectedValues;
9		use ReflectionAttribute;
10		use ReflectionObject;
11		use ReflectionProperty;
12		use Yiisoft\Validator\AttributeEventInterface;
13		use Yiisoft\Validator\DataSetInterface;
14		use Yiisoft\Validator\RuleInterface;
15		use Yiisoft\Validator\RulesProviderInterface;
16
17		use function array_key_exists;
18
19		/**
20		* This data set makes use of attributes introduced in PHP 8. It simplifies rules configuration process, especially for
21		* nested data and relations. Please refer to the guide for examples.
22		*
23		* @link https://www.php.net/manual/en/language.attributes.overview.php
24		*/
25		final class ObjectDataSet implements RulesProviderInterface, DataSetInterface
26		{
27		private bool $dataSetProvided;
28		private bool $rulesProvided;
29
30		/**
31		* @var array<string, array<string, mixed>>
32		*/
33		#[ArrayShape([
34		[
35		'rules' => 'iterable',
36		'reflectionAttributes' => 'array',
37		],
38		])]
39		private static array $cache = [];
40		private string\|null $cacheKey = null;
41
42	49	public function __construct(
43		private object $object,
44		private int $propertyVisibility = ReflectionProperty::IS_PRIVATE \|
45		ReflectionProperty::IS_PROTECTED \|
46		ReflectionProperty::IS_PUBLIC,
47		private bool $useCache = true
48		) {
49	49	$this->dataSetProvided = $this->object instanceof DataSetInterface;
50	49	$this->rulesProvided = $this->object instanceof RulesProviderInterface;
51
52	49	if ($this->canCache()) {
53	49	$this->cacheKey = $this->object::class . '_' . $this->propertyVisibility;
54		}
55		}
56
57	53	public function getRules(): iterable
58		{
59	53	if ($this->rulesProvided) {
60		/** @var RulesProviderInterface $object */
61	13	$object = $this->object;
62
63	13	return $object->getRules();
64		}
65
66		// Providing data set assumes object has its own attributes and rules getting logic. So further parsing of
67		// Reflection properties and rules is skipped intentionally.
68	40	if ($this->dataSetProvided) {
69	5	return [];
70		}
71
72	35	if ($this->hasCacheItem('rules')) {
73		/** @var array<string, RuleInterface> */
74	7	return $this->getCacheItem('rules');
75		}
76
77	30	$rules = [];
78	30	foreach ($this->getReflectionProperties() as $property) {
79		// TODO: use Generator to collect attributes.
80	29	$attributes = $property->getAttributes(RuleInterface::class, ReflectionAttribute::IS_INSTANCEOF);
81	29	foreach ($attributes as $attribute) {
82	27	$rule = $attribute->newInstance();
83	27	$rules[$property->getName()][] = $rule;
84
85	27	if ($rule instanceof AttributeEventInterface) {
86	3	$rule->afterInitAttribute($this);
87		}
88		}
89		}
90
91	29	if ($this->canCache()) {
92	29	$this->setCacheItem('rules', $rules);
93		}
94
95	29	return $rules;
96		}
97
98	39	public function getObject(): object
99		{
100	39	return $this->object;
101		}
102
103	45	public function getAttributeValue(string $attribute): mixed
104		{
105	45	if ($this->dataSetProvided) {
106		/** @var DataSetInterface $object */
107	8	$object = $this->object;
108
109	8	return $object->getAttributeValue($attribute);
110		}
111
112	37	return ($this->getReflectionProperties()[$attribute] ?? null)?->getValue($this->getObject());
113		}
114
115	27	public function hasAttribute(string $attribute): bool
116		{
117	27	if (!$this->dataSetProvided) {
118	27	return array_key_exists($attribute, $this->getReflectionProperties());
119		}
120
121		/** @var DataSetInterface $object */
122		$object = $this->object;
123
124		return $object->hasAttribute($attribute);
125		}
126
127	34	public function getData(): mixed
128		{
129	34	if ($this->dataSetProvided) {
130		/** @var DataSetInterface $object */
131	13	$object = $this->object;
132
133	13	return $object->getData();
134		}
135
136	21	$data = [];
137	21	foreach ($this->getReflectionProperties() as $name => $property) {
138		/** @psalm-suppress MixedAssignment */
139	17	$data[$name] = $property->getValue($this->object);
140		}
141
142	21	return $data;
143		}
144
145		/**
146		* @return array<string, ReflectionProperty>
147		*/
148	57	private function getReflectionProperties(): array
149		{
150	57	if ($this->hasCacheItem('reflectionProperties')) {
151		/** @var array<string, ReflectionProperty> */
152	40	return $this->getCacheItem('reflectionProperties');
153		}
154
155	43	$reflection = new ReflectionObject($this->object);
156	43	$reflectionProperties = [];
157
158	43	foreach ($reflection->getProperties($this->propertyVisibility) as $property) {
159	41	if (PHP_VERSION_ID < 80100) {
160	41	$property->setAccessible(true);
161		}
162
163	41	$reflectionProperties[$property->getName()] = $property;
164		}
165
166	43	if ($this->canCache()) {
167	42	$this->setCacheItem('reflectionProperties', $reflectionProperties);
168		}
169
170	43	return $reflectionProperties;
171		}
172
173	54	private function canCache(): bool
174		{
175	54	return $this->useCache === true;
176		}
177
178	57	private function hasCacheItem(#[ExpectedValues(['rules', 'reflectionProperties'])] string $name): bool
179		{
180	57	if ($this->cacheKey === null) {
181	1	return false;
182		}
183
184	56	if (!array_key_exists($this->cacheKey, self::$cache)) {
185	42	return false;
186		}
187
188	40	return array_key_exists($name, self::$cache[$this->cacheKey]);
189		}
190
191		/**
192		* @psalm-suppress MixedInferredReturnType
193		* @psalm-suppress MixedReturnStatement
194		*/
195	40	private function getCacheItem(#[ExpectedValues(['rules', 'reflectionProperties'])] string $name): array
196		{
197		/** @psalm-suppress PossiblyNullArrayOffset */
198	40	return self::$cache[$this->cacheKey][$name];
199		}
200
201	42	private function setCacheItem(#[ExpectedValues(['rules', 'reflectionProperties'])] string $name, array $value): void
202		{
203		/**
204		* @psalm-suppress PossiblyNullArrayOffset
205		* @psalm-suppress MixedAssignment
206		*/
207	42	self::$cache[$this->cacheKey][$name] = $value;
208		}
209		}
210

yiisoft / validator

Pull Request — master (#364)

ObjectDataSet::canCache() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like