MarshalDispatcher::__construct() - Code Metrics - Inspection of "Merge branch 'release/4.1.0'" - cerbero90/Workflow - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cfc4ec...f79189 )

by Andrea Marco

created 2015-12-23 18:24 UTC

MarshalDispatcher::__construct() A

↳ Parent: MarshalDispatcher

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

namespace Cerbero\Workflow\Wrappers;

use Exception;
use ArrayAccess;
use ReflectionClass;
use ReflectionParameter;
use Illuminate\Contracts\Bus\Dispatcher;

/**
 * Wrapper to marshal commands before dispatching them.
 *
 * @author	Andrea Marco Sartori
 */
class MarshalDispatcher implements DispatcherInterface
{

	/**
	 * @author	Andrea Marco Sartori
	 * @var		Illuminate\Contracts\Bus\Dispatcher	$dispatcher	Bus dispatcher.
	 */
	protected $dispatcher;

	/**
	 * @author	Andrea Marco Sartori
	 * @var		string  $command	Command to dispatch
	 */
	protected $command;

	/**
	 * @author	Andrea Marco Sartori
	 * @var		\ArrayAccess  $values	Parameters values
	 */
	protected $values;
	
	/**
	 * Set the dependencies.
	 *
	 * @author	Andrea Marco Sartori
	 * @param	Illuminate\Contracts\Bus\Dispatcher	$dispatcher
	 * @return	void

	 */
	public function __construct(Dispatcher $dispatcher)
	{
		$this->dispatcher = $dispatcher;

	}

	/**
     * Set the pipes commands should be piped through before dispatching.
     *
	 * @author	Andrea Marco Sartori
     * @param  array  $pipes
     * @return $this
     */
    public function pipeThrough(array $pipes)
    {
    	$this->dispatcher->pipeThrough($pipes);

    	return $this;
    }

    /**
     * Marshal a command and dispatch it.
     *
	 * @author	Andrea Marco Sartori
     * @param  mixed  $command
     * @param  \ArrayAccess  $source
     * @param  array  $extras
     * @return mixed
     */
    public function dispatchFrom($command, ArrayAccess $source, array $extras = [])
    {
    	$this->command = $command;

    	$this->values = array_merge((array) $source, $extras);


    	return $this->dispatcher->dispatch($this->marshal());
    }

    /**
     * Marshal the command to dispatch.
     *
	 * @author	Andrea Marco Sartori
     * @return mixed
     */
    protected function marshal()
    {
        $reflection = new ReflectionClass($this->command);

        $constructor = $reflection->getConstructor();

        $params = $this->getParamsToInject($constructor->getParameters());

        return $reflection->newInstanceArgs($params);
    }

    /**
     * Retrieve the arguments to inject into the command constructor.
     *
     * @author	Andrea Marco Sartori
     * @param	array	$parameters
     * @return	array
     */
    protected function getParamsToInject(array $parameters)
    {
        return array_map(function ($parameter)
        {
            return $this->grabParameter($parameter);

        }, $parameters);
    }

    /**
     * Get a parameter value for a marshaled command.
     *
	 * @author	Andrea Marco Sartori
     * @param  \ReflectionParameter  $parameter
     * @return mixed
     */
    protected function grabParameter(ReflectionParameter $parameter)
    {
        if (isset($this->values[$parameter->name]))
        {
            return $this->values[$parameter->name];
        }

        if ($parameter->isDefaultValueAvailable())
        {
            return $parameter->getDefaultValue();
        }

        throw new Exception("Unable to map parameter [{$parameter->name}] to command [{$this->command}]");
    }

}


1			<?php
2
3			namespace Cerbero\Workflow\Wrappers;
4
5			use Exception;
6			use ArrayAccess;
7			use ReflectionClass;
8			use ReflectionParameter;
9			use Illuminate\Contracts\Bus\Dispatcher;
10
11			/**
12			* Wrapper to marshal commands before dispatching them.
13			*
14			* @author Andrea Marco Sartori
15			*/
16			class MarshalDispatcher implements DispatcherInterface
17			{
18
19			/**
20			* @author Andrea Marco Sartori
21			* @var Illuminate\Contracts\Bus\Dispatcher $dispatcher Bus dispatcher.
22			*/
23			protected $dispatcher;
24
25			/**
26			* @author Andrea Marco Sartori
27			* @var string $command Command to dispatch
28			*/
29			protected $command;
30
31			/**
32			* @author Andrea Marco Sartori
33			* @var \ArrayAccess $values Parameters values
34			*/
35			protected $values;
36
37			/**
38			* Set the dependencies.
39			*
40			* @author Andrea Marco Sartori
41			* @param Illuminate\Contracts\Bus\Dispatcher $dispatcher
42			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2015-12-23 18:26 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...
43			*/
44			public function __construct(Dispatcher $dispatcher)
45			{
46			$this->dispatcher = $dispatcher;
			0 ignored issues – show Documentation Bug introduced 2015-12-23 18:26 UTC by Report Bug Copy Issue Report It seems like `$dispatcher` of type `object<Illuminate\Contracts\Bus\Dispatcher>` is incompatible with the declared type `object<Cerbero\Workflow\...ntracts\Bus\Dispatcher>` of property `$dispatcher`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
47			}
48
49			/**
50			* Set the pipes commands should be piped through before dispatching.
51			*
52			* @author Andrea Marco Sartori
53			* @param array $pipes
54			* @return $this
55			*/
56			public function pipeThrough(array $pipes)
57			{
58			$this->dispatcher->pipeThrough($pipes);
59
60			return $this;
61			}
62
63			/**
64			* Marshal a command and dispatch it.
65			*
66			* @author Andrea Marco Sartori
67			* @param mixed $command
68			* @param \ArrayAccess $source
69			* @param array $extras
70			* @return mixed
71			*/
72			public function dispatchFrom($command, ArrayAccess $source, array $extras = [])
73			{
74			$this->command = $command;
75
76			$this->values = array_merge((array) $source, $extras);
			0 ignored issues – show Documentation Bug introduced 2015-12-23 18:26 UTC by Report Bug Copy Issue Report It seems like `array_merge((array) $source, $extras)` of type `array` is incompatible with the declared type `object<ArrayAccess>` of property `$values`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
77
78			return $this->dispatcher->dispatch($this->marshal());
79			}
80
81			/**
82			* Marshal the command to dispatch.
83			*
84			* @author Andrea Marco Sartori
85			* @return mixed
86			*/
87			protected function marshal()
88			{
89			$reflection = new ReflectionClass($this->command);
90
91			$constructor = $reflection->getConstructor();
92
93			$params = $this->getParamsToInject($constructor->getParameters());
94
95			return $reflection->newInstanceArgs($params);
96			}
97
98			/**
99			* Retrieve the arguments to inject into the command constructor.
100			*
101			* @author Andrea Marco Sartori
102			* @param array $parameters
103			* @return array
104			*/
105			protected function getParamsToInject(array $parameters)
106			{
107			return array_map(function ($parameter)
108			{
109			return $this->grabParameter($parameter);
110
111			}, $parameters);
112			}
113
114			/**
115			* Get a parameter value for a marshaled command.
116			*
117			* @author Andrea Marco Sartori
118			* @param \ReflectionParameter $parameter
119			* @return mixed
120			*/
121			protected function grabParameter(ReflectionParameter $parameter)
122			{
123			if (isset($this->values[$parameter->name]))
124			{
125			return $this->values[$parameter->name];
126			}
127
128			if ($parameter->isDefaultValueAvailable())
129			{
130			return $parameter->getDefaultValue();
131			}
132
133			throw new Exception("Unable to map parameter [{$parameter->name}] to command [{$this->command}]");
134			}
135
136			}
137

cerbero90 / Workflow

Push — master ( cfc4ec...f79189 )

MarshalDispatcher::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like