OperationWrapper::__construct() - Code Metrics - appserver-io/restapi - Measure and Improve Code Quality continuously with Scrutinizer

OperationWrapper::__construct() A
last analyzed 2018-09-15 17:59 UTC

↳ Parent: OperationWrapper

Complexity

Conditions	2
Paths	2

Size

Total Lines	29
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
eloc	11
dl	0
loc	29
ccs	0
cts	15
cp	0
rs	9.9
c	0
b	0
f	0
cc	2
nc	2
nop	3
crap	6

<?php

/**
 * AppserverIo\RestApi\Wrappers\OA2\OperationWrapper
 *
 * 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 2018 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/restapi
 * @link      http://www.appserver.io
 */

namespace AppserverIo\RestApi\Wrappers\OA2;

use Swagger\Annotations\Operation;
use AppserverIo\RestApi\Wrappers\ParameterWrapperInterface;
use AppserverIo\RestApi\Wrappers\OperationWrapperInterface;
use AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface;
use AppserverIo\Psr\EnterpriseBeans\Description\NameAwareDescriptorInterface;

/**
 * OpenApi 2.0 compatible operation wrapper.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2018 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/restapi
 * @link      http://www.appserver.io
 */
class OperationWrapper implements OperationWrapperInterface
{

    /**
     * The operation to wrap.
     *
     * @var \Swagger\Annotations\Operation
     */
    protected $operation;

    /**
     * The lookup name of the object the operation has to be invoked on.
     *
     * @var string
     */
    protected $lookupName;

    /**
     * The method name of the object that has to be invoked.
     *
     * @var string
     */
    protected $methodName;

    /**
     * The regular expression to match the operation's path to the request's path info.
     *
     * @var string
     */
    protected $pattern;

    /**
     * The operation's wrapped parameters.
     *
     * @var \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface[]
     */
    protected $parameters = array();

    /**
     * The array with the names of the parsed path variables as key and their position as value.
     *
     * @var array
     */
    protected $pathVariables = array();

    /**
     * The array with the values of the matched path variables.
     *
     * @var array
     */
    protected $matches = array();

    /**
     * Initializes the wrapper with the passed instances.
     *
     * @param \Swagger\Annotations\Operation                                            $operation        The operation that has to be wrapped
     * @param \AppserverIo\Psr\EnterpriseBeans\Description\NameAwareDescriptorInterface $objectDescriptor The object descriptor of the object the operation has to be invoked on
     * @param \ReflectionMethod                                                         $reflectionMethod The reflection method with the method name of the object that has to be invoked
     */
    public function __construct(Operation $operation, NameAwareDescriptorInterface $objectDescriptor, \ReflectionMethod $reflectionMethod)
    {

        // set the passed instances
        $this->operation = $operation;
        $this->lookupName = $objectDescriptor->getName();
        $this->methodName = $reflectionMethod->getName();

        // wrap the operation's parameters
        foreach ($operation->parameters as $parameter) {
            $this->parameters[] = new ParameterWrapper($parameter);
        }

        // initialize the array for the path variables
        $pathVariables = array();

        // extract the path variables from the operations path
        preg_match('/\\\{[a-zA-Z0-9\_\-]+\\\}/', preg_quote($operation->path), $pathVariables);

        // remove the surrounding braces
        array_walk($pathVariables, function (&$pathVariable) {
            $pathVariable = stripslashes(str_replace(array('{', '}'), null, $pathVariable));
        });

        // set the found path variables
        $this->pathVariables = array_flip($pathVariables);

        // initialize the regex to match the path info to the operation's path
        $this->pattern = "@^" . preg_replace('/\\\{[a-zA-Z0-9\_\-]+\\\}/', '([a-zA-Z0-9\-\_]+)', preg_quote($operation->path)) . "$@D";
    }

    /**
     * Returns the operation instance.
     *
     * @return \Swagger\Annotations\Operation The operation instance
     */
    protected function getOperation()
    {
        return $this->operation;
    }

    /**
     * Query whether or not the operation matches the passed servlet request.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest The HTTP servlet request instance to match
     *
     * @return boolean Returns TRUE, if the operation matches the request, else FALSE
     */
    public function match(HttpServletRequestInterface $servletRequest)
    {

        // try to match the request instance
        $match = preg_match($this->pattern, $servletRequest->getPathInfo(), $this->matches);

        // remove the first match, because it's the path info
        array_shift($this->matches);

        // return TRUE, if the request matches, else FALSE
        return $match;

    }

    /**
     * Returns a list of MIME types the operation can produce.
     *
     * @return array The list of MIME types
     */
    public function produces()
    {
        return $this->getOperation()->produces;
    }

    /**
     * Returns the operations parameters.
     *
     * @return \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface[] The array with the parameters
     */
    public function getParameters()
    {
        return $this->parameters;
    }

    /**
     * Returns the object lookup name that has to be invoked.
     *
     * @return string The lookup name
     */
    public function getLookupName()
    {
        return $this->lookupName;
    }

    /**
     * Returns the object method name that has to be invoked.
     *
     * @return string The method name
     */
    public function getMethodName()
    {
        return $this->methodName;
    }

    /**
     * Returns an array with the values of the matched path variables.
     *
     * @return array The array with the values
     */
    public function getMatches()
    {
        return $this->matches;
    }

    /**
     * Return's the variable value for the passed parameter.
     *
     * @param \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface $parameter The parameter to return the match for
     *
     * @return mixed The variable value of the passed parameter
     */
    public function getMatch(ParameterWrapperInterface $parameter)
    {
        return $this->matches[$this->pathVariables[$parameter->getName()]];
    }

    /**
     * Returns an array with the names of the parsed path variables as key and their position as value.
     *
     * @return array The array with the path variables
     */
    public function getPathVariables()
    {
        return $this->pathVariables;
    }

    /**
     * Returns operation's request method.
     *
     * @return string The request method
     */
    public function getMethod()
    {
        return $this->getOperation()->method;
    }
}


1			<?php
2
3			/**
4			* AppserverIo\RestApi\Wrappers\OA2\OperationWrapper
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 2018 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/appserver-io/restapi
18			* @link http://www.appserver.io
19			*/
20
21			namespace AppserverIo\RestApi\Wrappers\OA2;
22
23			use Swagger\Annotations\Operation;
24			use AppserverIo\RestApi\Wrappers\ParameterWrapperInterface;
25			use AppserverIo\RestApi\Wrappers\OperationWrapperInterface;
26			use AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface;
27			use AppserverIo\Psr\EnterpriseBeans\Description\NameAwareDescriptorInterface;
28
29			/**
30			* OpenApi 2.0 compatible operation wrapper.
31			*
32			* @author Tim Wagner <[email protected]>
33			* @copyright 2018 TechDivision GmbH <[email protected]>
34			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
35			* @link https://github.com/appserver-io/restapi
36			* @link http://www.appserver.io
37			*/
38			class OperationWrapper implements OperationWrapperInterface
39			{
40
41			/**
42			* The operation to wrap.
43			*
44			* @var \Swagger\Annotations\Operation
45			*/
46			protected $operation;
47
48			/**
49			* The lookup name of the object the operation has to be invoked on.
50			*
51			* @var string
52			*/
53			protected $lookupName;
54
55			/**
56			* The method name of the object that has to be invoked.
57			*
58			* @var string
59			*/
60			protected $methodName;
61
62			/**
63			* The regular expression to match the operation's path to the request's path info.
64			*
65			* @var string
66			*/
67			protected $pattern;
68
69			/**
70			* The operation's wrapped parameters.
71			*
72			* @var \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface[]
73			*/
74			protected $parameters = array();
75
76			/**
77			* The array with the names of the parsed path variables as key and their position as value.
78			*
79			* @var array
80			*/
81			protected $pathVariables = array();
82
83			/**
84			* The array with the values of the matched path variables.
85			*
86			* @var array
87			*/
88			protected $matches = array();
89
90			/**
91			* Initializes the wrapper with the passed instances.
92			*
93			* @param \Swagger\Annotations\Operation $operation The operation that has to be wrapped
94			* @param \AppserverIo\Psr\EnterpriseBeans\Description\NameAwareDescriptorInterface $objectDescriptor The object descriptor of the object the operation has to be invoked on
95			* @param \ReflectionMethod $reflectionMethod The reflection method with the method name of the object that has to be invoked
96			*/
97			public function __construct(Operation $operation, NameAwareDescriptorInterface $objectDescriptor, \ReflectionMethod $reflectionMethod)
98			{
99
100			// set the passed instances
101			$this->operation = $operation;
102			$this->lookupName = $objectDescriptor->getName();
103			$this->methodName = $reflectionMethod->getName();
104
105			// wrap the operation's parameters
106			foreach ($operation->parameters as $parameter) {
107			$this->parameters[] = new ParameterWrapper($parameter);
108			}
109
110			// initialize the array for the path variables
111			$pathVariables = array();
112
113			// extract the path variables from the operations path
114			preg_match('/\\\{[a-zA-Z0-9\_\-]+\\\}/', preg_quote($operation->path), $pathVariables);
115
116			// remove the surrounding braces
117			array_walk($pathVariables, function (&$pathVariable) {
118			$pathVariable = stripslashes(str_replace(array('{', '}'), null, $pathVariable));
119			});
120
121			// set the found path variables
122			$this->pathVariables = array_flip($pathVariables);
123
124			// initialize the regex to match the path info to the operation's path
125			$this->pattern = "@^" . preg_replace('/\\\{[a-zA-Z0-9\_\-]+\\\}/', '([a-zA-Z0-9\-\_]+)', preg_quote($operation->path)) . "$@D";
126			}
127
128			/**
129			* Returns the operation instance.
130			*
131			* @return \Swagger\Annotations\Operation The operation instance
132			*/
133			protected function getOperation()
134			{
135			return $this->operation;
136			}
137
138			/**
139			* Query whether or not the operation matches the passed servlet request.
140			*
141			* @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest The HTTP servlet request instance to match
142			*
143			* @return boolean Returns TRUE, if the operation matches the request, else FALSE
144			*/
145			public function match(HttpServletRequestInterface $servletRequest)
146			{
147
148			// try to match the request instance
149			$match = preg_match($this->pattern, $servletRequest->getPathInfo(), $this->matches);
150
151			// remove the first match, because it's the path info
152			array_shift($this->matches);
153
154			// return TRUE, if the request matches, else FALSE
155			return $match;
			0 ignored issues – show Bug Best Practice introduced 2018-09-13 14:39 UTC by Report Bug Copy Issue Report The expression `return $match` returns the type `integer` which is incompatible with the documented return type `boolean`. Loading history...
156			}
157
158			/**
159			* Returns a list of MIME types the operation can produce.
160			*
161			* @return array The list of MIME types
162			*/
163			public function produces()
164			{
165			return $this->getOperation()->produces;
166			}
167
168			/**
169			* Returns the operations parameters.
170			*
171			* @return \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface[] The array with the parameters
172			*/
173			public function getParameters()
174			{
175			return $this->parameters;
176			}
177
178			/**
179			* Returns the object lookup name that has to be invoked.
180			*
181			* @return string The lookup name
182			*/
183			public function getLookupName()
184			{
185			return $this->lookupName;
186			}
187
188			/**
189			* Returns the object method name that has to be invoked.
190			*
191			* @return string The method name
192			*/
193			public function getMethodName()
194			{
195			return $this->methodName;
196			}
197
198			/**
199			* Returns an array with the values of the matched path variables.
200			*
201			* @return array The array with the values
202			*/
203			public function getMatches()
204			{
205			return $this->matches;
206			}
207
208			/**
209			* Return's the variable value for the passed parameter.
210			*
211			* @param \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface $parameter The parameter to return the match for
212			*
213			* @return mixed The variable value of the passed parameter
214			*/
215			public function getMatch(ParameterWrapperInterface $parameter)
216			{
217			return $this->matches[$this->pathVariables[$parameter->getName()]];
218			}
219
220			/**
221			* Returns an array with the names of the parsed path variables as key and their position as value.
222			*
223			* @return array The array with the path variables
224			*/
225			public function getPathVariables()
226			{
227			return $this->pathVariables;
228			}
229
230			/**
231			* Returns operation's request method.
232			*
233			* @return string The request method
234			*/
235			public function getMethod()
236			{
237			return $this->getOperation()->method;
238			}
239			}
240

appserver-io / restapi

OperationWrapper::__construct() A last analyzed 2018-09-15 17:59 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

OperationWrapper::__construct() A
last analyzed 2018-09-15 17:59 UTC