bytic / dispatcher

src/Dispatcher.php

<?php
declare(strict_types=1);

namespace Nip\Dispatcher;

use Exception;
use Nip\Container\Container;
use Nip\Container\ContainerAwareTrait;
use Nip\Dispatcher\Commands\Command;
use Nip\Dispatcher\Commands\CommandFactory;
use Nip\Dispatcher\Configuration\HasConfigurationTrait;
use Nip\Dispatcher\Exceptions\ForwardException;
use Nip\Dispatcher\Resolver\ClassResolver\NameGenerator;
use Nip\Dispatcher\Resolver\HasResolverPipelineTrait;
use Nip\Dispatcher\Resolver\Pipeline\InstanceBuilder;
use Nip\Dispatcher\Traits\HasCommandsCollection;
use Nip\Dispatcher\Traits\HasRequestTrait;
use Nip\Http\Request;
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\HttpFoundation\Response;

/**
 * Class Dispatcher.
 */
class Dispatcher
{
    use ContainerAwareTrait;
    use HasConfigurationTrait;
    use HasResolverPipelineTrait;
    use HasRequestTrait;
    use HasCommandsCollection;

    /**
     * Create a new controller dispatcher instance.
     *
     * @param  Container $container
     *
     *
     * @return void
     */
    public function __construct(Container $container = null)
    {
        if ($container instanceof Container) {
            $this->setContainer($container);
        }
    }

    /**
     * @param Request|null $request
     * @return ResponseInterface
     * @throws Exception
     *
     * @return null|Response
     */
    public function dispatch(Request $request = null)
    {
        NameGenerator::instance()->addNamespaces($this->getConfiguration()->getNamespaces());
        if ($request) {
            $this->setRequest($request);
        }

        $command = CommandFactory::createFromRequest($request);

It seems like $request can also be of type null; however, parameter $request of Nip\Dispatcher\Commands\CommandFactory::createFromRequest() does only seem to accept Psr\Http\Message\ServerRequestInterface, maybe add an additional type check?

        return $this->dispatchCommand($command)->getReturn();

Are you sure the usage of $this->dispatchCommand($command)->getReturn() targeting Nip\Dispatcher\Commands\Command::getReturn() seems to always return null.

    }


    /**
     * @param $action
     * @param array $params
     * @return mixed
     * @throws Exception
     */
    public function call($action, $params = [])
    {
        $action = is_array($action) ? $action : ['controller' => $action];
        $command = CommandFactory::createFromAction($action);
        if (isset($params['_request'])) {
            $command->setRequest($params['_request']);
            unset($params['_request']);
        }
        $command->setActionParam('params', $params);
        return $this->getResolverPipeline(InstanceBuilder::class)
            ->process($command)
            ->getReturn();
    }

    /**
     * @param Request|null $request
     * @param array $params
     * @return
     * @throws Exception
     */
    public function callFromRequest(Request $request = null, $params = [])
    {
        $command = CommandFactory::createFromRequest($request);

It seems like $request can also be of type null; however, parameter $request of Nip\Dispatcher\Commands\CommandFactory::createFromRequest() does only seem to accept Psr\Http\Message\ServerRequestInterface, maybe add an additional type check?

        $command->setActionParam('params', $params);
        return $this->getResolverPipeline(InstanceBuilder::class)
            ->process($command)
            ->getReturn();
    }

    /**
     * @param Command $command
     * @return Command
     */
    public function dispatchCommand(Command $command)
    {
        $this->getCommandsCollection()[] = $command;


        try {
            return $this->processCommand($command);
        } catch (ForwardException $exception) {
            $command = CommandFactory::createFromForwardException($exception);
            $command->setRequest($this->getRequest());
            return $this->dispatchCommand($command);
        }
    }

    /**
     * @param bool $params
     * @throws ForwardException
     */
    public function throwError($params = false)

The parameter $params is not used and could be removed.

    {
//        $this->getFrontController()->getTrace()->add($params);
        $this->setErrorController();
        $this->forward('index');

'index' of type string is incompatible with the type boolean expected by parameter $action of Nip\Dispatcher\Dispatcher::forward().

    }

    /**
     * @return $this
     */
    public function setErrorController()
    {
        $this->getRequest()->setActionName('index');
        $this->getRequest()->setControllerName('error');
        $this->getRequest()->setModuleName('default');

        return $this;
    }

    /**
     * @param bool  $action
     * @param bool  $controller
     * @param bool  $module
     * @param array $params
     *
     * @throws ForwardException
     */
    public function forward($action = false, $controller = false, $module = false, $params = [])
    {
        $this->getRequest()->setActionName($action);

        if ($controller) {
            $this->getRequest()->setControllerName($controller);

$controller of type true is incompatible with the type string expected by parameter $value of Nip\Http\Request::setControllerName().

        }
        if ($module) {
            $this->getRequest()->setModuleName($module);

$module of type true is incompatible with the type string expected by parameter $value of Nip\Http\Request::setModuleName().

        }

        if (is_array($params)) {

The condition is_array($params) is always true.

            $this->getRequest()->attributes->add($params);
        }

        throw new ForwardException();
    }
}