Serializer::setSdk() - Code Metrics - Inspection of "use type hinting everywhere" - mapado/rest-client-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#88)

by Julien

created 2019-01-31 13:43 UTC

Serializer::setSdk() A

↳ Parent: Serializer

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace Mapado\RestClientSdk\Model;

use libphonenumber\PhoneNumber;
use libphonenumber\PhoneNumberFormat;
use libphonenumber\PhoneNumberUtil;
use Mapado\RestClientSdk\Exception\SdkException;
use Mapado\RestClientSdk\Helper\ArrayHelper;
use Mapado\RestClientSdk\Mapping;
use Mapado\RestClientSdk\Mapping\ClassMetadata;
use Mapado\RestClientSdk\SdkClient;
use Mapado\RestClientSdk\UnitOfWork;

/**
 * Class Serializer
 *
 * @author Julien Deniau <[email protected]>
 */
class Serializer
{
    /**
     * mapping
     *
     * @var Mapping
     */
    private $mapping;

    /**
     * @var SdkClient
     */
    private $sdk;

    /**
     * @var UnitOfWork
     */
    private $unitOfWork;

    public function __construct(Mapping $mapping, UnitOfWork $unitOfWork)
    {
        $this->mapping = $mapping;
        $this->unitOfWork = $unitOfWork;
    }

    /**
     * @required
     */
    public function setSdk(SdkClient $sdk): self
    {
        $this->sdk = $sdk;

        return $this;
    }

    /**
     * serialize entity for POST and PUT
     */
    public function serialize(
        object $entity,
        string $modelName,
        array $context = []
    ): array {
        $out = $this->recursiveSerialize($entity, $modelName, 0, $context);

        if (is_string($out)) {
            throw new \RuntimeException(
                'recursiveSerialize should return an array for level 0 of serialization. This should not happen.'
            );
        }

        return $out;
    }

    public function deserialize(array $data, string $className): object
    {
        $className = $this->resolveRealClassName($data, $className);

        $classMetadata = $this->mapping->getClassMetadata($className);

        $attributeList = $classMetadata->getAttributeList();

        $instance = new $className();

        if ($attributeList) {

            foreach ($attributeList as $attribute) {
                $key = $attribute->getSerializedKey();

                if (!ArrayHelper::arrayHas($data, $key)) {
                    continue;
                }

                $value = ArrayHelper::arrayGet($data, $key);

                $setter = 'set' . ucfirst($attribute->getAttributeName());

                if (method_exists($instance, $setter)) {
                    $relation = $classMetadata->getRelation($key);
                    if ($relation) {
                        if (is_string($value)) {
                            $value = $this->sdk->createProxy($value);
                        } elseif (is_array($value)) {
                            $targetEntity = $relation->getTargetEntity();
                            $relationClassMetadata = $this->mapping->getClassMetadata(
                                $targetEntity
                            );

                            if ($relation->isManyToOne()) {
                                $value = $this->deserialize(
                                    $value,
                                    $relationClassMetadata->getModelName()
                                );
                            } else {
                                // One-To-Many association
                                $list = [];
                                foreach ($value as $item) {
                                    if (is_string($item)) {
                                        $list[] = $this->sdk->createProxy(
                                            $item
                                        );
                                    } elseif (is_array($item)) {
                                        $list[] = $this->deserialize(
                                            $item,
                                            $relationClassMetadata->getModelName()
                                        );
                                    }
                                }

                                $value = $list;
                            }
                        }
                    }

                    if (isset($value)) {
                        if ('datetime' === $attribute->getType()) {
                            $value = new \DateTime($value);
                        }

                        $instance->{$setter}($value);
                    }
                }
            }
        }

        $classMetadata = $this->getClassMetadata($instance);
        if ($classMetadata->hasIdentifierAttribute()) {
            $idGetter = $classMetadata->getIdGetter();

            if ($idGetter) {
                $callable = [$instance, $idGetter];
                $identifier = is_callable($callable)
                    ? call_user_func($callable)
                    : null;

                if ($identifier) {
                    $this->unitOfWork->registerClean($identifier, $instance);
                }
            }
        }

        return $instance;
    }

    /**
     * If provided class name is abstract (a base class), the real class name (child class)
     * may be available in some data fields.
     */
    private function resolveRealClassName(
        array $data,
        string $className
    ): string {
        if (!empty($data['@id'])) {
            $classMetadata = $this->mapping->tryGetClassMetadataById(
                $data['@id']
            );

            if ($classMetadata) {
                return $classMetadata->getModelName();
            }
        }

        // Real class name could also be retrieved from @type property.
        return $className;
    }

    /**
     * @return array|string
     */
    private function recursiveSerialize(
        object $entity,
        string $modelName,
        int $level = 0,
        array $context = []
    ) {
        $classMetadata = $this->mapping->getClassMetadata($modelName);

        if ($level > 0 && empty($context['serializeRelation'])) {
            if ($classMetadata->hasIdentifierAttribute()) {
                $tmpId = $entity->{$classMetadata->getIdGetter()}();
                if ($tmpId) {
                    return $tmpId;
                }
            }
        }

        $attributeList = $classMetadata->getAttributeList();

        $out = [];
        if (!empty($attributeList)) {
            foreach ($attributeList as $attribute) {
                $method = 'get' . ucfirst($attribute->getAttributeName());

                if ($attribute->isIdentifier() && !$entity->{$method}()) {
                    continue;
                }
                $relation = $classMetadata->getRelation(
                    $attribute->getSerializedKey()
                );

                $data = $entity->{$method}();

                if (
                    null === $data &&
                    $relation &&
                    $relation->isManyToOne() &&
                    $level > 0
                ) {
                    /*
                        We only serialize the root many-to-one relations to prevent, hopefully,
                        unlinked and/or duplicated content. For instance, a cart with cartItemList containing
                        null values for the cart [{ cart => null, ... }] may lead the creation of
                        CartItem entities explicitly bound to a null Cart instead of the created/updated Cart.
                     */
                    continue;
                } elseif ($data instanceof \DateTime) {
                    $data = $data->format('c');
                } elseif (is_object($data) && $data instanceof PhoneNumber) {
                    $phoneNumberUtil = PhoneNumberUtil::getInstance();
                    $data = $phoneNumberUtil->format(
                        $data,
                        PhoneNumberFormat::INTERNATIONAL
                    );
                } elseif (
                    is_object($data) &&
                    $relation &&
                    $this->mapping->hasClassMetadata(
                        $relation->getTargetEntity()
                    )
                ) {
                    $relationClassMetadata = $this->mapping->getClassMetadata(
                        $relation->getTargetEntity()
                    );

                    if (!$relationClassMetadata->hasIdentifierAttribute()) {
                        $data = $this->recursiveSerialize(
                            $data,
                            $relation->getTargetEntity(),
                            $level + 1,
                            $context
                        );
                    } else {
                        $idAttribute = $relationClassMetadata->getIdentifierAttribute();
                        $idGetter =
                            'get' . ucfirst($idAttribute->getAttributeName());

                        if (
                            method_exists($data, $idGetter) &&
                            $data->{$idGetter}()
                        ) {
                            $data = $data->{$idGetter}();
                        } elseif ($relation->isManyToOne()) {
                            if ($level > 0) {
                                continue;
                            } else {
                                throw new SdkException(
                                    'Case not allowed for now'
                                );
                            }
                        }
                    }
                } elseif (is_array($data)) {
                    $newData = [];
                    foreach ($data as $key => $item) {
                        if ($item instanceof \DateTime) {
                            $newData[$key] = $item->format('c');
                        } elseif (
                            is_object($item) &&
                            $relation &&
                            $this->mapping->hasClassMetadata(
                                $relation->getTargetEntity()
                            )
                        ) {
                            $serializeRelation =
                                !empty($context['serializeRelations']) &&
                                in_array(
                                    $relation->getSerializedKey(),
                                    $context['serializeRelations']
                                );

                            $newData[$key] = $this->recursiveSerialize(
                                $item,
                                $relation->getTargetEntity(),
                                $level + 1,
                                ['serializeRelation' => $serializeRelation]
                            );
                        } else {
                            $newData[$key] = $item;
                        }
                    }
                    $data = $newData;
                }

                $key = $attribute->getSerializedKey();

                $out[$key] = $data;
            }
        }

        return $out;
    }

    private function getClassMetadataFromId(string $id): ?ClassMetadata
    {
        $key = $this->mapping->getKeyFromId($id);

        return $this->mapping->getClassMetadataByKey($key);
    }

    private function getClassMetadata(object $entity): ClassMetadata
    {
        return $this->mapping->getClassMetadata(get_class($entity));
    }
}


1		<?php
2
3		namespace Mapado\RestClientSdk\Model;
4
5		use libphonenumber\PhoneNumber;
6		use libphonenumber\PhoneNumberFormat;
7		use libphonenumber\PhoneNumberUtil;
8		use Mapado\RestClientSdk\Exception\SdkException;
9		use Mapado\RestClientSdk\Helper\ArrayHelper;
10		use Mapado\RestClientSdk\Mapping;
11		use Mapado\RestClientSdk\Mapping\ClassMetadata;
12		use Mapado\RestClientSdk\SdkClient;
13		use Mapado\RestClientSdk\UnitOfWork;
14
15		/**
16		* Class Serializer
17		*
18		* @author Julien Deniau <[email protected]>
19		*/
20		class Serializer
21		{
22		/**
23		* mapping
24		*
25		* @var Mapping
26		*/
27		private $mapping;
28
29		/**
30		* @var SdkClient
31		*/
32		private $sdk;
33
34		/**
35		* @var UnitOfWork
36		*/
37		private $unitOfWork;
38
39		public function __construct(Mapping $mapping, UnitOfWork $unitOfWork)
40		{
41	1	$this->mapping = $mapping;
42	1	$this->unitOfWork = $unitOfWork;
43	1	}
44
45		/**
46		* @required
47		*/
48		public function setSdk(SdkClient $sdk): self
49		{
50	1	$this->sdk = $sdk;
51
52	1	return $this;
53		}
54
55		/**
56		* serialize entity for POST and PUT
57		*/
58		public function serialize(
59		object $entity,
60		string $modelName,
61		array $context = []
62		): array {
63	1	$out = $this->recursiveSerialize($entity, $modelName, 0, $context);
64
65	1	if (is_string($out)) {
66		throw new \RuntimeException(
67		'recursiveSerialize should return an array for level 0 of serialization. This should not happen.'
68		);
69		}
70
71	1	return $out;
72		}
73
74		public function deserialize(array $data, string $className): object
75		{
76	1	$className = $this->resolveRealClassName($data, $className);
77
78	1	$classMetadata = $this->mapping->getClassMetadata($className);
79
80	1	$attributeList = $classMetadata->getAttributeList();
81
82	1	$instance = new $className();
83
84	1	if ($attributeList) {
		0 ignored issues – show Bug Best Practice introduced 2019-01-31 09:17 UTC by Report Bug Copy Issue Report The expression `$attributeList` of type `Mapado\RestClientSdk\Mapping\Attribute[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
85	1	foreach ($attributeList as $attribute) {
86	1	$key = $attribute->getSerializedKey();
87
88	1	if (!ArrayHelper::arrayHas($data, $key)) {
89	1	continue;
90		}
91
92	1	$value = ArrayHelper::arrayGet($data, $key);
93
94	1	$setter = 'set' . ucfirst($attribute->getAttributeName());
95
96	1	if (method_exists($instance, $setter)) {
97	1	$relation = $classMetadata->getRelation($key);
98	1	if ($relation) {
99	1	if (is_string($value)) {
100	1	$value = $this->sdk->createProxy($value);
101	1	} elseif (is_array($value)) {
102	1	$targetEntity = $relation->getTargetEntity();
103	1	$relationClassMetadata = $this->mapping->getClassMetadata(
104	1	$targetEntity
105		);
106
107	1	if ($relation->isManyToOne()) {
108	1	$value = $this->deserialize(
109	1	$value,
110	1	$relationClassMetadata->getModelName()
111		);
112		} else {
113		// One-To-Many association
114	1	$list = [];
115	1	foreach ($value as $item) {
116	1	if (is_string($item)) {
117		$list[] = $this->sdk->createProxy(
118		$item
119		);
120	1	} elseif (is_array($item)) {
121	1	$list[] = $this->deserialize(
122	1	$item,
123	1	$relationClassMetadata->getModelName()
124		);
125		}
126		}
127
128	1	$value = $list;
129		}
130		}
131		}
132
133	1	if (isset($value)) {
134	1	if ('datetime' === $attribute->getType()) {
135	1	$value = new \DateTime($value);
136		}
137
138	1	$instance->{$setter}($value);
139		}
140		}
141		}
142		}
143
144	1	$classMetadata = $this->getClassMetadata($instance);
145	1	if ($classMetadata->hasIdentifierAttribute()) {
146	1	$idGetter = $classMetadata->getIdGetter();
147
148	1	if ($idGetter) {
149	1	$callable = [$instance, $idGetter];
150	1	$identifier = is_callable($callable)
151	1	? call_user_func($callable)
152	1	: null;
153
154	1	if ($identifier) {
155	1	$this->unitOfWork->registerClean($identifier, $instance);
156		}
157		}
158		}
159
160	1	return $instance;
161		}
162
163		/**
164		* If provided class name is abstract (a base class), the real class name (child class)
165		* may be available in some data fields.
166		*/
167		private function resolveRealClassName(
168		array $data,
169		string $className
170		): string {
171	1	if (!empty($data['@id'])) {
172	1	$classMetadata = $this->mapping->tryGetClassMetadataById(
173	1	$data['@id']
174		);
175
176	1	if ($classMetadata) {
177	1	return $classMetadata->getModelName();
178		}
179		}
180
181		// Real class name could also be retrieved from @type property.
182	1	return $className;
183		}
184
185		/**
186		* @return array\|string
187		*/
188		private function recursiveSerialize(
189		object $entity,
190		string $modelName,
191		int $level = 0,
192		array $context = []
193		) {
194	1	$classMetadata = $this->mapping->getClassMetadata($modelName);
195
196	1	if ($level > 0 && empty($context['serializeRelation'])) {
197	1	if ($classMetadata->hasIdentifierAttribute()) {
198	1	$tmpId = $entity->{$classMetadata->getIdGetter()}();
199	1	if ($tmpId) {
200	1	return $tmpId;
201		}
202		}
203		}
204
205	1	$attributeList = $classMetadata->getAttributeList();
206
207	1	$out = [];
208	1	if (!empty($attributeList)) {
209	1	foreach ($attributeList as $attribute) {
210	1	$method = 'get' . ucfirst($attribute->getAttributeName());
211
212	1	if ($attribute->isIdentifier() && !$entity->{$method}()) {
213	1	continue;
214		}
215	1	$relation = $classMetadata->getRelation(
216	1	$attribute->getSerializedKey()
217		);
218
219	1	$data = $entity->{$method}();
220
221		if (
222	1	null === $data &&
223	1	$relation &&
224	1	$relation->isManyToOne() &&
225	1	$level > 0
226		) {
227		/*
228		We only serialize the root many-to-one relations to prevent, hopefully,
229		unlinked and/or duplicated content. For instance, a cart with cartItemList containing
230		null values for the cart [{ cart => null, ... }] may lead the creation of
231		CartItem entities explicitly bound to a null Cart instead of the created/updated Cart.
232		*/
233	1	continue;
234	1	} elseif ($data instanceof \DateTime) {
235	1	$data = $data->format('c');
236	1	} elseif (is_object($data) && $data instanceof PhoneNumber) {
237	1	$phoneNumberUtil = PhoneNumberUtil::getInstance();
238	1	$data = $phoneNumberUtil->format(
239	1	$data,
240	1	PhoneNumberFormat::INTERNATIONAL
241		);
242		} elseif (
243	1	is_object($data) &&
244	1	$relation &&
245	1	$this->mapping->hasClassMetadata(
246	1	$relation->getTargetEntity()
247		)
248		) {
249	1	$relationClassMetadata = $this->mapping->getClassMetadata(
250	1	$relation->getTargetEntity()
251		);
252
253	1	if (!$relationClassMetadata->hasIdentifierAttribute()) {
254	1	$data = $this->recursiveSerialize(
255	1	$data,
256	1	$relation->getTargetEntity(),
257	1	$level + 1,
258	1	$context
259		);
260		} else {
261	1	$idAttribute = $relationClassMetadata->getIdentifierAttribute();
262		$idGetter =
263	1	'get' . ucfirst($idAttribute->getAttributeName());
264
265		if (
266	1	method_exists($data, $idGetter) &&
267	1	$data->{$idGetter}()
268		) {
269	1	$data = $data->{$idGetter}();
270	1	} elseif ($relation->isManyToOne()) {
271	1	if ($level > 0) {
272	1	continue;
273		} else {
274	1	throw new SdkException(
275	1	'Case not allowed for now'
276		);
277		}
278		}
279		}
280	1	} elseif (is_array($data)) {
281	1	$newData = [];
282	1	foreach ($data as $key => $item) {
283	1	if ($item instanceof \DateTime) {
284	1	$newData[$key] = $item->format('c');
285		} elseif (
286	1	is_object($item) &&
287	1	$relation &&
288	1	$this->mapping->hasClassMetadata(
289	1	$relation->getTargetEntity()
290		)
291		) {
292		$serializeRelation =
293	1	!empty($context['serializeRelations']) &&
294	1	in_array(
295	1	$relation->getSerializedKey(),
296	1	$context['serializeRelations']
297		);
298
299	1	$newData[$key] = $this->recursiveSerialize(
300	1	$item,
301	1	$relation->getTargetEntity(),
302	1	$level + 1,
303	1	['serializeRelation' => $serializeRelation]
304		);
305		} else {
306	1	$newData[$key] = $item;
307		}
308		}
309	1	$data = $newData;
310		}
311
312	1	$key = $attribute->getSerializedKey();
313
314	1	$out[$key] = $data;
315		}
316		}
317
318	1	return $out;
319		}
320
321		private function getClassMetadataFromId(string $id): ?ClassMetadata
322		{
323		$key = $this->mapping->getKeyFromId($id);
324
325		return $this->mapping->getClassMetadataByKey($key);
326		}
327
328		private function getClassMetadata(object $entity): ClassMetadata
329		{
330	1	return $this->mapping->getClassMetadata(get_class($entity));
331		}
332		}
333

mapado / rest-client-sdk

Pull Request — master (#88)

Serializer::setSdk() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like