Jasny\Controller\Traits\Base

Complexity

Total Complexity

8

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getRequest()	0	7	2
A	setResponse()	0	3	1
A	getFunctionArgs()	0	22	3
A	getResponse()	0	7	2

<?php

Missing file doc comment

namespace Jasny\Controller\Traits;

use Jasny\Controller\Parameter\Parameter;
use Jasny\Controller\Parameter\PathParam;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

/**
 * Base methods for controller and guard.
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait Base
{
    private ServerRequestInterface $request;

Private member variable "request" must be prefixed with an underscore

    private ResponseInterface $response;

Private member variable "response" must be prefixed with an underscore

    /**
     * Get request, set for controller
     */

Missing @return tag in function comment

    protected function getRequest(): ServerRequestInterface
    {
        if (!isset($this->request)) {
            throw new \LogicException("Request not set, " . __CLASS__ . " has not been invoked"); // @codeCoverageIgnore
        }

        return $this->request;
    }

    /**
     * Get response, set for controller
     */

Missing @return tag in function comment

    protected function getResponse(): ResponseInterface
    {
        if (!isset($this->response)) {
            throw new \LogicException("Response not set, " . __CLASS__ . " has not been invoked"); // @codeCoverageIgnore
        }

        return $this->response;
    }

    /**

Parameter $response should have a doc-comment as per coding-style.

     * Set the response
     */

Missing @return tag in function comment

    protected function setResponse(ResponseInterface $response): void
    {
        $this->response = $response;
    }


    /**

Parameter $refl should have a doc-comment as per coding-style.

     * Get the arguments for a function from a route using reflection.
     */

Missing @return tag in function comment

    protected function getFunctionArgs(\ReflectionFunctionAbstract $refl): array
    {
        $args = [];

        foreach ($refl->getParameters() as $param) {
            [$argRefl] = $param->getAttributes(
                Parameter::class,
                \ReflectionAttribute::IS_INSTANCEOF
            ) + [null];
            $attribute = $argRefl?->newInstance() ?? new PathParam();

            $type = $param->getType();

            $args[] = $attribute->getValue(
                $this->request,
                $param->getName(),
                $type instanceof \ReflectionNamedType ? $type->getName() : null,
                !$param->isOptional(),
            ) ?? $param->getDefaultValue();
        }

        return $args;
    }
}