skqr/hateoas

<?php
/**
 * @copyright 2014 Integ S.A.
 * @license http://opensource.org/licenses/MIT The MIT License (MIT)
 * @author Javier Lorenzana <javier.lorenzana@gointegro.com>
 */

namespace GoIntegro\Hateoas\JsonApi;

// Interfaces.
use GoIntegro\Hateoas\JsonApi\ResourceEntityInterface;
// HTTP.
use GoIntegro\Hateoas\JsonApi\Request\Parser as RequestParser;
// JSON-API.
use GoIntegro\Hateoas\JsonApi\Request\Params;

class DocumentFactory implements Factory
{
    const ERROR_PARAMS_MISSING = "The request params object was not set.";

    /**
     * @var ResourceCache
     */
    private $resourceCache;
    /**
     * @var DocumentResource
     */
    private $documentResource;
    /**
     * @var array
     * @see http://jsonapi.org/format/#fetching-includes
     */
    private $include = [];
    /**
     * @var array
     * @see http://jsonapi.org/format/#fetching-sparse-fieldsets
     */
    private $fields = [];
    /**
     * @var array
     * @see http://jsonapi.org/format/#document-structure-top-level
     */
    private $meta = [];
    /**
     * @var Params
     */
    private $params;

    /**
     * @param ResourceCache $resourceCache
     */
    public function __construct(ResourceCache $resourceCache)
    {
        $this->resourceCache = $resourceCache;
    }

    /**
     * @param DocumentResource $resource
     * @return self
     */
    public function setResources(DocumentResource $documentResource)
    {
        $this->documentResource = $documentResource;

        return $this;
    }

    /**
     * @param array $include
     * @return self
     */
    public function setInclude(array $include)
    {
        $this->include = $include;

        return $this;
    }

    /**
     * @param array $fields
     * @return self
     */
    public function setFields(array $fields)
    {
        $this->fields = $fields;

        return $this;
    }

    /**
     * @param Params $params
     * @return self
     */
    public function setParams(Params $params)
    {
        $this->params = $params;

        return $this;
    }

    /**
     * @param array $meta
     * @return self
     */
    public function addMeta(array $meta)
    {
        $this->meta[] = $meta;

        return $this;
    }

    /**
     * @return ResourceSerializer
     */
    public function create()
    {
        $include = NULL;
        $fields = NULL;

        if (empty($this->params)) {
            throw new \ErrorException(self::ERROR_PARAMS_MISSING);
        }

        if (empty($this->fields) || empty($this->include)) {
            if (empty($this->include)) {
                $include = $this->params->include;
            }

            if (empty($this->fields)) {
                $fields = $this->params->sparseFields;
            }
        }

        $document = new Document(
            $this->documentResource,
            $this->resourceCache,
            $include,
            $fields,
            $this->params->pagination,
            $this->params->i18n
        );

        foreach ($this->meta as $meta) {
            $document->addResourceMeta($this->documentResource, $meta);
        }

        return $document;
    }
}