willdurand / Hateoas

src/Hateoas/Serializer/Metadata/InlineDeferrer.php

<?php

namespace Hateoas\Serializer\Metadata;

use Hateoas\Serializer\JMSSerializerMetadataAwareInterface;
use JMS\Serializer\SerializationContext;
use Metadata\MetadataFactory;
use Metadata\MetadataFactoryInterface;

/**
 * @author Adrien Brault <adrien.brault@gmail.com>
 */
class InlineDeferrer implements JMSSerializerMetadataAwareInterface
{
    /**
     * @var MetadataFactory
     */
    protected $serializerMetadataFactory;

    /**
     * @var \SplObjectStorage
     */
    protected $deferredData;

    public function __construct(MetadataFactory $serializerMetadataFactory = null)
    {
        $this->serializerMetadataFactory = $serializerMetadataFactory;
        $this->deferredData = new \SplObjectStorage();
    }

    /**
     * {@inheritdoc}
     */
    public function setMetadataFactory(MetadataFactoryInterface $metadataFactory)
    {
        $this->serializerMetadataFactory = $metadataFactory;

$metadataFactory is of type object<Metadata\MetadataFactoryInterface>, but the property $serializerMetadataFactory was declared to be of type object<Metadata\MetadataFactory>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

    }

    public function handleItems($object, array $items, SerializationContext $context)
    {
        if ($this->deferredData->contains($object)) {
            $items = array_merge($this->deferredData->offsetGet($object), $items);
            $this->deferredData->detach($object);
        }

        $parentObjectInlining = $this->getParentObjectInlining($object, $context);
        if (null === $parentObjectInlining) {
            return $items;
        }

        if ($this->deferredData->contains($parentObjectInlining)) {
            $items = array_merge($items, $this->deferredData->offsetGet($parentObjectInlining));
        }

        // We need to defer the links serialization to the $parentObject
        $this->deferredData->attach($parentObjectInlining, $items);

        return array();
    }

    private function getParentObjectInlining($object, SerializationContext $context)
    {
        $metadataStack = $context->getMetadataStack();
        $visitingStack = $context->getVisitingStack();

        $parentObject = null;
        if (count($visitingStack) > 0) {
            $parentObject = $visitingStack[0];
        }
        if ($parentObject === $object && count($visitingStack) > 1) {
            $parentObject = $visitingStack[1]; // $object is inlined inside $parentObject
        }

        if (
            $metadataStack->count() > 0 && isset($metadataStack[0]->inline) && $metadataStack[0]->inline
            && $this->serializerMetadataFactory->getMetadataForClass(get_class($parentObject)) === $metadataStack[1]
        ) {
            return $parentObject;
        }

        return null;
    }
}