ActionDescriptor::newDescriptorInstance() - Code Metrics - Inspection of "Merge pull request #58 from wagnert/master" - appserver-io/routlt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c82f1b...c3956a )

by Tim

created 2018-07-18 15:10 UTC

ActionDescriptor::newDescriptorInstance() A

↳ Parent: ActionDescriptor

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	2
cts	2
cp	1
cc	1
nc	1
nop	0
crap	1

<?php

/**
 * AppserverIo\Routlt\Description\ActionDescriptor
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author     Tim Wagner <[email protected]>
 * @copyright  2015 TechDivision GmbH <[email protected]>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       http://github.com/appserver-io/routlt
 * @link       http://www.appserver.io
 */

namespace AppserverIo\Routlt\Description;

use AppserverIo\Http\HttpProtocol;
use AppserverIo\Routlt\Annotations\Action;
use AppserverIo\Routlt\Annotations\Connect;
use AppserverIo\Routlt\Annotations\Delete;
use AppserverIo\Routlt\Annotations\Get;
use AppserverIo\Routlt\Annotations\Head;
use AppserverIo\Routlt\Annotations\Options;
use AppserverIo\Routlt\Annotations\Patch;
use AppserverIo\Routlt\Annotations\Post;
use AppserverIo\Routlt\Annotations\Put;
use AppserverIo\Routlt\Annotations\Trace;
use AppserverIo\Lang\Reflection\MethodInterface;
use AppserverIo\Configuration\Interfaces\NodeInterface;
use AppserverIo\Description\AbstractNameAwareDescriptor;

/**
 * Annotation to map a request path info to an action method.
 *
 * @author     Tim Wagner <[email protected]>
 * @copyright  2015 TechDivision GmbH <[email protected]>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       http://github.com/appserver-io/routlt
 * @link       http://www.appserver.io
 */
class ActionDescriptor extends AbstractNameAwareDescriptor implements ActionDescriptorInterface
{

    /**
     * The action method name.
     *
     * @var string
     */
    protected $methodName;

    /**
     * The request methods the action is listening to.
     *
     * @var array
     */
    protected $requestMethods = array();

    protected $mappedRequestMethods = array(
        HttpProtocol::METHOD_CONNECT => Connect::class,
        HttpProtocol::METHOD_DELETE  => Delete::class,
        HttpProtocol::METHOD_GET     => Get::class,
        HttpProtocol::METHOD_HEAD    => Head::class,
        HttpProtocol::METHOD_OPTIONS => Options::class,
        HttpProtocol::METHOD_POST    => Post::class,
        HttpProtocol::METHOD_PUT     => Put::class,
        HttpProtocol::METHOD_TRACE   => Trace::class,
        HttpProtocol::METHOD_PATCH   => Patch::class
    );

    /**
     * The restrictions for the route placeholders.
     *
     * @var array
     */
    protected $restrictions;

    /**
     * The defaults for the route placeholders.
     *
     * @var array
     */
    protected $defaults;

    /**
     * Initializes the descriptor with the default
     * request methods the action is listening to.
     */
    public function __construct()
    {

        // initialize restrictions and defaults
        $this->defaults = array();
        $this->restrictions = array();

        // initialize the request methods
        $this->requestMethods = array_keys($this->getMappedRequestMethods());
    }

    /**
     * Sets the action method name.
     *
     * @param string $methodName The action method name
     *
     * @return void
     */
    public function setMethodName($methodName)
    {
        $this->methodName = $methodName;
    }

    /**
     * Returns the action method name.
     *
     * @return string The action method name
     */
    public function getMethodName()
    {
        return $this->methodName;
    }

    /**
     * Sets the request methods the action is listening to.
     *
     * @param array $requestMethods The request methods
     *
     * @return void
     */
    public function setRequestMethods(array $requestMethods)
    {
        $this->requestMethods = $requestMethods;
    }

    /**
     * Returns the request methods the action is listening to.
     *
     * @return array The request methods
     */
    public function getRequestMethods()
    {
        return $this->requestMethods;
    }

    /**
     * Add's the passed key => value pair as restriction.
     *
     * @param string $name  The parameter name to add the restriction for
     * @param string $value The restriction value itself
     *
     * @return void
     */
    public function addRestriction($name, $value)
    {
        $this->restrictions[$name] = $value;
    }

    /**
     * Sets the restrictions for the route placeholders.
     *
     * @param array $restrictions The restrictions for the route placeholders
     *
     * @return void
     */
    public function setRestrictions(array $restrictions)
    {
        $this->restrictions = $restrictions;
    }

    /**
     * Returns the restrictions for the route placeholders.
     *
     * @return array The restrictions for the route placeholders
     */
    public function getRestrictions()
    {
        return $this->restrictions;
    }

    /**
     * Add's the passed key => value pair as default.
     *
     * @param string $name  The parameter name to add the default for
     * @param string $value The default value itself
     *
     * @return void
     */
    public function addDefault($name, $value)
    {
        $this->defaults[$name] = $value;
    }

    /**
     * Sets the defaults for the route placeholders.
     *
     * @param array $defaults The defaults for the route placeholders
     *
     * @return void
     */
    public function setDefaults(array $defaults)
    {
        $this->defaults = $defaults;
    }

    /**
     * Returns the defaults for the route placeholders.
     *
     * @return array The defaults for the route placeholders
     */
    public function getDefaults()
    {
        return $this->defaults;
    }

    /**
     * Returns a new descriptor instance.
     *
     * @return \AppserverIo\Routlt\Description\ActionDescriptorInterface The descriptor instance
     */
    public static function newDescriptorInstance()
    {
        return new ActionDescriptor();
    }

    /**
     * Return's the array with the reqeust method => annotation class mapping.
     *
     * @return array The mapping
     */
    protected function getMappedRequestMethods()
    {
        return $this->mappedRequestMethods;
    }

    /**
     * Initializes the action configuration instance from the passed reflection method instance.
     *
     * @param \AppserverIo\Lang\Reflection\MethodInterface $reflectionMethod The reflection method with the action configuration
     *
     * @return \AppserverIo\Routlt\Description\ActionDescriptorInterface The initialized descriptor
     */
    public function fromReflectionMethod(MethodInterface $reflectionMethod)
    {

        // create a new annotation instance
        $annotationInstance = $this->getMethodAnnotation($reflectionMethod, Action::class);

        // query if we've a method with a @Action annotation
        if ($annotationInstance === null && $reflectionMethod->getMethodName() !== 'perform') {
            // if not, do nothing
            return;
        }

        // query whether we've the default perform() method WITHOUT an @Action annotation
        if ($annotationInstance === null && $reflectionMethod->getMethodName() === 'perform') {
            // create a new annotation instance
            $annotationInstance = new Action(array('name' => $reflectionMethod->getMethodName()));
        }

        // load method name
        $this->setMethodName($reflectionMethod->getMethodName());

        // load the default name to register in naming directory
        if (($nameAttribute = $annotationInstance->getName()) || $nameAttribute === '') {
            $this->setName($nameAttribute);
        } else {
            // if @Annotation(name=****) is NOT SET, we use the method name by default
            $this->setName('/' . lcfirst(str_replace('Action', '', $reflectionMethod->getMethodName())));
        }

        // initialize the array for the annotated request methods
        $annotatedRequestMethods = array();

        // parse the method for annotated request methods
        foreach ($this->getMappedRequestMethods() as $requestMethod => $annotationName) {
            // query whether the reflection method has been annotated
            if ($this->getMethodAnnotation($reflectionMethod, $annotationName)) {
                array_push($annotatedRequestMethods, $requestMethod);
            }
        }

        // query whether at least one annotated request method has been found
        if (sizeof($annotatedRequestMethods) > 0) {
            // if yes, override the default request methods
            $this->setRequestMethods($annotatedRequestMethods);
        }

        // initialize the restrictions for the route placeholders
        if (is_array($restrictions = $annotationInstance->getRestrictions())) {
            foreach ($restrictions as $restriction) {
                list($name, $value) = $restriction;
                $this->addRestriction($name, $value);
            }
        }

        // initialize the defaults for the route placeholders
        if (is_array($defaults = $annotationInstance->getDefaults())) {
            foreach ($defaults as $default) {
                list($name, $value) = $default;
                $this->addDefault($name, $value);
            }
        }

        // return the instance
        return $this;
    }

    /**
     * Initializes a action configuration instance from the passed deployment descriptor node.
     *
     * @param \SimpleXmlElement $node The deployment node with the action configuration
     *
     * @return \AppserverIo\Routlt\Description\ActionDescriptorInterface The initialized descriptor
     */
    public function fromDeploymentDescriptor(\SimpleXmlElement $node)

    {
    }

    /**
     * Initializes a action configuration instance from the passed configuration node.
     *
     * @param \AppserverIo\Configuration\Interfaces\NodeInterface $node The configuration node with the action configuration
     *
     * @return \AppserverIo\Routlt\Description\ActionDescriptorInterface The initialized descriptor
     */
    public function fromConfiguration(NodeInterface $node)

    {
    }

    /**
     * Merges the passed configuration into this one. Configuration values
     * of the passed configuration will overwrite this one.
     *
     * @param \AppserverIo\Routlt\Description\ActionDescriptorInterface $actionDescriptor The configuration to merge
     *
     * @return void
     * @throws \AppserverIo\Routlt\Description\DescriptorException Is thrown if the passed descriptor has a different method name
     */
    public function merge(ActionDescriptorInterface $actionDescriptor)
    {

        // check if the classes are equal
        if ($this->getMethodName() !== $actionDescriptor->getMethodName()) {
            throw new DescriptorException(
                sprintf('You try to merge a action configuration for %s with %s', $actionDescriptor->getMethodName(), $this->getMethodName())
            );
        }

        // merge the name
        if ($name = $actionDescriptor->getName()) {
            $this->setName($name);
        }
    }
}


1		<?php
2
3		/**
4		* AppserverIo\Routlt\Description\ActionDescriptor
5		*
6		* NOTICE OF LICENSE
7		*
8		* This source file is subject to the Open Software License (OSL 3.0)
9		* that is available through the world-wide-web at this URL:
10		* http://opensource.org/licenses/osl-3.0.php
11		*
12		* PHP version 5
13		*
14		* @author Tim Wagner <[email protected]>
15		* @copyright 2015 TechDivision GmbH <[email protected]>
16		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17		* @link http://github.com/appserver-io/routlt
18		* @link http://www.appserver.io
19		*/
20
21		namespace AppserverIo\Routlt\Description;
22
23		use AppserverIo\Http\HttpProtocol;
24		use AppserverIo\Routlt\Annotations\Action;
25		use AppserverIo\Routlt\Annotations\Connect;
26		use AppserverIo\Routlt\Annotations\Delete;
27		use AppserverIo\Routlt\Annotations\Get;
28		use AppserverIo\Routlt\Annotations\Head;
29		use AppserverIo\Routlt\Annotations\Options;
30		use AppserverIo\Routlt\Annotations\Patch;
31		use AppserverIo\Routlt\Annotations\Post;
32		use AppserverIo\Routlt\Annotations\Put;
33		use AppserverIo\Routlt\Annotations\Trace;
34		use AppserverIo\Lang\Reflection\MethodInterface;
35		use AppserverIo\Configuration\Interfaces\NodeInterface;
36		use AppserverIo\Description\AbstractNameAwareDescriptor;
37
38		/**
39		* Annotation to map a request path info to an action method.
40		*
41		* @author Tim Wagner <[email protected]>
42		* @copyright 2015 TechDivision GmbH <[email protected]>
43		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
44		* @link http://github.com/appserver-io/routlt
45		* @link http://www.appserver.io
46		*/
47		class ActionDescriptor extends AbstractNameAwareDescriptor implements ActionDescriptorInterface
48		{
49
50		/**
51		* The action method name.
52		*
53		* @var string
54		*/
55		protected $methodName;
56
57		/**
58		* The request methods the action is listening to.
59		*
60		* @var array
61		*/
62		protected $requestMethods = array();
63
64		protected $mappedRequestMethods = array(
65		HttpProtocol::METHOD_CONNECT => Connect::class,
66		HttpProtocol::METHOD_DELETE => Delete::class,
67		HttpProtocol::METHOD_GET => Get::class,
68		HttpProtocol::METHOD_HEAD => Head::class,
69		HttpProtocol::METHOD_OPTIONS => Options::class,
70		HttpProtocol::METHOD_POST => Post::class,
71		HttpProtocol::METHOD_PUT => Put::class,
72		HttpProtocol::METHOD_TRACE => Trace::class,
73		HttpProtocol::METHOD_PATCH => Patch::class
74		);
75
76		/**
77		* The restrictions for the route placeholders.
78		*
79		* @var array
80		*/
81		protected $restrictions;
82
83		/**
84		* The defaults for the route placeholders.
85		*
86		* @var array
87		*/
88		protected $defaults;
89
90		/**
91		* Initializes the descriptor with the default
92		* request methods the action is listening to.
93		*/
94	9	public function __construct()
95		{
96
97		// initialize restrictions and defaults
98	9	$this->defaults = array();
99	9	$this->restrictions = array();
100
101		// initialize the request methods
102	9	$this->requestMethods = array_keys($this->getMappedRequestMethods());
103	9	}
104
105		/**
106		* Sets the action method name.
107		*
108		* @param string $methodName The action method name
109		*
110		* @return void
111		*/
112	8	public function setMethodName($methodName)
113		{
114	8	$this->methodName = $methodName;
115	8	}
116
117		/**
118		* Returns the action method name.
119		*
120		* @return string The action method name
121		*/
122	3	public function getMethodName()
123		{
124	3	return $this->methodName;
125		}
126
127		/**
128		* Sets the request methods the action is listening to.
129		*
130		* @param array $requestMethods The request methods
131		*
132		* @return void
133		*/
134	6	public function setRequestMethods(array $requestMethods)
135		{
136	6	$this->requestMethods = $requestMethods;
137	6	}
138
139		/**
140		* Returns the request methods the action is listening to.
141		*
142		* @return array The request methods
143		*/
144	5	public function getRequestMethods()
145		{
146	5	return $this->requestMethods;
147		}
148
149		/**
150		* Add's the passed key => value pair as restriction.
151		*
152		* @param string $name The parameter name to add the restriction for
153		* @param string $value The restriction value itself
154		*
155		* @return void
156		*/
157		public function addRestriction($name, $value)
158		{
159		$this->restrictions[$name] = $value;
160		}
161
162		/**
163		* Sets the restrictions for the route placeholders.
164		*
165		* @param array $restrictions The restrictions for the route placeholders
166		*
167		* @return void
168		*/
169		public function setRestrictions(array $restrictions)
170		{
171		$this->restrictions = $restrictions;
172		}
173
174		/**
175		* Returns the restrictions for the route placeholders.
176		*
177		* @return array The restrictions for the route placeholders
178		*/
179		public function getRestrictions()
180		{
181		return $this->restrictions;
182		}
183
184		/**
185		* Add's the passed key => value pair as default.
186		*
187		* @param string $name The parameter name to add the default for
188		* @param string $value The default value itself
189		*
190		* @return void
191		*/
192		public function addDefault($name, $value)
193		{
194		$this->defaults[$name] = $value;
195		}
196
197		/**
198		* Sets the defaults for the route placeholders.
199		*
200		* @param array $defaults The defaults for the route placeholders
201		*
202		* @return void
203		*/
204		public function setDefaults(array $defaults)
205		{
206		$this->defaults = $defaults;
207		}
208
209		/**
210		* Returns the defaults for the route placeholders.
211		*
212		* @return array The defaults for the route placeholders
213		*/
214		public function getDefaults()
215		{
216		return $this->defaults;
217		}
218
219		/**
220		* Returns a new descriptor instance.
221		*
222		* @return \AppserverIo\Routlt\Description\ActionDescriptorInterface The descriptor instance
223		*/
224	4	public static function newDescriptorInstance()
225		{
226	4	return new ActionDescriptor();
227		}
228
229		/**
230		* Return's the array with the reqeust method => annotation class mapping.
231		*
232		* @return array The mapping
233		*/
234	9	protected function getMappedRequestMethods()
235		{
236	9	return $this->mappedRequestMethods;
237		}
238
239		/**
240		* Initializes the action configuration instance from the passed reflection method instance.
241		*
242		* @param \AppserverIo\Lang\Reflection\MethodInterface $reflectionMethod The reflection method with the action configuration
243		*
244		* @return \AppserverIo\Routlt\Description\ActionDescriptorInterface The initialized descriptor
245		*/
246	8	public function fromReflectionMethod(MethodInterface $reflectionMethod)
247		{
248
249		// create a new annotation instance
250	8	$annotationInstance = $this->getMethodAnnotation($reflectionMethod, Action::class);
251
252		// query if we've a method with a @Action annotation
253	8	if ($annotationInstance === null && $reflectionMethod->getMethodName() !== 'perform') {
254		// if not, do nothing
255	4	return;
256		}
257
258		// query whether we've the default perform() method WITHOUT an @Action annotation
259	8	if ($annotationInstance === null && $reflectionMethod->getMethodName() === 'perform') {
260		// create a new annotation instance
261	4	$annotationInstance = new Action(array('name' => $reflectionMethod->getMethodName()));
262	4	}
263
264		// load method name
265	8	$this->setMethodName($reflectionMethod->getMethodName());
266
267		// load the default name to register in naming directory
268	8	if (($nameAttribute = $annotationInstance->getName()) \|\| $nameAttribute === '') {
269	7	$this->setName($nameAttribute);
270	7	} else {
271		// if @Annotation(name=****) is NOT SET, we use the method name by default
272	4	$this->setName('/' . lcfirst(str_replace('Action', '', $reflectionMethod->getMethodName())));
273		}
274
275		// initialize the array for the annotated request methods
276	8	$annotatedRequestMethods = array();
277
278		// parse the method for annotated request methods
279	8	foreach ($this->getMappedRequestMethods() as $requestMethod => $annotationName) {
280		// query whether the reflection method has been annotated
281	8	if ($this->getMethodAnnotation($reflectionMethod, $annotationName)) {
282	6	array_push($annotatedRequestMethods, $requestMethod);
283	6	}
284	8	}
285
286		// query whether at least one annotated request method has been found
287	8	if (sizeof($annotatedRequestMethods) > 0) {
288		// if yes, override the default request methods
289	6	$this->setRequestMethods($annotatedRequestMethods);
290	6	}
291
292		// initialize the restrictions for the route placeholders
293	8	if (is_array($restrictions = $annotationInstance->getRestrictions())) {
294		foreach ($restrictions as $restriction) {
295		list($name, $value) = $restriction;
296		$this->addRestriction($name, $value);
297		}
298		}
299
300		// initialize the defaults for the route placeholders
301	8	if (is_array($defaults = $annotationInstance->getDefaults())) {
302		foreach ($defaults as $default) {
303		list($name, $value) = $default;
304		$this->addDefault($name, $value);
305		}
306		}
307
308		// return the instance
309	8	return $this;
310		}
311
312		/**
313		* Initializes a action configuration instance from the passed deployment descriptor node.
314		*
315		* @param \SimpleXmlElement $node The deployment node with the action configuration
316		*
317		* @return \AppserverIo\Routlt\Description\ActionDescriptorInterface The initialized descriptor
318		*/
319	1	public function fromDeploymentDescriptor(\SimpleXmlElement $node)
		0 ignored issues – show Unused Code introduced 2017-09-13 19:29 UTC by Report Bug Copy Issue Report The parameter `$node` 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...
320		{
321	1	}
322
323		/**
324		* Initializes a action configuration instance from the passed configuration node.
325		*
326		* @param \AppserverIo\Configuration\Interfaces\NodeInterface $node The configuration node with the action configuration
327		*
328		* @return \AppserverIo\Routlt\Description\ActionDescriptorInterface The initialized descriptor
329		*/
330		public function fromConfiguration(NodeInterface $node)
		0 ignored issues – show Unused Code introduced 2017-09-13 19:29 UTC by Report Bug Copy Issue Report The parameter `$node` 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...
331		{
332		}
333
334		/**
335		* Merges the passed configuration into this one. Configuration values
336		* of the passed configuration will overwrite this one.
337		*
338		* @param \AppserverIo\Routlt\Description\ActionDescriptorInterface $actionDescriptor The configuration to merge
339		*
340		* @return void
341		* @throws \AppserverIo\Routlt\Description\DescriptorException Is thrown if the passed descriptor has a different method name
342		*/
343	2	public function merge(ActionDescriptorInterface $actionDescriptor)
344		{
345
346		// check if the classes are equal
347	2	if ($this->getMethodName() !== $actionDescriptor->getMethodName()) {
348	1	throw new DescriptorException(
349	1	sprintf('You try to merge a action configuration for %s with %s', $actionDescriptor->getMethodName(), $this->getMethodName())
350	1	);
351		}
352
353		// merge the name
354	1	if ($name = $actionDescriptor->getName()) {
355	1	$this->setName($name);
356	1	}
357	1	}
358		}
359

appserver-io / routlt

Push — master ( c82f1b...c3956a )

ActionDescriptor::newDescriptorInstance() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like