bytic / controllers

src/Response/ResponsePayloadTransformer.php

<?php

declare(strict_types=1);

namespace Nip\Controllers\Response;

use Nip\Controllers\Controller;
use Nip\Controllers\Traits\HasResponseTrait;
use Nip\Controllers\Traits\HasViewTrait;
use Nip\Controllers\View\ControllerViewHydrator;
use Nip\Http\Response\JsonResponse;
use Nip\Http\Response\Response;
use Nip\Utility\Str;

/**
 * Class ResponsePayloadTransformer
 * @package Nip\Controllers\Response
 */
class ResponsePayloadTransformer
{
    /**
     * @var Controller|HasViewTrait
     */
    protected $controller;

    protected $payload;
    protected $factory;

    /**
     * @param Controller|HasResponseTrait $controller
     * @param ResponsePayload $payload
     * @return Response
     */
    public static function make($controller, ResponsePayload $payload)
    {
        $transformer = new static($controller, $payload);

        return $transformer->toResponse();

The expression return $transformer->toResponse() also could return the type Nip\Http\Response\JsonResponse which is incompatible with the documented return type Nip\Http\Response\Response.

    }

    /**
     * ResponsePayloadTransformer constructor.
     * @param Controller $controller
     * @param ResponsePayload $payload
     */
    protected function __construct($controller, ResponsePayload $payload)
    {
        $this->controller = $controller;
        $this->payload = $payload;

        $this->factory = new ResponseFactory();
    }


    /**
     * @return Response|JsonResponse
     */
    protected function toResponse()
    {
        $controllerMethod = $this->responseControllerMethod();
        if (method_exists($this->controller, $controllerMethod)) {
            return call_user_func_array([$this->controller, $controllerMethod], [$this->factory, $this->payload]);
        }
        $format = $this->payload->getFormat();
        switch ($format) {
            case 'view':
            case 'html':
            case 'modal':
                return $this->toViewResponse($format);
            case 'json':
                return $this->factory->json($this->payload->all());
        }

        return $this->factory->noContent();
    }

    /**
     * @return Response
     */
    protected function toViewResponse($format): Response
    {
        $view = $this->controller->getView();

The method getView() does not exist on Nip\Controllers\Controller. Since you implemented __call, consider adding a @method annotation.

        ControllerViewHydrator::populatePath($view, $this->controller);

It seems like $this->controller can also be of type Nip\Controllers\Traits\HasViewTrait; however, parameter $controller of Nip\Controllers\View\ControllerViewHydrator::populatePath() does only seem to accept Nip\Controllers\Controller, maybe add an additional type check?

        ControllerViewHydrator::initVars($view, $this->controller);

It seems like $this->controller can also be of type Nip\Controllers\Traits\HasViewTrait; however, parameter $controller of Nip\Controllers\View\ControllerViewHydrator::initVars() does only seem to accept Nip\Controllers\Controller|null, maybe add an additional type check?

        ControllerViewHydrator::initContentBlocks($view, $this->controller);

It seems like $view can also be of type boolean; however, parameter $view of Nip\Controllers\View\ControllerViewHydrator::initContentBlocks() does only seem to accept Nip\View\View, maybe add an additional type check?

        $this->factory->setView($view);

It seems like $view can also be of type boolean; however, parameter $view of Nip\Controllers\Response\ResponseFactory::setView() does only seem to accept Nip\View\View|null, maybe add an additional type check?

        $this->payload->headers->set('Content-Type', 'text/html');

        $viewPath = $format == 'modal' ? '/' . trim($view->getBlock('content'), '/') : $this->controller->getLayoutPath(

The method getLayoutPath() does not exist on Nip\Controllers\Controller. Since you implemented __call, consider adding a @method annotation.

It seems like $view->getBlock('content') can also be of type null; however, parameter $string of trim() does only seem to accept string, maybe add an additional type check?

        );

        $response = $this->factory->view(
            $viewPath,
            $this->payload->data->all(),
            Response::HTTP_OK,
            $this->payload->headers->all()
        );

        $response->setCharset('utf-8');
        return $response;
    }

    protected function responseControllerMethod(): string
    {
        return $this->controller->getAction()
            . Str::studly($this->payload->getFormat())
            . 'Response';
    }
}