Nip\Dispatcher\Dispatcher

Complexity

Total Complexity

21

Size/Duplication

Total Lines	188
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	10

Test Coverage

Coverage

14.29%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	dispatch()	0	9	2
A	call()	0	13	3
A	callFromRequest()	0	8	1
A	dispatchCommand()	0	14	2
A	throwError()	0	6	1
A	setErrorController()	0	8	1
A	forward()	0	17	4
A	generateFullControllerNameNamespace()	0	9	2
A	isValidControllerNamespace()	0	4	1
A	getAutoloader()	0	4	1
A	generateFullControllerNameString()	0	4	1

<?php

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\Exceptions\ForwardException;
use Nip\Dispatcher\Resolver\HasResolverPipelineTrait;
use Nip\Dispatcher\Resolver\Pipeline\InstanceBuilder;
use Nip\Dispatcher\Traits\HasCommandsCollection;
use Nip\Dispatcher\Traits\HasRequestTrait;
use Nip\Request;
use Psr\Http\Message\ResponseInterface;

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

    /**
     * Create a new controller dispatcher instance.
     *
     * @param  Container $container
     *
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    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)
    {
        if ($request) {
            $this->setRequest($request);
        }

        $command = CommandFactory::createFromRequest($request);
        return $this->dispatchCommand($command)->getReturn();
    }


    /**
     * @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);
        $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::createFromForwardExecption($exception);
            $return = $this->dispatchCommand($command);

            return $return;
        }
    }

    /**
     * @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' is of type string, but the function expects a boolean.

    }

    /**
     * @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);

$action is of type boolean, but the function expects a string.

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

$controller is of type boolean, but the function expects a string.

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

$module is of type boolean, but the function expects a string.

        }

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

        throw new ForwardException();
    }

    /**
     * @param $module
     * @param $controller
     *
     * @return string
     */
    protected function generateFullControllerNameNamespace($module, $controller)
    {
        $name = app()->get('kernel')->getRootNamespace().'Modules\\';
        $module = $module == 'Default' ? 'Frontend' : $module;
        $name .= $module.'\Controllers\\';
        $name .= str_replace('_', '\\', $controller).'Controller';

        return $name;
    }

    /**
     * @param string $namespaceClass
     *
     * @return bool
     */
    protected function isValidControllerNamespace($namespaceClass)
    {
        return class_exists($namespaceClass);
    }

    /**
     * @return \Nip\AutoLoader\AutoLoader
     */
    protected function getAutoloader()
    {
        return app('autoloader');
    }

    /**
     * @param $module
     * @param $controller
     *
     * @return string
     */
    protected function generateFullControllerNameString($module, $controller)
    {
        return $module.'_'.$controller.'Controller';
    }
}