Mikemirten\Component\JsonApi\Mapper\ObjectMapper

Complexity

Total Complexity

6

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	addHandler()	0	4	1
A	toResource()	0	14	2
A	fromResource()	0	9	2

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Mapper;

use Mikemirten\Component\JsonApi\Document\ResourceObject;
use Mikemirten\Component\JsonApi\Mapper\Handler\HandlerInterface;
use Mikemirten\Component\JsonApi\Mapper\Handler\IdentifierHandler\IdentifierHandlerInterface;
use Mikemirten\Component\JsonApi\Mapper\Handler\TypeHandler\TypeHandlerInterface;

/**
 * Object mapper.
 *
 * Maps data between object and resource of document.
 * Can be helpful for serialization of objects to JSON API document.
 *
 * Each handler responsible for certain part of resource (links, metadata, relationships...).
 * Identifier and type handlers are specific and required to resolve id and type of resource.
 * Other handlers are optional.
 *
 * @package Mikemirten\Component\JsonApi\Mapper
 */
class ObjectMapper
{
    /**
     * Required identifier handler
     * Must always be present regardless of other handlers
     *
     * @var IdentifierHandlerInterface
     */
    protected $identifierHandler;

    /**
     * Required type handler
     * Must always be present regardless of other handlers
     *
     * @var TypeHandlerInterface
     */
    protected $typeHandler;

    /**
     * Mapping handlers
     *
     * @var HandlerInterface[]
     */
    protected $handlers = [];

    /**
     * ObjectMapper constructor.
     *
     * @param IdentifierHandlerInterface $identifierHandler
     * @param TypeHandlerInterface       $typeHandler
     */
    public function __construct(IdentifierHandlerInterface $identifierHandler, TypeHandlerInterface $typeHandler)
    {
        $this->identifierHandler = $identifierHandler;
        $this->typeHandler       = $typeHandler;
    }

    /**
     * Add mapping handler
     *
     * @param HandlerInterface $handler
     */
    public function addHandler(HandlerInterface $handler)
    {
        $this->handlers[] = $handler;
    }

    /**
     * Map object's data to resource
     *
     * @param  mixed $object
     * @return ResourceObject
     */
    public function toResource($object): ResourceObject
    {
        $id   = $this->identifierHandler->getIdentifier($object);
        $type = $this->typeHandler->getType($object);

        $resource = new ResourceObject($id, $type);

        foreach ($this->handlers as $handler)
        {
            $handler->toResource($object, $resource);
        }

        return $resource;
    }

    /**
     * Map resource's data to provided object
     *
     * @param mixed $object
     * @param ResourceObject $resource
     */
    public function fromResource($object, ResourceObject $resource)
    {
        $this->identifierHandler->setIdentifier($object, $resource->getId());

        foreach ($this->handlers as $handler)
        {
            $handler->fromResource($object, $resource);
        }
    }
}