DataTransferObject::all() - Code Metrics - Inspection of "Immutable by default + support for mutation of met..." - spatie/data-transfer-object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#56)

by Arthur

created 2019-03-28 14:56 UTC

DataTransferObject::all() A

↳ Parent: DataTransferObject

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php

declare(strict_types=1);

namespace Spatie\DataTransferObject;

use ReflectionClass;
use ReflectionProperty;
use Spatie\DataTransferObject\Contracts\immutable;
use Spatie\DataTransferObject\Contracts\DtoContract;
use Spatie\DataTransferObject\Contracts\PropertyContract;
use Spatie\DataTransferObject\Exceptions\ImmutableDtoException;
use Spatie\DataTransferObject\Exceptions\PropertyNotFoundDtoException;
use Spatie\DataTransferObject\Exceptions\ImmutablePropertyDtoException;
use Spatie\DataTransferObject\Exceptions\UnknownPropertiesDtoException;
use Spatie\DataTransferObject\Exceptions\UninitialisedPropertyDtoException;

/**
 * Class DataTransferObject.
 */
abstract class DataTransferObject implements DtoContract
{
    /** @var array */
    protected $onlyKeys = [];

    /** @var Property[] | array */
    protected $properties = [];

    /** @var bool */
    protected $immutable = false;

    public function __construct(array $parameters)
    {
        $this->boot($parameters);
    }

    /**
     * Boot the dto and process all parameters.
     * @param array $parameters
     * @throws \ReflectionException
     */
    protected function boot(array $parameters): void
    {
        $this->resolveImmutable();

        foreach ($this->getPublicProperties() as $property) {

            /*
             * Do not change the order of the following methods.
             * External packages rely on this order.
             */

            $this->setPropertyDefaultValue($property);

            $property = $this->mutateProperty($property);

            $this->validateProperty($property, $parameters);

            $this->setPropertyValue($property, $parameters);

            /* add the property to an associative array with the name as key */
            $this->properties[$property->getName()] = $property;

            /* remove the property from the value object and parameters array  */
            unset($parameters[$property->getName()], $this->{$property->getName()});
        }

        $this->processRemainingProperties($parameters);
    }

    protected function resolveImmutable()
    {
        if ($this instanceof immutable) {
            $this->immutable = true;
        }
    }

    /**
     * Get all public properties from the current object through reflection.
     * @return Property[]
     * @throws \ReflectionException
     */
    protected function getPublicProperties(): array
    {
        $class = new ReflectionClass(static::class);

        $properties = [];
        foreach ($class->getProperties(ReflectionProperty::IS_PUBLIC) as $reflectionProperty) {
            $properties[$reflectionProperty->getName()] = Property::fromReflection($reflectionProperty);
        }

        return $properties;
    }

    /**
     * Check if property passes the basic conditions.
     * @param PropertyContract $property
     * @param array $parameters
     */
    protected function validateProperty(PropertyContract $property, array $parameters): void
    {
        if (! array_key_exists($property->getName(), $parameters)
            && is_null($property->getDefault())
            && ! $property->nullable()
        ) {
            throw new UninitialisedPropertyDtoException($property);
        }
    }

    /**
     * Set the value if it's present in the array.
     * @param PropertyContract $property
     * @param array $parameters
     */
    protected function setPropertyValue(PropertyContract $property, array $parameters): void
    {
        if (array_key_exists($property->getName(), $parameters)) {
            $property->set($parameters[$property->getName()]);
        }
    }

    /**
     * Set the value if it's present in the array.
     * @param PropertyContract $property
     */
    protected function setPropertyDefaultValue(PropertyContract $property): void
    {
        $property->setDefault($property->getValueFromReflection($this));
    }

    /**
     * Allows to mutate the property before it gets processed.
     * @param PropertyContract $property
     * @return PropertyContract
     */
    protected function mutateProperty(PropertyContract $property): PropertyContract
    {
        return $property;
    }

    /**
     * Check if there are additional parameters left.
     * Throw error if there are.
     * Additional properties are not allowed in a dto.
     * @param array $parameters
     * @throws UnknownPropertiesDtoException
     */
    protected function processRemainingProperties(array $parameters)
    {
        if (count($parameters)) {
            throw new UnknownPropertiesDtoException(array_keys($parameters), static::class);
        }
    }

    /**
     * Immutable behavior
     * Throw error if a user tries to set a property.
     * @param $name
     * @param $value
     * @throws ImmutableDtoException|ImmutablePropertyDtoException|PropertyNotFoundDtoException
     */
    public function __set($name, $value)
    {
        if ($this->immutable) {
            throw new ImmutableDtoException($name);
        }
        if (! isset($this->properties[$name])) {
            throw new PropertyNotFoundDtoException($name, get_class($this));
        }

        if ($this->properties[$name]->immutable()) {
            throw new ImmutablePropertyDtoException($name);
        }
        $this->$name = $value;
    }

    /**
     * Proxy through to the properties array.
     * @param $name
     * @return mixed
     */
    public function __get($name)
    {
        return $this->properties[$name]->getValue();
    }

    /**
     * @return static
     */
    public function mutable(): DtoContract
    {
        $this->immutable = false;

        return $this;
    }

    /**
     * @return static
     */
    public function immutable(): DtoContract
    {
        $this->immutable = true;

        return $this;
    }

    public function all(): array
    {
        $data = [];

        foreach ($this->properties as $property) {
            $data[$property->getName()] = $property->getValue();
        }

        return $data;
    }

    public function only(string ...$keys): DtoContract
    {
        $this->onlyKeys = array_merge($this->onlyKeys, $keys);

        return $this;
    }

    public function except(string ...$keys): DtoContract
    {
        foreach ($keys as $key) {
            $property = $this->properties[$key] ?? null;
            if (isset($property)) {
                $property->setVisible(false);
            }
        }

        return $this;
    }

    public function toArray(): array
    {
        $data = $this->all();
        $array = [];

        if (count($this->onlyKeys)) {
            $array = array_intersect_key($data, array_flip((array) $this->onlyKeys));
        } else {
            foreach ($data as $key => $propertyValue) {
                if ($this->properties[$key]->isVisible()) {
                    $array[$key] = $propertyValue;
                }
            }
        }

        return $this->parseArray($array);
    }

    protected function parseArray(array $array): array
    {
        foreach ($array as $key => $value) {
            if (
                $value instanceof DataTransferObject
                || $value instanceof DataTransferObjectCollection
            ) {
                $array[$key] = $value->toArray();

                continue;
            }

            if (! is_array($value)) {
                continue;
            }

            $array[$key] = $this->parseArray($value);
        }

        return $array;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Spatie\DataTransferObject;
6
7			use ReflectionClass;
8			use ReflectionProperty;
9			use Spatie\DataTransferObject\Contracts\immutable;
10			use Spatie\DataTransferObject\Contracts\DtoContract;
11			use Spatie\DataTransferObject\Contracts\PropertyContract;
12			use Spatie\DataTransferObject\Exceptions\ImmutableDtoException;
13			use Spatie\DataTransferObject\Exceptions\PropertyNotFoundDtoException;
14			use Spatie\DataTransferObject\Exceptions\ImmutablePropertyDtoException;
15			use Spatie\DataTransferObject\Exceptions\UnknownPropertiesDtoException;
16			use Spatie\DataTransferObject\Exceptions\UninitialisedPropertyDtoException;
17
18			/**
19			* Class DataTransferObject.
20			*/
21			abstract class DataTransferObject implements DtoContract
22			{
23			/** @var array */
24			protected $onlyKeys = [];
25
26			/** @var Property[] \| array */
27			protected $properties = [];
28
29			/** @var bool */
30			protected $immutable = false;
31
32			public function __construct(array $parameters)
33			{
34			$this->boot($parameters);
35			}
36
37			/**
38			* Boot the dto and process all parameters.
39			* @param array $parameters
40			* @throws \ReflectionException
41			*/
42			protected function boot(array $parameters): void
43			{
44			$this->resolveImmutable();
45
46			foreach ($this->getPublicProperties() as $property) {
47
48			/*
49			* Do not change the order of the following methods.
50			* External packages rely on this order.
51			*/
52
53			$this->setPropertyDefaultValue($property);
54
55			$property = $this->mutateProperty($property);
56
57			$this->validateProperty($property, $parameters);
58
59			$this->setPropertyValue($property, $parameters);
60
61			/* add the property to an associative array with the name as key */
62			$this->properties[$property->getName()] = $property;
63
64			/* remove the property from the value object and parameters array */
65			unset($parameters[$property->getName()], $this->{$property->getName()});
66			}
67
68			$this->processRemainingProperties($parameters);
69			}
70
71			protected function resolveImmutable()
72			{
73			if ($this instanceof immutable) {
74			$this->immutable = true;
75			}
76			}
77
78			/**
79			* Get all public properties from the current object through reflection.
80			* @return Property[]
81			* @throws \ReflectionException
82			*/
83			protected function getPublicProperties(): array
84			{
85			$class = new ReflectionClass(static::class);
86
87			$properties = [];
88			foreach ($class->getProperties(ReflectionProperty::IS_PUBLIC) as $reflectionProperty) {
89			$properties[$reflectionProperty->getName()] = Property::fromReflection($reflectionProperty);
90			}
91
92			return $properties;
93			}
94
95			/**
96			* Check if property passes the basic conditions.
97			* @param PropertyContract $property
98			* @param array $parameters
99			*/
100			protected function validateProperty(PropertyContract $property, array $parameters): void
101			{
102			if (! array_key_exists($property->getName(), $parameters)
103			&& is_null($property->getDefault())
104			&& ! $property->nullable()
105			) {
106			throw new UninitialisedPropertyDtoException($property);
107			}
108			}
109
110			/**
111			* Set the value if it's present in the array.
112			* @param PropertyContract $property
113			* @param array $parameters
114			*/
115			protected function setPropertyValue(PropertyContract $property, array $parameters): void
116			{
117			if (array_key_exists($property->getName(), $parameters)) {
118			$property->set($parameters[$property->getName()]);
119			}
120			}
121
122			/**
123			* Set the value if it's present in the array.
124			* @param PropertyContract $property
125			*/
126			protected function setPropertyDefaultValue(PropertyContract $property): void
127			{
128			$property->setDefault($property->getValueFromReflection($this));
129			}
130
131			/**
132			* Allows to mutate the property before it gets processed.
133			* @param PropertyContract $property
134			* @return PropertyContract
135			*/
136			protected function mutateProperty(PropertyContract $property): PropertyContract
137			{
138			return $property;
139			}
140
141			/**
142			* Check if there are additional parameters left.
143			* Throw error if there are.
144			* Additional properties are not allowed in a dto.
145			* @param array $parameters
146			* @throws UnknownPropertiesDtoException
147			*/
148			protected function processRemainingProperties(array $parameters)
149			{
150			if (count($parameters)) {
151			throw new UnknownPropertiesDtoException(array_keys($parameters), static::class);
152			}
153			}
154
155			/**
156			* Immutable behavior
157			* Throw error if a user tries to set a property.
158			* @param $name
159			* @param $value
160			* @throws ImmutableDtoException\|ImmutablePropertyDtoException\|PropertyNotFoundDtoException
161			*/
162			public function __set($name, $value)
163			{
164			if ($this->immutable) {
165			throw new ImmutableDtoException($name);
166			}
167			if (! isset($this->properties[$name])) {
168			throw new PropertyNotFoundDtoException($name, get_class($this));
169			}
170
171			if ($this->properties[$name]->immutable()) {
172			throw new ImmutablePropertyDtoException($name);
173			}
174			$this->$name = $value;
175			}
176
177			/**
178			* Proxy through to the properties array.
179			* @param $name
180			* @return mixed
181			*/
182			public function __get($name)
183			{
184			return $this->properties[$name]->getValue();
185			}
186
187			/**
188			* @return static
189			*/
190			public function mutable(): DtoContract
191			{
192			$this->immutable = false;
193
194			return $this;
195			}
196
197			/**
198			* @return static
199			*/
200			public function immutable(): DtoContract
201			{
202			$this->immutable = true;
203
204			return $this;
205			}
206
207			public function all(): array
208			{
209			$data = [];
210
211			foreach ($this->properties as $property) {
212			$data[$property->getName()] = $property->getValue();
213			}
214
215			return $data;
216			}
217
218			public function only(string ...$keys): DtoContract
219			{
220			$this->onlyKeys = array_merge($this->onlyKeys, $keys);
221
222			return $this;
223			}
224
225			public function except(string ...$keys): DtoContract
226			{
227			foreach ($keys as $key) {
228			$property = $this->properties[$key] ?? null;
229			if (isset($property)) {
230			$property->setVisible(false);
231			}
232			}
233
234			return $this;
235			}
236
237			public function toArray(): array
238			{
239			$data = $this->all();
240			$array = [];
241
242			if (count($this->onlyKeys)) {
243			$array = array_intersect_key($data, array_flip((array) $this->onlyKeys));
244			} else {
245			foreach ($data as $key => $propertyValue) {
246			if ($this->properties[$key]->isVisible()) {
247			$array[$key] = $propertyValue;
248			}
249			}
250			}
251
252			return $this->parseArray($array);
253			}
254
255			protected function parseArray(array $array): array
256			{
257			foreach ($array as $key => $value) {
258			if (
259			$value instanceof DataTransferObject
260			\|\| $value instanceof DataTransferObjectCollection
261			) {
262			$array[$key] = $value->toArray();
263
264			continue;
265			}
266
267			if (! is_array($value)) {
268			continue;
269			}
270
271			$array[$key] = $this->parseArray($value);
272			}
273
274			return $array;
275			}
276			}
277

spatie / data-transfer-object

GitHub Access Token became invalid

Pull Request — master (#56)

DataTransferObject::all() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like