DtoProperty::getTypes() - Code Metrics - Inspection of "Reset listener after tests" - cerbero90/dto - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — feature/concerns-into-traits (dd523b)

by Andrea Marco

created 2020-03-26 11:39 UTC

DtoProperty::getTypes() A

↳ Parent: DtoProperty

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	1
Bugs	0	Features	0

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

<?php

namespace Cerbero\Dto;

use Cerbero\Dto\Manipulators\ArrayConverter;
use Cerbero\Dto\Exceptions\UnexpectedValueException;

/**
 * The DTO property.
 *
 */
class DtoProperty
{
    /**
     * The property name.
     *
     * @var string
     */
    protected $name;

    /**
     * The property raw value.
     *
     * @var mixed
     */
    protected $rawValue;

    /**
     * The property types.
     *
     * @var DtoPropertyTypes
     */
    protected $types;

    /**
     * The DTO flags.
     *
     * @var int
     */
    protected $flags;

    /**
     * The processed value.
     *
     * @var mixed
     */
    protected $processedValue;

    /**
     * Whether the value has been processed.
     *
     * @var bool
     */
    protected $valueIsProcessed = false;

    /**
     * Instantiate the class.
     *
     * @param string $name
     * @param mixed $rawValue
     * @param DtoPropertyTypes $types
     * @param int $flags
     */
    protected function __construct(string $name, $rawValue, DtoPropertyTypes $types, int $flags)
    {
        $this->name = $name;
        $this->rawValue = $rawValue;
        $this->types = $types;
        $this->flags = $flags;
    }

    /**
     * Retrieve a DTO property instance after validating it
     *
     * @param string $name
     * @param mixed $rawValue
     * @param DtoPropertyTypes $types
     * @param int $flags
     * @return self
     * @throws UnexpectedValueException
     */
    public static function create(string $name, $rawValue, DtoPropertyTypes $types, int $flags): self
    {
        $instance = new static($name, $rawValue, $types, $flags);

        return $instance->validate();
    }

    /**
     * Validate the current property value depending on types and flags
     *
     * @return self
     * @throws UnexpectedValueException
     */
    public function validate(): self
    {
        if ($this->rawValue === null) {
            if ($this->isNullable()) {
                return $this;
            }

            throw new UnexpectedValueException($this);
        }

        if ($this->types->match($this->value())) {
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            return $this;
        }

        throw new UnexpectedValueException($this);
    }

    /**
     * Determine whether this property is nullable
     *
     * @return bool
     */
    public function isNullable(): bool
    {
        if ($this->flags & NOT_NULLABLE) {
            return false;
        }

        return ($this->flags & NULLABLE) || $this->types->includeNull;
    }

    /**
     * Retrieve the processed value
     *
     * @return void
     */
    public function value()
    {
        if ($this->valueIsProcessed) {
            return $this->processedValue;
        }

        $this->processedValue = $this->processRawValue();
        $this->valueIsProcessed = true;

        return $this->processedValue;
    }

    /**
     * Retrieve the processed raw value
     *
     * @return mixed
     */
    protected function processRawValue()
    {
        if ($this->rawValue === null) {
            return null;
        }

        foreach ($this->types->all as $type) {
            if (!class_exists($class = $type->name())) {
                continue;
            } elseif ($converter = ArrayConverter::instance()->getConverterByClass($class)) {
                return $converter->toDto($this->rawValue);
            }
        }

        return $this->types->expectedDto ? $this->castRawValueIntoDto() : $this->rawValue;
    }

    /**
     * Retrieve the raw value casted into a DTO or a collection of DTOs
     *
     * @return Dto|Dto[]|null
     */
    protected function castRawValueIntoDto()
    {
        $dto = $this->types->expectedDto;

        if (!$this->types->expectCollection) {
            return is_a($this->rawValue, $dto) ? $this->rawValue : $dto::make($this->rawValue, $this->flags);
        }

        return array_map(function ($data) use ($dto) {
            return is_a($data, $dto) ? $data : $dto::make($data, $this->flags);
        }, $this->rawValue);
    }

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

    /**
     * Retrieve the property raw value
     *
     * @return mixed
     */
    public function getRawValue()
    {
        return $this->rawValue;
    }

    /**
     * Retrieve the property types
     *
     * @return DtoPropertyTypes
     */
    public function getTypes(): DtoPropertyTypes
    {
        return $this->types;
    }

    /**
     * Retrieve the DTO flags
     *
     * @return int
     */
    public function getFlags(): int
    {
        return $this->flags;
    }

    /**
     * Set a new value to this property and validate it
     *
     * @param mixed $rawValue
     * @param int $flags
     * @return self
     */
    public function setValue($rawValue, int $flags): self
    {
        $this->rawValue = $rawValue;
        $this->flags = $flags;
        $this->valueIsProcessed = false;

        return $this->validate();
    }

    /**
     * Determine how to clone the DTO property
     *
     * @return void
     */
    public function __clone()
    {
        $this->types = clone $this->types;
    }
}


1		<?php
2
3		namespace Cerbero\Dto;
4
5		use Cerbero\Dto\Manipulators\ArrayConverter;
6		use Cerbero\Dto\Exceptions\UnexpectedValueException;
7
8		/**
9		* The DTO property.
10		*
11		*/
12		class DtoProperty
13		{
14		/**
15		* The property name.
16		*
17		* @var string
18		*/
19		protected $name;
20
21		/**
22		* The property raw value.
23		*
24		* @var mixed
25		*/
26		protected $rawValue;
27
28		/**
29		* The property types.
30		*
31		* @var DtoPropertyTypes
32		*/
33		protected $types;
34
35		/**
36		* The DTO flags.
37		*
38		* @var int
39		*/
40		protected $flags;
41
42		/**
43		* The processed value.
44		*
45		* @var mixed
46		*/
47		protected $processedValue;
48
49		/**
50		* Whether the value has been processed.
51		*
52		* @var bool
53		*/
54		protected $valueIsProcessed = false;
55
56		/**
57		* Instantiate the class.
58		*
59		* @param string $name
60		* @param mixed $rawValue
61		* @param DtoPropertyTypes $types
62		* @param int $flags
63		*/
64	211	protected function __construct(string $name, $rawValue, DtoPropertyTypes $types, int $flags)
65		{
66	211	$this->name = $name;
67	211	$this->rawValue = $rawValue;
68	211	$this->types = $types;
69	211	$this->flags = $flags;
70	211	}
71
72		/**
73		* Retrieve a DTO property instance after validating it
74		*
75		* @param string $name
76		* @param mixed $rawValue
77		* @param DtoPropertyTypes $types
78		* @param int $flags
79		* @return self
80		* @throws UnexpectedValueException
81		*/
82	211	public static function create(string $name, $rawValue, DtoPropertyTypes $types, int $flags): self
83		{
84	211	$instance = new static($name, $rawValue, $types, $flags);
85
86	211	return $instance->validate();
87		}
88
89		/**
90		* Validate the current property value depending on types and flags
91		*
92		* @return self
93		* @throws UnexpectedValueException
94		*/
95	211	public function validate(): self
96		{
97	211	if ($this->rawValue === null) {
98	39	if ($this->isNullable()) {
99	33	return $this;
100		}
101
102	6	throw new UnexpectedValueException($this);
103		}
104
105	184	if ($this->types->match($this->value())) {
		0 ignored issues – show Bug introduced 2020-03-18 14:16 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->value()` targeting `Cerbero\Dto\DtoProperty::value()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
106	175	return $this;
107		}
108
109	9	throw new UnexpectedValueException($this);
110		}
111
112		/**
113		* Determine whether this property is nullable
114		*
115		* @return bool
116		*/
117	45	public function isNullable(): bool
118		{
119	45	if ($this->flags & NOT_NULLABLE) {
120	6	return false;
121		}
122
123	39	return ($this->flags & NULLABLE) \|\| $this->types->includeNull;
124		}
125
126		/**
127		* Retrieve the processed value
128		*
129		* @return void
130		*/
131	196	public function value()
132		{
133	196	if ($this->valueIsProcessed) {
134	100	return $this->processedValue;
135		}
136
137	196	$this->processedValue = $this->processRawValue();
138	196	$this->valueIsProcessed = true;
139
140	196	return $this->processedValue;
141		}
142
143		/**
144		* Retrieve the processed raw value
145		*
146		* @return mixed
147		*/
148	196	protected function processRawValue()
149		{
150	196	if ($this->rawValue === null) {
151	15	return null;
152		}
153
154	184	foreach ($this->types->all as $type) {
155	184	if (!class_exists($class = $type->name())) {
156	169	continue;
157	58	} elseif ($converter = ArrayConverter::instance()->getConverterByClass($class)) {
158	36	return $converter->toDto($this->rawValue);
159		}
160		}
161
162	184	return $this->types->expectedDto ? $this->castRawValueIntoDto() : $this->rawValue;
163		}
164
165		/**
166		* Retrieve the raw value casted into a DTO or a collection of DTOs
167		*
168		* @return Dto\|Dto[]\|null
169		*/
170	58	protected function castRawValueIntoDto()
171		{
172	58	$dto = $this->types->expectedDto;
173
174	58	if (!$this->types->expectCollection) {
175	46	return is_a($this->rawValue, $dto) ? $this->rawValue : $dto::make($this->rawValue, $this->flags);
176		}
177
178	4	return array_map(function ($data) use ($dto) {
179	9	return is_a($data, $dto) ? $data : $dto::make($data, $this->flags);
180	13	}, $this->rawValue);
181		}
182
183		/**
184		* Retrieve the property name
185		*
186		* @return string
187		*/
188	30	public function getName(): string
189		{
190	30	return $this->name;
191		}
192
193		/**
194		* Retrieve the property raw value
195		*
196		* @return mixed
197		*/
198	42	public function getRawValue()
199		{
200	42	return $this->rawValue;
201		}
202
203		/**
204		* Retrieve the property types
205		*
206		* @return DtoPropertyTypes
207		*/
208	178	public function getTypes(): DtoPropertyTypes
209		{
210	178	return $this->types;
211		}
212
213		/**
214		* Retrieve the DTO flags
215		*
216		* @return int
217		*/
218	15	public function getFlags(): int
219		{
220	15	return $this->flags;
221		}
222
223		/**
224		* Set a new value to this property and validate it
225		*
226		* @param mixed $rawValue
227		* @param int $flags
228		* @return self
229		*/
230	24	public function setValue($rawValue, int $flags): self
231		{
232	24	$this->rawValue = $rawValue;
233	24	$this->flags = $flags;
234	24	$this->valueIsProcessed = false;
235
236	24	return $this->validate();
237		}
238
239		/**
240		* Determine how to clone the DTO property
241		*
242		* @return void
243		*/
244	21	public function __clone()
245		{
246	21	$this->types = clone $this->types;
247	21	}
248		}
249

cerbero90 / dto

Branch — feature/concerns-into-traits (dd523b)

DtoProperty::getTypes() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like