Serializer::resolveRealClassName() - Code Metrics - Inspection of "Merge pull request #72 from mapado/jd-feat-scrutin..." - mapado/rest-client-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 7067f6...c51298 )

by Julien
created 2018-03-31 22:46 UTC
Serializer::resolveRealClassName() A

↳ Parent: Serializer
Complexity

Conditions	3
Paths	3
Size

Total Lines	13
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	5
CRAP Score	3
Importance

Changes
Metric	Value
cc	3
eloc	5
nc	3
nop	2
dl	0
loc	13
ccs	5
cts	5
cp	1
crap	3
rs	9.4285
c	0
b	0
f	0
<?php

namespace Mapado\RestClientSdk\Model;

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
     * @access private
     */
    private $mapping;

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

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

    /**
     * Constructor.
     *
     * @param Mapping $mapping
     * @access public
     */
    public function __construct(Mapping $mapping, UnitOfWork $unitOfWork)
    {
        $this->mapping = $mapping;
        $this->unitOfWork = $unitOfWork;
    }

    /**
     * setSdk
     *
     * @param SdkClient $sdk
     * @access public
     * @return Serializer
     */
    public function setSdk(SdkClient $sdk)
    {
        $this->sdk = $sdk;
        return $this;
    }

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

    /**
     * deserialize
     *
     * @param array  $data
     * @param string $className
     * @access public
     * @return object
     */
    public function deserialize(array $data, $className)
    {
        $className = $this->resolveRealClassName($data, $className);

        $classMetadata = $this->mapping->getClassMetadata($className);
        $identifierAttribute = $classMetadata->getIdentifierAttribute();
        $identifierAttrKey = $identifierAttribute ? $identifierAttribute->getSerializedKey() : null;


        $attributeList = $classMetadata->getAttributeList();

        $instance = new $className();

        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);
                        $value = $this->sdk->createProxy($value);
                    } elseif (is_array($value)) {
                        if (isset($value[$identifierAttrKey])) {
                            $key = $this->mapping->getKeyFromId($value[$identifierAttrKey]);

                            $subClassMetadata = $this->getClassMetadataFromId($value[$identifierAttrKey]);
                            $value = $this->deserialize($value, $subClassMetadata->getModelName());
                        } else {
                            $list = [];
                            foreach ($value as $item) {
                                if (is_string($item)) {
                                    $list[] = $this->sdk->createProxy($item);
                                } elseif (is_array($item) && isset($item[$identifierAttrKey])) {
                                    // not tested for now
                                    // /the $identifierAttrKey is not the real identifier, as it is
                                    // the main object identifier, but we do not have the metadada for now
                                    // the thing we assume now is that every entity "may" have the same key
                                    // as identifier
                                    $key = $this->mapping->getKeyFromId($item[$identifierAttrKey]);
                                    $subClassMetadata = $this->getClassMetadataFromId($item[$identifierAttrKey]);
                                    $list[] = $this->deserialize($item, $subClassMetadata->getModelName());
                                }
                            }

                            $value = $list;
                        }
                    }
                }

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

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

        $identifier = $instance->{$this->getClassMetadata($instance)->getIdGetter()}();
        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.
     *
     * @param array  $data
     * @param string $className
     * @access private
     * @return string
     */
    private function resolveRealClassName(array $data, $className)
    {
        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;
    }

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

        if ($level > 0 && empty($context['serializeRelation'])) {
            $idAttribute = $classMetadata->getIdentifierAttribute();
            $getter = 'get' . ucfirst($idAttribute->getAttributeName());
            $tmpId = $entity->{$getter}();
            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 \libphonenumber\PhoneNumber) {
                    $phoneNumberUtil = PhoneNumberUtil::getInstance();
                    $data = $phoneNumberUtil->format(
                        $data,
                        PhoneNumberFormat::INTERNATIONAL
                    );
                } elseif (is_object($data)
                    && $relation
                    && $this->mapping->hasClassMetadata($relation->getTargetEntity())
                ) {
                    $idAttribute = $this->mapping
                        ->getClassMetadata($relation->getTargetEntity())
                        ->getIdentifierAttribute()
                        ->getAttributeName();
                    $idGetter = 'get' . ucfirst($idAttribute);

                    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;
    }

    /**
     * getClassMetadataFromId
     *
     * @param string $id
     * @access private
     * @return ClassMetadata|null
     */
    private function getClassMetadataFromId($id)
    {
        $key = $this->mapping->getKeyFromId($id);
        $classMetadata = $this->mapping->getClassMetadataByKey($key);
        return $classMetadata;
    }

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

mapado / rest-client-sdk

Push — master ( 7067f6...c51298 )

Serializer::resolveRealClassName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
