Dispatcher::callFromRequest() - Code Metrics - Inspection of "Merge branch '0.9' of https://github.com/bytic/dis..." - bytic/dispatcher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d68f4d...84e19d )

by Gabriel

created 2020-05-12 12:25 UTC

Dispatcher::callFromRequest() A

↳ Parent: Dispatcher

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	1
cts	1
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	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

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

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

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @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);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        if ($controller) {
            $this->getRequest()->setControllerName($controller);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        if ($module) {
            $this->getRequest()->setModuleName($module);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        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';
    }
}


1		<?php
2
3		namespace Nip\Dispatcher;
4
5		use Exception;
6		use Nip\Container\Container;
7		use Nip\Container\ContainerAwareTrait;
8		use Nip\Dispatcher\Commands\Command;
9		use Nip\Dispatcher\Commands\CommandFactory;
10		use Nip\Dispatcher\Exceptions\ForwardException;
11		use Nip\Dispatcher\Resolver\HasResolverPipelineTrait;
12		use Nip\Dispatcher\Resolver\Pipeline\InstanceBuilder;
13		use Nip\Dispatcher\Traits\HasCommandsCollection;
14		use Nip\Dispatcher\Traits\HasRequestTrait;
15		use Nip\Request;
16		use Psr\Http\Message\ResponseInterface;
17
18		/**
19		* Class Dispatcher.
20		*/
21		class Dispatcher
22		{
23		use ContainerAwareTrait;
24		use HasResolverPipelineTrait;
25		use HasRequestTrait;
26		use HasCommandsCollection;
27
28		/**
29		* Create a new controller dispatcher instance.
30		*
31		* @param Container $container
32		*
33		*
34	4	* @return void
		0 ignored issues – show Comprehensibility Best Practice introduced 2020-05-12 12:36 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
35		*/
36	4	public function __construct(Container $container = null)
37		{
38		if ($container instanceof Container) {
39	4	$this->setContainer($container);
40		}
41		}
42
43		/**
44		* @param Request\|null $request
45		* @return ResponseInterface
46		* @throws Exception
47		*
48		* @return null\|Response
49		*/
50		public function dispatch(Request $request = null)
51		{
52		if ($request) {
53		$this->setRequest($request);
54		}
55
56		$command = CommandFactory::createFromRequest($request);
57		return $this->dispatchCommand($command)->getReturn();
58		}
59
60
61		/**
62		* @param $action
63		* @param array $params
64		* @return mixed
65		* @throws Exception
66		*/
67		public function call($action, $params = [])
68		{
69		$action = is_array($action) ? $action : ['controller' => $action];
70		$command = CommandFactory::createFromAction($action);
71		if (isset($params['_request'])) {
72		$command->setRequest($params['_request']);
73		unset($params['_request']);
74		}
75		$command->setActionParam('params', $params);
76		return $this->getResolverPipeline(InstanceBuilder::class)
77		->process($command)
78		->getReturn();
79		}
80
81		/**
82		* @param Request\|null $request
83		* @param array $params
84		* @return
85		* @throws Exception
86		*/
87		public function callFromRequest(Request $request = null, $params = [])
88		{
89		$command = CommandFactory::createFromRequest($request);
90		$command->setActionParam('params', $params);
91		return $this->getResolverPipeline(InstanceBuilder::class)
92		->process($command)
93	3	->getReturn();
94		}
95	3
96		/**
97		* @param Command $command
98		* @return Command
99	3	*/
100	1	public function dispatchCommand(Command $command)
101		{
102		$this->getCommandsCollection()[] = $command;
103
104
105		try {
106		return $this->processCommand($command);
107		} catch (ForwardException $exception) {
108		$command = CommandFactory::createFromForwardExecption($exception);
109		$return = $this->dispatchCommand($command);
110
111		return $return;
112		}
113		}
114
115		/**
116		* @param bool $params
117		* @throws ForwardException
118		*/
119		public function throwError($params = false)
		0 ignored issues – show Unused Code introduced 2018-04-15 20:31 UTC by Report Bug Copy Issue Report The parameter `$params` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
120		{
121		// $this->getFrontController()->getTrace()->add($params);
122		$this->setErrorController();
123		$this->forward('index');
		0 ignored issues – show Documentation introduced 2018-04-15 20:31 UTC by Report Bug Copy Issue Report `'index'` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
124		}
125
126		/**
127		* @return $this
128		*/
129		public function setErrorController()
130		{
131		$this->getRequest()->setActionName('index');
132		$this->getRequest()->setControllerName('error');
133		$this->getRequest()->setModuleName('default');
134
135		return $this;
136		}
137
138		/**
139		* @param bool $action
140		* @param bool $controller
141		* @param bool $module
142		* @param array $params
143		*
144		* @throws ForwardException
145		*/
146		public function forward($action = false, $controller = false, $module = false, $params = [])
147		{
148		$this->getRequest()->setActionName($action);
		0 ignored issues – show Documentation introduced 2018-04-15 20:31 UTC by Report Bug Copy Issue Report `$action` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
149
150		if ($controller) {
151		$this->getRequest()->setControllerName($controller);
		0 ignored issues – show Documentation introduced 2018-04-15 20:31 UTC by Report Bug Copy Issue Report `$controller` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
152		}
153		if ($module) {
154		$this->getRequest()->setModuleName($module);
		0 ignored issues – show Documentation introduced 2018-04-15 20:31 UTC by Report Bug Copy Issue Report `$module` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
155		}
156
157		if (is_array($params)) {
158		$this->getRequest()->attributes->add($params);
159		}
160
161		throw new ForwardException();
162		}
163
164		/**
165		* @param $module
166		* @param $controller
167		*
168		* @return string
169		*/
170		protected function generateFullControllerNameNamespace($module, $controller)
171		{
172		$name = app()->get('kernel')->getRootNamespace().'Modules\\';
173		$module = $module == 'Default' ? 'Frontend' : $module;
174		$name .= $module.'\Controllers\\';
175		$name .= str_replace('_', '\\', $controller).'Controller';
176
177		return $name;
178		}
179
180		/**
181		* @param string $namespaceClass
182		*
183		* @return bool
184		*/
185		protected function isValidControllerNamespace($namespaceClass)
186		{
187		return class_exists($namespaceClass);
188		}
189
190		/**
191		* @return \Nip\AutoLoader\AutoLoader
192		*/
193		protected function getAutoloader()
194		{
195		return app('autoloader');
196		}
197
198		/**
199		* @param $module
200		* @param $controller
201		*
202		* @return string
203		*/
204		protected function generateFullControllerNameString($module, $controller)
205		{
206		return $module.'_'.$controller.'Controller';
207		}
208		}
209

bytic / dispatcher

Push — master ( d68f4d...84e19d )

Dispatcher::callFromRequest() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like