PropertyMetadata::isDefaultValue() - Code Metrics - Inspection of "Fix the null value as default on typed properties..." - b2pweb/bdf-serializer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#11)

by Sébastien

created 2022-10-26 08:22 UTC

PropertyMetadata::isDefaultValue() A

↳ Parent: PropertyMetadata

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes

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

<?php

namespace Bdf\Serializer\Metadata;

use Bdf\Serializer\PropertyAccessor\PropertyAccessorInterface;
use Bdf\Serializer\Type\Type;

/**
 * PropertyMetadata
 *
 * @author  Seb
 *
 * @psalm-suppress PropertyNotSetInConstructor
 */
class PropertyMetadata
{
    /**
     * The owner class name
     *
     * @var string
     */
    public $class;

    /**
     * The property name
     *
     * @var string
     */
    public $name;

    /**
     * The property alias
     *
     * @var string
     */
    public $alias;

    /**
     * The property type infos
     *
     * @var Type
     */
    public $type;

    /**
     * The property groups
     *
     * @var array
     */
    public $groups = [];

    /**
     * The property accessor
     *
     * @var PropertyAccessorInterface
     */
    public $accessor;

    /**
     * The version when the property has been added.
     *
     * @var string|null
     */
    public $since;

    /**
     * The version when the property has been removed.
     *
     * @var string|null
     */
    public $until;

    /**
     * The read only state of the property.
     *
     * @var bool
     */
    public $readOnly = false;

    /**
     * The inline state of the property.
     *
     * @var bool
     */
    public $inline = false;

    /**
     * The default value of the property.
     *
     * @var mixed
     */
    public $defaultValue;

    /**
     * A flag to know if the property has a default value.
     *
     * @var bool
     */
    private $hasDefaultValue = false;

    /**
     * Flag to know if the property used php type.
     *
     * @var bool
     */
    public $isPhpTyped = false;

    /**
     * The context options for normalization.
     *
     * @var null|array
     */
    public $normalizationOptions;

    /**
     * The context options for denormalization.
     *
     * @var null|array
     */
    public $denormalizationOptions;

    /**
     * PropertyMetadata constructor.
     *
     * @param string $class
     * @param string $name
     */
    public function __construct(string $class, string $name)
    {
        $this->class = $class;
        $this->name = $name;
    }

    /**
     * Check whether the property should be skipped
     *
     * @param array $groups
     *
     * @return boolean  True if the property has one of the groups
     */
    public function hasGroups(array $groups)
    {
        foreach ($groups as $group) {
            if (isset($this->groups[$group])) {
                return true;
            }
        }

        return false;
    }

    /**
     * Get the property class name
     *
     * @return string
     */
    public function className()
    {
        return $this->class;
    }

    /**
     * Get the property name
     *
     * @return string
     */
    public function name()
    {
        return $this->name;
    }

    /**
     * Set the property type infos
     *
     * @param Type $type
     */
    public function setType(Type $type): void
    {
        $this->type = $type;
    }

    /**
     * Get the property type
     *
     * @return Type
     */
    public function type()
    {
        return $this->type;
    }

    /**
     * Set the property alias
     *
     * @param string $alias
     */
    public function setAlias($alias): void
    {
        $this->alias = $alias;
    }

    /**
     * Get the property alias
     *
     * @return string
     */
    public function alias()
    {
        return $this->alias;
    }

    /**
     * Set the property groups
     *
     * @param array $groups
     */
    public function setGroups(array $groups): void
    {
        foreach ($groups as $group) {
            $this->groups[$group] = $group;
        }
    }

    /**
     * Get the property groups
     *
     * @return array
     */
    public function groups()
    {
        return $this->groups;
    }

    /**
     * Set the property accessor
     *
     * @param PropertyAccessorInterface $accessor
     */
    public function setAccessor(PropertyAccessorInterface $accessor): void
    {
        $this->accessor = $accessor;
    }

    /**
     * Get the property accessor
     *
     * @return PropertyAccessorInterface
     */
    public function accessor()
    {
        return $this->accessor;
    }

    /**
     * Set the version when the property has been added
     *
     * @param string|null $version
     */
    public function setSince($version): void
    {
        $this->since = $version;
    }

    /**
     * Get the version when the property has been added
     *
     * @return string|null
     */
    public function since()
    {
        return $this->since;
    }

    /**
     * Set the version when the property has been removed
     *
     * @param string|null $version
     */
    public function setUntil($version): void
    {
        $this->until = $version;
    }

    /**
     * Get the version when the property has been removed
     *
     * @return string|null
     */
    public function until()
    {
        return $this->until;
    }

    /**
     * Test if the property match to the version
     *
     * @param string $version
     *
     * @return boolean
     */
    public function matchVersion($version)
    {
        if (null !== $this->since && version_compare($version, $this->since, '<')) {
            return false;
        }

        if (null !== $this->until && version_compare($version, $this->until, '>')) {
            return false;
        }

        return true;
    }

    /**
     * Set the value of the read only flag.
     *
     * @param bool $flag
     */
    public function setReadOnly($flag): void
    {
        $this->readOnly = $flag;
    }

    /**
     * Get the value of the read only flag.
     *
     * @return bool
     */
    public function readOnly()
    {
        return $this->readOnly;
    }

    /**
     * Set the property inline.
     *
     * The result of the normalization of this property
     * will be add on the same layer of the property.
     * Works only if the normalization of this property is an array.
     *
     * @param bool $flag
     */
    public function setInline(bool $flag): void
    {
        $this->inline = $flag;
    }

    /**
     * Get the inline state of the property.
     *
     * @return bool
     */
    public function inline(): bool
    {
        return $this->inline;
    }

    /**
     * Set the value to skip.
     *
     * @param mixed $defaultValue
     */
    public function setDefaultValue($defaultValue): void
    {
        $this->defaultValue = $defaultValue;
        $this->hasDefaultValue = true;
    }

    /**
     * Get the value to skip.
     *
     * @return mixed
     */
    public function defaultValue()
    {
        return $this->defaultValue;
    }

    /**
     * Check whether the value is the default value of the property.
     *
     * @param mixed $value
     */
    public function isDefaultValue($value): bool
    {
        return $this->hasDefaultValue && $this->defaultValue === $value;
    }

    /**
     * Set the options for normalization context
     *
     * @param null|array $options
     */
    public function setNormalizationOptions($options): void
    {
        $this->normalizationOptions = $options;
    }

    /**
     * Get property options for normalization context.
     *
     * @return null|array
     */
    public function normalizationOptions()
    {
        return $this->normalizationOptions;
    }

    /**
     * Set the options for denormalization context
     *
     * @param null|array $options
     */
    public function setDenormalizationOptions($options): void
    {
        $this->denormalizationOptions = $options;
    }

    /**
     * Get property options for denormalization context.
     *
     * @return null|array
     */
    public function denormalizationOptions()
    {
        return $this->denormalizationOptions;
    }
}


1		<?php
2
3		namespace Bdf\Serializer\Metadata;
4
5		use Bdf\Serializer\PropertyAccessor\PropertyAccessorInterface;
6		use Bdf\Serializer\Type\Type;
7
8		/**
9		* PropertyMetadata
10		*
11		* @author Seb
12		*
13		* @psalm-suppress PropertyNotSetInConstructor
14		*/
15		class PropertyMetadata
16		{
17		/**
18		* The owner class name
19		*
20		* @var string
21		*/
22		public $class;
23
24		/**
25		* The property name
26		*
27		* @var string
28		*/
29		public $name;
30
31		/**
32		* The property alias
33		*
34		* @var string
35		*/
36		public $alias;
37
38		/**
39		* The property type infos
40		*
41		* @var Type
42		*/
43		public $type;
44
45		/**
46		* The property groups
47		*
48		* @var array
49		*/
50		public $groups = [];
51
52		/**
53		* The property accessor
54		*
55		* @var PropertyAccessorInterface
56		*/
57		public $accessor;
58
59		/**
60		* The version when the property has been added.
61		*
62		* @var string\|null
63		*/
64		public $since;
65
66		/**
67		* The version when the property has been removed.
68		*
69		* @var string\|null
70		*/
71		public $until;
72
73		/**
74		* The read only state of the property.
75		*
76		* @var bool
77		*/
78		public $readOnly = false;
79
80		/**
81		* The inline state of the property.
82		*
83		* @var bool
84		*/
85		public $inline = false;
86
87		/**
88		* The default value of the property.
89		*
90		* @var mixed
91		*/
92		public $defaultValue;
93
94		/**
95		* A flag to know if the property has a default value.
96		*
97		* @var bool
98		*/
99		private $hasDefaultValue = false;
100
101		/**
102		* Flag to know if the property used php type.
103		*
104		* @var bool
105		*/
106		public $isPhpTyped = false;
107
108		/**
109		* The context options for normalization.
110		*
111		* @var null\|array
112		*/
113		public $normalizationOptions;
114
115		/**
116		* The context options for denormalization.
117		*
118		* @var null\|array
119		*/
120		public $denormalizationOptions;
121
122		/**
123		* PropertyMetadata constructor.
124		*
125		* @param string $class
126		* @param string $name
127		*/
128	286	public function __construct(string $class, string $name)
129		{
130	286	$this->class = $class;
131	286	$this->name = $name;
132		}
133
134		/**
135		* Check whether the property should be skipped
136		*
137		* @param array $groups
138		*
139		* @return boolean True if the property has one of the groups
140		*/
141	12	public function hasGroups(array $groups)
142		{
143	12	foreach ($groups as $group) {
144	12	if (isset($this->groups[$group])) {
145	10	return true;
146		}
147		}
148
149	10	return false;
150		}
151
152		/**
153		* Get the property class name
154		*
155		* @return string
156		*/
157	4	public function className()
158		{
159	4	return $this->class;
160		}
161
162		/**
163		* Get the property name
164		*
165		* @return string
166		*/
167	188	public function name()
168		{
169	188	return $this->name;
170		}
171
172		/**
173		* Set the property type infos
174		*
175		* @param Type $type
176		*/
177	262	public function setType(Type $type): void
178		{
179	262	$this->type = $type;
180		}
181
182		/**
183		* Get the property type
184		*
185		* @return Type
186		*/
187	42	public function type()
188		{
189	42	return $this->type;
190		}
191
192		/**
193		* Set the property alias
194		*
195		* @param string $alias
196		*/
197	234	public function setAlias($alias): void
198		{
199	234	$this->alias = $alias;
200		}
201
202		/**
203		* Get the property alias
204		*
205		* @return string
206		*/
207	8	public function alias()
208		{
209	8	return $this->alias;
210		}
211
212		/**
213		* Set the property groups
214		*
215		* @param array $groups
216		*/
217	260	public function setGroups(array $groups): void
218		{
219	260	foreach ($groups as $group) {
220	90	$this->groups[$group] = $group;
221		}
222		}
223
224		/**
225		* Get the property groups
226		*
227		* @return array
228		*/
229	4	public function groups()
230		{
231	4	return $this->groups;
232		}
233
234		/**
235		* Set the property accessor
236		*
237		* @param PropertyAccessorInterface $accessor
238		*/
239	234	public function setAccessor(PropertyAccessorInterface $accessor): void
240		{
241	234	$this->accessor = $accessor;
242		}
243
244		/**
245		* Get the property accessor
246		*
247		* @return PropertyAccessorInterface
248		*/
249	20	public function accessor()
250		{
251	20	return $this->accessor;
252		}
253
254		/**
255		* Set the version when the property has been added
256		*
257		* @param string\|null $version
258		*/
259	262	public function setSince($version): void
260		{
261	262	$this->since = $version;
262		}
263
264		/**
265		* Get the version when the property has been added
266		*
267		* @return string\|null
268		*/
269	10	public function since()
270		{
271	10	return $this->since;
272		}
273
274		/**
275		* Set the version when the property has been removed
276		*
277		* @param string\|null $version
278		*/
279	262	public function setUntil($version): void
280		{
281	262	$this->until = $version;
282		}
283
284		/**
285		* Get the version when the property has been removed
286		*
287		* @return string\|null
288		*/
289	10	public function until()
290		{
291	10	return $this->until;
292		}
293
294		/**
295		* Test if the property match to the version
296		*
297		* @param string $version
298		*
299		* @return boolean
300		*/
301	16	public function matchVersion($version)
302		{
303	16	if (null !== $this->since && version_compare($version, $this->since, '<')) {
304	6	return false;
305		}
306
307	14	if (null !== $this->until && version_compare($version, $this->until, '>')) {
308	6	return false;
309		}
310
311	12	return true;
312		}
313
314		/**
315		* Set the value of the read only flag.
316		*
317		* @param bool $flag
318		*/
319	234	public function setReadOnly($flag): void
320		{
321	234	$this->readOnly = $flag;
322		}
323
324		/**
325		* Get the value of the read only flag.
326		*
327		* @return bool
328		*/
329	6	public function readOnly()
330		{
331	6	return $this->readOnly;
332		}
333
334		/**
335		* Set the property inline.
336		*
337		* The result of the normalization of this property
338		* will be add on the same layer of the property.
339		* Works only if the normalization of this property is an array.
340		*
341		* @param bool $flag
342		*/
343	234	public function setInline(bool $flag): void
344		{
345	234	$this->inline = $flag;
346		}
347
348		/**
349		* Get the inline state of the property.
350		*
351		* @return bool
352		*/
353	6	public function inline(): bool
354		{
355	6	return $this->inline;
356		}
357
358		/**
359		* Set the value to skip.
360		*
361		* @param mixed $defaultValue
362		*/
363	210	public function setDefaultValue($defaultValue): void
364		{
365	210	$this->defaultValue = $defaultValue;
366	210	$this->hasDefaultValue = true;
367		}
368
369		/**
370		* Get the value to skip.
371		*
372		* @return mixed
373		*/
374	4	public function defaultValue()
375		{
376	4	return $this->defaultValue;
377		}
378
379		/**
380		* Check whether the value is the default value of the property.
381		*
382		* @param mixed $value
383		*/
384	6	public function isDefaultValue($value): bool
385		{
386	6	return $this->hasDefaultValue && $this->defaultValue === $value;
387		}
388
389		/**
390		* Set the options for normalization context
391		*
392		* @param null\|array $options
393		*/
394	234	public function setNormalizationOptions($options): void
395		{
396	234	$this->normalizationOptions = $options;
397		}
398
399		/**
400		* Get property options for normalization context.
401		*
402		* @return null\|array
403		*/
404	2	public function normalizationOptions()
405		{
406	2	return $this->normalizationOptions;
407		}
408
409		/**
410		* Set the options for denormalization context
411		*
412		* @param null\|array $options
413		*/
414	234	public function setDenormalizationOptions($options): void
415		{
416	234	$this->denormalizationOptions = $options;
417		}
418
419		/**
420		* Get property options for denormalization context.
421		*
422		* @return null\|array
423		*/
424	2	public function denormalizationOptions()
425		{
426	2	return $this->denormalizationOptions;
427		}
428		}
429

b2pweb / bdf-serializer

Pull Request — master (#11)

PropertyMetadata::isDefaultValue() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like