NilPortugues\Api\JsonApi\Server\Actions\Traits\ResponseTrait

Complexity

Total Complexity

12

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes	1
Bugs	0	Features	1

11 Methods

Rating	Name	Duplication	Size	Complexity
A	errorResponse()	0	4	1
A	addHeaders()	0	4	1
A	resourceCreated()	0	4	1
A	resourceDeleted()	0	4	1
A	resourceNotFound()	0	4	1
A	resourceConflicted()	0	4	1
A	resourceProcessing()	0	4	1
A	resourceUpdated()	0	4	1
A	response()	0	8	2
A	unsupportedAction()	0	4	1
A	unprocessableEntity()	0	4	1

<?php
/**
 * Author: Nil Portugués Calderó <contact@nilportugues.com>
 * Date: 8/18/15
 * Time: 11:19 PM.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace NilPortugues\Api\JsonApi\Server\Actions\Traits;

use NilPortugues\Api\JsonApi\Http\PaginatedResource;
use NilPortugues\Api\JsonApi\Http\Response\BadRequest;
use NilPortugues\Api\JsonApi\Http\Response\ResourceConflicted;
use NilPortugues\Api\JsonApi\Http\Response\ResourceCreated;
use NilPortugues\Api\JsonApi\Http\Response\ResourceDeleted;
use NilPortugues\Api\JsonApi\Http\Response\ResourceNotFound;
use NilPortugues\Api\JsonApi\Http\Response\ResourceProcessing;
use NilPortugues\Api\JsonApi\Http\Response\ResourceUpdated;
use NilPortugues\Api\JsonApi\Http\Response\Response;
use NilPortugues\Api\JsonApi\Http\Response\UnprocessableEntity;
use NilPortugues\Api\JsonApi\Http\Response\UnsupportedAction;
use NilPortugues\Api\JsonApi\Server\Errors\ErrorBag;
use Psr\Http\Message\ResponseInterface;
use Symfony\Bridge\PsrHttpMessage\Factory\HttpFoundationFactory;

trait ResponseTrait
{
    /**
     * @param ErrorBag $errorBag
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function errorResponse(ErrorBag $errorBag)
    {
        return (new HttpFoundationFactory())->createResponse($this->addHeaders(new BadRequest($errorBag)));
    }

    /**
     * @param ResponseInterface $response
     *
     * @return ResponseInterface
     */
    protected function addHeaders(ResponseInterface $response)
    {
        return $response;
    }

    /**
     * @param string $json
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function resourceCreated($json)
    {
        return (new HttpFoundationFactory())->createResponse($this->addHeaders(new ResourceCreated($json)));
    }

    /**
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function resourceDeleted()
    {
        return (new HttpFoundationFactory())->createResponse($this->addHeaders(new ResourceDeleted()));
    }

    /**
     * @param ErrorBag $errorBag
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function resourceNotFound(ErrorBag $errorBag)
    {
        return (new HttpFoundationFactory())->createResponse($this->addHeaders(new ResourceNotFound($errorBag)));
    }

    /**
     * @param ErrorBag $errorBag
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function resourceConflicted(ErrorBag $errorBag)
    {
        return (new HttpFoundationFactory())->createResponse($this->addHeaders(new ResourceConflicted($errorBag)));
    }

    /**
     * @param string $json
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function resourceProcessing($json)
    {
        return (new HttpFoundationFactory())->createResponse($this->addHeaders(new ResourceProcessing($json)));
    }

    /**
     * @param string $json
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function resourceUpdated($json)
    {
        return (new HttpFoundationFactory())->createResponse($this->addHeaders(new ResourceUpdated($json)));
    }

    /**
     * @param string|PaginatedResource $json
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function response($json)
    {
        if ($json instanceof PaginatedResource) {
            $json = json_encode($json);
        }

        return (new HttpFoundationFactory())->createResponse($this->addHeaders(new Response($json)));
    }

    /**
     * @param ErrorBag $errorBag
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function unsupportedAction(ErrorBag $errorBag)
    {
        return (new HttpFoundationFactory())->createResponse($this->addHeaders(new UnsupportedAction($errorBag)));
    }

    /**
     * @param ErrorBag $errorBag
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function unprocessableEntity(ErrorBag $errorBag)
    {
        return (new HttpFoundationFactory())->createResponse($this->addHeaders(new UnprocessableEntity($errorBag)));
    }
}