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

RequestParser::prepareMethodName() A
last analyzed 2018-09-15 17:59 UTC

↳ Parent: RequestParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

/**
 * AppserverIo\RestApi\Parsers\OA2\RequestParser
 *
 * 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\Parsers\OA2;

use AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface;
use AppserverIo\RestApi\Parsers\RequestParserInterface;
use AppserverIo\RestApi\Wrappers\OperationWrapperInterface;
use AppserverIo\RestApi\Wrappers\ParameterWrapperInterface;

/**
 * OpenApi 2.0 compatible request parser.
 *
 * @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 RequestParser implements RequestParserInterface
{

    /**
     * Returns the integer value for the passed parameter from the request.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest The HTTP servlet request instance
     * @param \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface   $parameter      The parameter instance
     *
     * @return integer|null The parsed value
     * @throws \Exception Is thrown, if the specified collection format invalid
     */
    protected function processArrayParameter(HttpServletRequestInterface $servletRequest, ParameterWrapperInterface $parameter)
    {

        // query the collection format specified for the parameter
        if ($parameter->hasCollectionFormat('csv')) {
            // load the value from the request
            if ($param = $servletRequest->getParameter($parameter->getName())) {
                // initialize the array for the values
                $parameters = array();

                // extract the values by parsing them as CSV string
                foreach (str_getcsv(urldecode($param)) as $value) {
                    list ($key, $val) = explode('=', urldecode($value));
                    $parameters[$key] = $val;
                }

                // return the parameters
                return $parameters;

            }

            // return an empty array
            return array();

        } elseif ($parameter->hasCollectionFormat('multi')) {
            throw new \Exception('Collection format "multi" is not yet supported');
        } else {
            throw new \Exception(sprintf('Unknown collection format "%s" is not supported yet', $parameter->getCollectionFormat()));
        }
    }

    /**
     * Returns the string value for the passed parameter from the request.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest The HTTP servlet request instance
     * @param \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface   $parameter      The parameter instance
     *
     * @return string|null The parsed value
     */
    protected function processStringParameter(HttpServletRequestInterface $servletRequest, ParameterWrapperInterface $parameter)
    {
        return $servletRequest->getParameter($parameter->getName());
    }

    /**
     * Returns the integer value for the passed parameter from the request.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest The HTTP servlet request instance
     * @param \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface   $parameter      The parameter instance
     *
     * @return integer|null The parsed value
     */
    protected function processIntegerParameter(HttpServletRequestInterface $servletRequest, ParameterWrapperInterface $parameter)
    {
        if ($value = $servletRequest->getParameter($parameter->getName(), FILTER_VALIDATE_INT)) {
            return (integer) $value;
        }
    }

    /**
     * Returns the internal method name to load the value from the request parameters.
     *
     * @param \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface $parameter The parameter to create prepare the method name for
     *
     * @return string The prepared method name
     */
    protected function prepareMethodName(ParameterWrapperInterface $parameter)
    {
        return sprintf('process%sParameter', ucfirst($parameter->getType()));
    }

    /**
     * Parses the HTTP request for request parameters defined by the also passed operation.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest   The HTTP servlet request instance
     * @param \AppserverIo\RestApi\Wrappers\OperationWrapperInterface   $operationWrapper The operation wrapper
     *
     * @return array The array with the operations values pasrsed from the request
     * @throws \Exception is thrown, the context of the operation's parameter is invalid
     */
    public function parse(HttpServletRequestInterface $servletRequest, OperationWrapperInterface $operationWrapper)
    {

        // initialize the array for the parsed values
        $parameters = array();

        // iterate over the operations parameters and try load the value from the request
        foreach ($operationWrapper->getParameters() as $parameter) {
            // query the parameter context
            if ($parameter->isIn('path')) {
                // extract the value from the path info
                $value = $operationWrapper->getMatch($parameter);

                // cast the value depending on the specified type
                if ($parameter->getType() === 'integer') {
                    $parameters[] = (integer) $value;
                } elseif ($parameter->getType() === 'float') {
                    $parameters[] = (float) $value;
                } else {
                    $parameters[] = $value;
                }
            } elseif ($parameter->isIn('query')) {
                // try to load the value from the request parameters
                $parameters[] = call_user_func(array($this, $this->prepareMethodName($parameter)), $servletRequest, $parameter);
            } else {
                throw new \Exception(sprintf('Query parameter context "%s" is not supported yed', $parameter->getIn()));
            }
        }

        // return the array with parsed values
        return $parameters;
    }
}


1			<?php
2
3			/**
4			* AppserverIo\RestApi\Parsers\OA2\RequestParser
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\Parsers\OA2;
22
23			use AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface;
24			use AppserverIo\RestApi\Parsers\RequestParserInterface;
25			use AppserverIo\RestApi\Wrappers\OperationWrapperInterface;
26			use AppserverIo\RestApi\Wrappers\ParameterWrapperInterface;
27
28			/**
29			* OpenApi 2.0 compatible request parser.
30			*
31			* @author Tim Wagner <[email protected]>
32			* @copyright 2018 TechDivision GmbH <[email protected]>
33			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
34			* @link https://github.com/appserver-io/restapi
35			* @link http://www.appserver.io
36			*/
37			class RequestParser implements RequestParserInterface
38			{
39
40			/**
41			* Returns the integer value for the passed parameter from the request.
42			*
43			* @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest The HTTP servlet request instance
44			* @param \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface $parameter The parameter instance
45			*
46			* @return integer\|null The parsed value
47			* @throws \Exception Is thrown, if the specified collection format invalid
48			*/
49			protected function processArrayParameter(HttpServletRequestInterface $servletRequest, ParameterWrapperInterface $parameter)
50			{
51
52			// query the collection format specified for the parameter
53			if ($parameter->hasCollectionFormat('csv')) {
54			// load the value from the request
55			if ($param = $servletRequest->getParameter($parameter->getName())) {
56			// initialize the array for the values
57			$parameters = array();
58
59			// extract the values by parsing them as CSV string
60			foreach (str_getcsv(urldecode($param)) as $value) {
61			list ($key, $val) = explode('=', urldecode($value));
62			$parameters[$key] = $val;
63			}
64
65			// return the parameters
66			return $parameters;
			0 ignored issues – show Bug Best Practice introduced 2018-09-13 14:39 UTC by Report Bug Copy Issue Report The expression `return $parameters` returns the type `array` which is incompatible with the documented return type `null\|integer`. Loading history...
67			}
68
69			// return an empty array
70			return array();
			0 ignored issues – show Bug Best Practice introduced 2018-09-13 14:39 UTC by Report Bug Copy Issue Report The expression `return array()` returns the type `array` which is incompatible with the documented return type `null\|integer`. Loading history...
71			} elseif ($parameter->hasCollectionFormat('multi')) {
72			throw new \Exception('Collection format "multi" is not yet supported');
73			} else {
74			throw new \Exception(sprintf('Unknown collection format "%s" is not supported yet', $parameter->getCollectionFormat()));
75			}
76			}
77
78			/**
79			* Returns the string value for the passed parameter from the request.
80			*
81			* @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest The HTTP servlet request instance
82			* @param \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface $parameter The parameter instance
83			*
84			* @return string\|null The parsed value
85			*/
86			protected function processStringParameter(HttpServletRequestInterface $servletRequest, ParameterWrapperInterface $parameter)
87			{
88			return $servletRequest->getParameter($parameter->getName());
89			}
90
91			/**
92			* Returns the integer value for the passed parameter from the request.
93			*
94			* @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest The HTTP servlet request instance
95			* @param \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface $parameter The parameter instance
96			*
97			* @return integer\|null The parsed value
98			*/
99			protected function processIntegerParameter(HttpServletRequestInterface $servletRequest, ParameterWrapperInterface $parameter)
100			{
101			if ($value = $servletRequest->getParameter($parameter->getName(), FILTER_VALIDATE_INT)) {
102			return (integer) $value;
103			}
104			}
105
106			/**
107			* Returns the internal method name to load the value from the request parameters.
108			*
109			* @param \AppserverIo\RestApi\Wrappers\ParameterWrapperInterface $parameter The parameter to create prepare the method name for
110			*
111			* @return string The prepared method name
112			*/
113			protected function prepareMethodName(ParameterWrapperInterface $parameter)
114			{
115			return sprintf('process%sParameter', ucfirst($parameter->getType()));
116			}
117
118			/**
119			* Parses the HTTP request for request parameters defined by the also passed operation.
120			*
121			* @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface $servletRequest The HTTP servlet request instance
122			* @param \AppserverIo\RestApi\Wrappers\OperationWrapperInterface $operationWrapper The operation wrapper
123			*
124			* @return array The array with the operations values pasrsed from the request
125			* @throws \Exception is thrown, the context of the operation's parameter is invalid
126			*/
127			public function parse(HttpServletRequestInterface $servletRequest, OperationWrapperInterface $operationWrapper)
128			{
129
130			// initialize the array for the parsed values
131			$parameters = array();
132
133			// iterate over the operations parameters and try load the value from the request
134			foreach ($operationWrapper->getParameters() as $parameter) {
135			// query the parameter context
136			if ($parameter->isIn('path')) {
137			// extract the value from the path info
138			$value = $operationWrapper->getMatch($parameter);
139
140			// cast the value depending on the specified type
141			if ($parameter->getType() === 'integer') {
142			$parameters[] = (integer) $value;
143			} elseif ($parameter->getType() === 'float') {
144			$parameters[] = (float) $value;
145			} else {
146			$parameters[] = $value;
147			}
148			} elseif ($parameter->isIn('query')) {
149			// try to load the value from the request parameters
150			$parameters[] = call_user_func(array($this, $this->prepareMethodName($parameter)), $servletRequest, $parameter);
151			} else {
152			throw new \Exception(sprintf('Query parameter context "%s" is not supported yed', $parameter->getIn()));
153			}
154			}
155
156			// return the array with parsed values
157			return $parameters;
158			}
159			}
160

appserver-io / restapi

RequestParser::prepareMethodName() A last analyzed 2018-09-15 17:59 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RequestParser::prepareMethodName() A
last analyzed 2018-09-15 17:59 UTC