W2w\Lib\Apie\Core\Models\ApiResourceFacadeResponse

Complexity

Total Complexity

10

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getResponse()	0	13	2
A	getSerializer()	0	3	1
A	runLifeCycleEvent()	0	4	2
A	getAcceptHeader()	0	3	1
A	__construct()	0	10	1
A	getResource()	0	3	1
A	getNormalizedData()	0	9	2

<?php

namespace W2w\Lib\Apie\Core\Models;

use Psr\Http\Message\ResponseInterface;
use W2w\Lib\Apie\Apie;
use W2w\Lib\Apie\Core\SearchFilters\SearchFilterRequest;
use W2w\Lib\Apie\Events\NormalizeEvent;
use W2w\Lib\Apie\Events\ResponseEvent;
use W2w\Lib\Apie\Interfaces\ResourceSerializerInterface;
use W2w\Lib\Apie\PluginInterfaces\ResourceLifeCycleInterface;

/**
 * Data class returned by ApiResourceFacade.
 */
class ApiResourceFacadeResponse
{
    /**
     * @var ResourceSerializerInterface
     */
    private $serializer;

    /**
     * @var mixed
     */
    private $resource;

    /**
     * @var string|null
     */
    private $acceptHeader;

    /**
     * @var iterable<ResourceLifeCycleInterface>
     */
    private $resourceLifeCycles;

    /**
     * @param ResourceSerializerInterface $serializer
     * @param mixed $resource
     * @param string|null $acceptHeader
     * @param ResourceLifeCycleInterface[]
     */
    public function __construct(
        ResourceSerializerInterface $serializer,
        $resource,
        ?string $acceptHeader,
        iterable $resourceLifeCycles = []
    ) {
        $this->serializer = $serializer;
        $this->resource = $resource;
        $this->acceptHeader = $acceptHeader;
        $this->resourceLifeCycles = $resourceLifeCycles;
    }

    /**
     * Helper method to call the method on all all lifecycle instances.
     *
     * @param string $event
     * @param mixed[] $args
     */
    protected function runLifeCycleEvent(string $event, ...$args)
    {
        foreach ($this->resourceLifeCycles as $resourceLifeCycle) {
            $resourceLifeCycle->$event(...$args);
        }
    }

    /**
     * @return mixed
     */
    public function getResource()
    {
        return $this->resource;
    }

    /**
     * @return ResponseInterface
     */
    public function getResponse(): ResponseInterface
    {
        $event = new ResponseEvent($this->resource, $this->acceptHeader ?? 'application/json');
        $this->runLifeCycleEvent('onPreCreateResponse', $event);
        if (!$event->getResponse()) {
            $event->setResponse(
                $this->serializer->toResponse($this->resource, $this->getAcceptHeader())
                    ->withHeader('x-apie', Apie::VERSION)
            );
        }
        $this->runLifeCycleEvent('onPostCreateResponse', $event);

        return $event->getResponse();

The expression return $event->getResponse() could return the type null which is incompatible with the type-hinted return Psr\Http\Message\ResponseInterface. Consider adding an additional type-check to rule them out.

    }

    /**
     * Gets data the way we would send it normalized.
     *
     * @return mixed
     */
    public function getNormalizedData()
    {
        $event = new NormalizeEvent($this->resource, $this->acceptHeader ?? 'application/json');
        $this->runLifeCycleEvent('onPreCreateNormalizedData', $event);
        if (!$event->hasNormalizedData()) {
            $event->setNormalizedData($this->serializer->normalize($this->resource, $this->getAcceptHeader()));
        }
        $this->runLifeCycleEvent('onPostCreateNormalizedData', $event);
        return $event->getNormalizedData();
    }

    /**
     * Get the accept header.
     *
     * @return string|null
     */
    public function getAcceptHeader(): ?string
    {
        return $this->acceptHeader ?? 'application/json';
    }

    /**
     * Get the serializer.
     *
     * @return ResourceSerializerInterface
     */
    protected function getSerializer(): ResourceSerializerInterface
    {
        return $this->serializer;
    }
}