Request::getContextPrefix() - Code Metrics - Inspection of "Add router api" - maikgreubel/caribu-mvc - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 188443...8f2ae0 )

by Maik

created 2017-08-14 12:05 UTC

Request::getContextPrefix() A

↳ Parent: Request

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
namespace Nkey\Caribu\Mvc\Controller;

use \Generics\Socket\InvalidUrlException;

/**
 * The request is encapsulated in this class
 *
 * @author Maik Greubel <[email protected]>
 *
 *         This file is part of Caribu MVC package
 */
class Request
{
    use \Nkey\Caribu\Mvc\Util\RequestParser;

    /**
     * Address of remote host
     *
     * @var string
     */
    private $remoteHost;

    /**
     * Original request uri
     *
     * @var string
     */
    private $origin = null;

    /**
     * Controller requested
     *
     * @var string
     */
    private $controller = null;

    /**
     * Action requested
     *
     * @var string
     */
    private $action = null;

    /**
     * Parameters of the request
     *
     * @var array
     */
    private $params = array();

    /**
     * Prefix of the uri inside application context
     *
     * @var string
     */
    private $contextPrefix = null;

    /**
     * An occured exception
     *
     * @var \Exception
     */
    private $exception;

    /**
     * Create a new instance of request
     *
     * @param string $defaultController
     *            The name of default controller of nothing is provided
     * @param string $defaultAction
     *            The name of default action if nothing is provided
     */
    private function __construct($defaultController, $defaultAction)
    {
        $this->controller = $defaultController;
        $this->action = $defaultAction;
    }

    /**
     * Parse an uri into its request parts
     *
     * @param string $uri
     *            The uri to parse
     *
     * @param array $serverVars
     *            The variables provided by sapi
     *
     * @param string $defaultController
     *            The name of the default controller if nothing else is requested
     *
     * @param string $defaultAction
     *            The name of the default action if nothing else is requested
     *
     * @return \Nkey\Caribu\Mvc\Controller\Request The new created request
     */
    public static function parse($uri, $serverVars = array(), $defaultController = 'Index', $defaultAction = 'index')
    {
        $req = new self($defaultController, $defaultAction);
        $req->origin = $uri;
        
        self::parseRemoteHost($req, $serverVars);
        
        self::parseGetPostSessionCookie($req);
        
        // Save the request parameters for later usage and rewrite the uri
        $savedRequestParams = array();
        if (strpos($uri, '?')) {
            parse_str(substr($uri, strpos($uri, '?') + 1), $savedRequestParams);
            $uri = substr($uri, 0, strpos($uri, '?'));
        }
        
        self::parseContextPrefix($req, $serverVars);
        
        $parts = self::parseUri($req, $uri, $defaultController, $defaultAction);
        
        // Walk over all parameters and put them into container
        $numParts = count($parts);
        for ($i = 0; $i < $numParts; $i = $i + 2) {
            $paramName = trim($parts[$i]);
            $paramValue = isset($parts[$i + 1]) ? trim($parts[$i + 1]) : '';
            if ($paramName && $paramValue) {
                $req->params[$paramName] = $paramValue;
            }
        }
        
        $req->params = array_merge($req->params, $savedRequestParams);
        
        self::parseParameters($req, $serverVars);
        
        // Et'voila
        return $req;
    }

    /**
     * Parse uri directly from request uri
     *
     * @param array $serverVars
     *            The server variables provided by sapi
     * @param string $defaultController The
     *            name of the default controller
     * @param string $defaultAction The
     *            name of the default action
     *
     * @return \Nkey\Caribu\Mvc\Controller\Request
     *
     * @throws InvalidUrlException If no uri exists (e.g. sapi = cli)
     */
    public static function parseFromServerRequest($serverVars, $defaultController = 'Index', $defaultAction = 'index')
    {
        if (! isset($serverVars['REQUEST_URI'])) {
            throw new InvalidUrlException("No such uri provided");
        }
        return self::parse($serverVars['REQUEST_URI'], $serverVars, $defaultController, $defaultAction);
    }

    /**
     * The origin uri
     *
     * @return string The original request string
     */
    public function getOrigin()
    {
        return $this->origin;
    }

    /**
     * The requested controller
     *
     * @return string The controller
     */
    public function getController()
    {
        return $this->controller;
    }
    
    /**
     * Set controller property
     * 
     * @param string $controller
     */
    public function setController($controller)
    {
    	$this->controller = strval($controller);
    }

    /**
     * The requested action
     *
     * @return string The action
     */
    public function getAction()
    {
        return $this->action;
    }
    
    /**
     * Set action property
     * 
     * @param string $action
     */
    public function setAction($action)
    {
    	$this->action = $action;
    }

    /**
     * Retrieve the request parameters
     *
     * @return array The request parameters
     */
    public function getParams()
    {
        return $this->params;
    }

    /**
     * Retrieve the context prefix
     *
     * @return string The context prefix
     */
    public function getContextPrefix()
    {
        return $this->contextPrefix;
    }
    
    /**
     * Set context prefix property
     * 
     * @param string $prefix
     */
    public function setContextPrefix($prefix)
    {
    	$this->contextPrefix = strval($prefix);
    }

    /**
     * Retrieve the remote host
     *
     * @return string The remote host address
     */
    public function getRemoteHost()
    {
        return $this->remoteHost;
    }

    /**
     * Check whether a given parameter exists
     *
     * @param string $name
     *            The name of the parameter
     * @return boolean true in case of it exists, false otherwise
     */
    public function hasParam($name)
    {
        return isset($this->params[$name]);
    }

    /**
     * Get value of particular parameter
     *
     * @param string $name
     *            The name of parameters
     * @param string $typeOf
     *            The type expected parameter value
     * @return mixed Depending on $typeOf the value as requested type and escaped
     */
    public function getParam($name, $typeOf = 'string')
    {
        $result = $this->hasParam($name) ? $this->params[$name] : null;
        
        switch ($typeOf) {
            case 'bool':
            case 'boolean':
                $result = function_exists('boolval') ? boolval($result) : (bool) $result;
                break;
            
            case 'double':
            case 'float':
                $result = doubleval($result);
                break;
            
            case 'int':
                $result = intval($result);
                break;
            
            case 'string':
            default:
                $result = htmlentities(strval($result));
                break;
        }
        
        return $result;
    }

    /**
     * To override a given parameter
     *
     * @param string $name
     *            The parameter name to override
     * @param string $value
     *            The value to override
     *
     * @return Request the current request as fluent interface
     */
    public function setParam($name, $value)
    {
        $this->params[$name] = $value;
        return $this;
    }

    /**
     * Set the exception occured
     *
     * @param \Exception $ex
     *
     * @return Request the current request instance
     */
    public function setException(\Exception $ex)
    {
        $this->exception = $ex;
        return $this;
    }

    /**
     * Get the exception occured
     *
     * @return \Exception
     */
    public function getException()
    {
        return $this->exception;
    }
}


1		<?php
2		namespace Nkey\Caribu\Mvc\Controller;
3
4		use \Generics\Socket\InvalidUrlException;
5
6		/**
7		* The request is encapsulated in this class
8		*
9		* @author Maik Greubel <[email protected]>
10		*
11		* This file is part of Caribu MVC package
12		*/
13		class Request
14		{
15		use \Nkey\Caribu\Mvc\Util\RequestParser;
16
17		/**
18		* Address of remote host
19		*
20		* @var string
21		*/
22		private $remoteHost;
23
24		/**
25		* Original request uri
26		*
27		* @var string
28		*/
29		private $origin = null;
30
31		/**
32		* Controller requested
33		*
34		* @var string
35		*/
36		private $controller = null;
37
38		/**
39		* Action requested
40		*
41		* @var string
42		*/
43		private $action = null;
44
45		/**
46		* Parameters of the request
47		*
48		* @var array
49		*/
50		private $params = array();
51
52		/**
53		* Prefix of the uri inside application context
54		*
55		* @var string
56		*/
57		private $contextPrefix = null;
58
59		/**
60		* An occured exception
61		*
62		* @var \Exception
63		*/
64		private $exception;
65
66		/**
67		* Create a new instance of request
68		*
69		* @param string $defaultController
70		* The name of default controller of nothing is provided
71		* @param string $defaultAction
72		* The name of default action if nothing is provided
73		*/
74	26	private function __construct($defaultController, $defaultAction)
75		{
76	26	$this->controller = $defaultController;
77	26	$this->action = $defaultAction;
78	26	}
79
80		/**
81		* Parse an uri into its request parts
82		*
83		* @param string $uri
84		* The uri to parse
85		*
86		* @param array $serverVars
87		* The variables provided by sapi
88		*
89		* @param string $defaultController
90		* The name of the default controller if nothing else is requested
91		*
92		* @param string $defaultAction
93		* The name of the default action if nothing else is requested
94		*
95		* @return \Nkey\Caribu\Mvc\Controller\Request The new created request
96		*/
97	26	public static function parse($uri, $serverVars = array(), $defaultController = 'Index', $defaultAction = 'index')
98		{
99	26	$req = new self($defaultController, $defaultAction);
100	26	$req->origin = $uri;
101
102	26	self::parseRemoteHost($req, $serverVars);
103
104	26	self::parseGetPostSessionCookie($req);
105
106		// Save the request parameters for later usage and rewrite the uri
107	26	$savedRequestParams = array();
108	26	if (strpos($uri, '?')) {
109	1	parse_str(substr($uri, strpos($uri, '?') + 1), $savedRequestParams);
110	1	$uri = substr($uri, 0, strpos($uri, '?'));
111		}
112
113	26	self::parseContextPrefix($req, $serverVars);
114
115	26	$parts = self::parseUri($req, $uri, $defaultController, $defaultAction);
116
117		// Walk over all parameters and put them into container
118	26	$numParts = count($parts);
119	26	for ($i = 0; $i < $numParts; $i = $i + 2) {
120	2	$paramName = trim($parts[$i]);
121	2	$paramValue = isset($parts[$i + 1]) ? trim($parts[$i + 1]) : '';
122	2	if ($paramName && $paramValue) {
123	1	$req->params[$paramName] = $paramValue;
124		}
125		}
126
127	26	$req->params = array_merge($req->params, $savedRequestParams);
128
129	26	self::parseParameters($req, $serverVars);
130
131		// Et'voila
132	26	return $req;
133		}
134
135		/**
136		* Parse uri directly from request uri
137		*
138		* @param array $serverVars
139		* The server variables provided by sapi
140		* @param string $defaultController The
141		* name of the default controller
142		* @param string $defaultAction The
143		* name of the default action
144		*
145		* @return \Nkey\Caribu\Mvc\Controller\Request
146		*
147		* @throws InvalidUrlException If no uri exists (e.g. sapi = cli)
148		*/
149	7	public static function parseFromServerRequest($serverVars, $defaultController = 'Index', $defaultAction = 'index')
150		{
151	7	if (! isset($serverVars['REQUEST_URI'])) {
152	1	throw new InvalidUrlException("No such uri provided");
153		}
154	6	return self::parse($serverVars['REQUEST_URI'], $serverVars, $defaultController, $defaultAction);
155		}
156
157		/**
158		* The origin uri
159		*
160		* @return string The original request string
161		*/
162	3	public function getOrigin()
163		{
164	3	return $this->origin;
165		}
166
167		/**
168		* The requested controller
169		*
170		* @return string The controller
171		*/
172	23	public function getController()
173		{
174	23	return $this->controller;
175		}
176
177		/**
178		* Set controller property
179		*
180		* @param string $controller
181		*/
182	22	public function setController($controller)
183		{
184	22	$this->controller = strval($controller);
185	22	}
186
187		/**
188		* The requested action
189		*
190		* @return string The action
191		*/
192	23	public function getAction()
193		{
194	23	return $this->action;
195		}
196
197		/**
198		* Set action property
199		*
200		* @param string $action
201		*/
202	20	public function setAction($action)
203		{
204	20	$this->action = $action;
205	20	}
206
207		/**
208		* Retrieve the request parameters
209		*
210		* @return array The request parameters
211		*/
212	5	public function getParams()
213		{
214	5	return $this->params;
215		}
216
217		/**
218		* Retrieve the context prefix
219		*
220		* @return string The context prefix
221		*/
222	26	public function getContextPrefix()
223		{
224	26	return $this->contextPrefix;
225		}
226
227		/**
228		* Set context prefix property
229		*
230		* @param string $prefix
231		*/
232	5	public function setContextPrefix($prefix)
233		{
234	5	$this->contextPrefix = strval($prefix);
235	5	}
236
237		/**
238		* Retrieve the remote host
239		*
240		* @return string The remote host address
241		*/
242	24	public function getRemoteHost()
243		{
244	24	return $this->remoteHost;
245		}
246
247		/**
248		* Check whether a given parameter exists
249		*
250		* @param string $name
251		* The name of the parameter
252		* @return boolean true in case of it exists, false otherwise
253		*/
254	1	public function hasParam($name)
255		{
256	1	return isset($this->params[$name]);
257		}
258
259		/**
260		* Get value of particular parameter
261		*
262		* @param string $name
263		* The name of parameters
264		* @param string $typeOf
265		* The type expected parameter value
266		* @return mixed Depending on $typeOf the value as requested type and escaped
267		*/
268	1	public function getParam($name, $typeOf = 'string')
269		{
270	1	$result = $this->hasParam($name) ? $this->params[$name] : null;
271
272		switch ($typeOf) {
273	1	case 'bool':
274	1	case 'boolean':
275		$result = function_exists('boolval') ? boolval($result) : (bool) $result;
276		break;
277
278	1	case 'double':
279	1	case 'float':
280		$result = doubleval($result);
281		break;
282
283	1	case 'int':
284		$result = intval($result);
285		break;
286
287	1	case 'string':
288		default:
289	1	$result = htmlentities(strval($result));
290	1	break;
291		}
292
293	1	return $result;
294		}
295
296		/**
297		* To override a given parameter
298		*
299		* @param string $name
300		* The parameter name to override
301		* @param string $value
302		* The value to override
303		*
304		* @return Request the current request as fluent interface
305		*/
306	7	public function setParam($name, $value)
307		{
308	7	$this->params[$name] = $value;
309	7	return $this;
310		}
311
312		/**
313		* Set the exception occured
314		*
315		* @param \Exception $ex
316		*
317		* @return Request the current request instance
318		*/
319	1	public function setException(\Exception $ex)
320		{
321	1	$this->exception = $ex;
322	1	return $this;
323		}
324
325		/**
326		* Get the exception occured
327		*
328		* @return \Exception
329		*/
330	1	public function getException()
331		{
332	1	return $this->exception;
333		}
334		}
335

maikgreubel / caribu-mvc

Push — master ( 188443...8f2ae0 )

Request::getContextPrefix() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like