URequest::setPostValuesToObject() - Code Metrics - Inspection of "[update] accessControlAllow + tokens refactoring" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 696af1...07df9d )

by Jean-Christophe

created 2019-04-15 15:39 UTC

URequest::setPostValuesToObject() A

↳ Parent: URequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Ubiquity\utils\http;

use Ubiquity\controllers\Startup;
use Ubiquity\utils\base\UString;

/**
 * Http Request utilities, wrapper for accessing to $_GET, $_POST and php://input.
 * Ubiquity\utils\http$URequest
 * This class is part of Ubiquity
 *
 * @author jcheron <[email protected]>
 * @version 1.0.0
 *
 */
class URequest {

	/**
	 * Affects member to member the values of the associative array $values to the members of the object $object
	 * Used for example to retrieve the variables posted and assign them to the members of an object
	 *
	 * @param object $object
	 * @param associative array $values
	 */
	public static function setValuesToObject($object, $values = null) {
		if (! isset ( $values ))
			$values = $_POST;
		foreach ( $values as $key => $value ) {
			$accessor = "set" . ucfirst ( $key );
			if (method_exists ( $object, $accessor )) {
				$object->$accessor ( $value );
				$object->_rest [$key] = $value;
			}
		}
	}

	/**
	 * Affects member to member the values of $_GET to the members of the object $object
	 * $object must have accessors to each members
	 *
	 * @param object $object
	 */
	public static function setGetValuesToObject($object) {
		self::setValuesToObject ( $object, $_GET );
	}

	/**
	 * Affects member to member the values of $_POST to the members of the object $object
	 * $object must have accessors to each members
	 *
	 * @param object $object
	 */
	public static function setPostValuesToObject($object) {
		self::setValuesToObject ( $object, $_POST );
	}

	/**
	 * Call a cleaning function on the post
	 *
	 * @param string $function the cleaning function, default htmlentities
	 * @return array
	 */
	public static function getPost($function = "htmlentities") {
		return array_map ( $function, $_POST );
	}

	/**
	 * Returns the query data, for PUT, DELETE PATCH methods
	 */
	public static function getInput() {
		$put = array ();
		\parse_str ( \file_get_contents ( 'php://input' ), $put );
		return $put;
	}

	/**
	 * Returns the query data, regardless of the method
	 *
	 * @return array
	 */
	public static function getDatas() {
		$method = \strtolower ( $_SERVER ['REQUEST_METHOD'] );
		switch ($method) {
			case 'post' :
				if (self::getContentType () == 'application/x-www-form-urlencoded') {
					return $_POST;
				}
				break;
			case 'get' :
				return $_GET;
			default :
				return self::getInput ();
		}
		return self::getInput ();
	}

	/**
	 * Returns the request content-type header
	 *
	 * @return string
	 */
	public static function getContentType() {
		$headers = getallheaders ();
		if (isset ( $headers ["Content-Type"] )) {
			return $headers ["Content-Type"];
		}
		return null;
	}

	/**
	 * Copyright © 2008 Darrin Yeager
	 * https://www.dyeager.org/
	 * Licensed under BSD license.
	 * https://www.dyeager.org/downloads/license-bsd.txt
	 */
	public static function getDefaultLanguage() {
		if (isset ( $_SERVER ["HTTP_ACCEPT_LANGUAGE"] ))
			return self::parseDefaultLanguage ( $_SERVER ["HTTP_ACCEPT_LANGUAGE"] );
		else
			return self::parseDefaultLanguage ( NULL );
	}

	private static function parseDefaultLanguage($http_accept, $deflang = "en") {
		if (isset ( $http_accept ) && strlen ( $http_accept ) > 1) {
			$x = explode ( ",", $http_accept );
			$lang = [ ];
			foreach ( $x as $val ) {
				if (preg_match ( "/(.*);q=([0-1]{0,1}.\d{0,4})/i", $val, $matches ))
					$lang [$matches [1]] = ( float ) $matches [2];
				else
					$lang [$val] = 1.0;
			}

			$qval = 0.0;
			foreach ( $lang as $key => $value ) {
				if ($value > $qval) {
					$qval = ( float ) $value;
					$deflang = $key;
				}
			}
		}
		return $deflang;
	}

	public static function setLocale(string $locale) {
		try {
			if (class_exists ( 'Locale', false )) {
				\Locale::setDefault ( $locale );
			}
		} catch ( \Exception $e ) {
			// Nothing to do
		}
	}

	/**
	 * Returns true if the request is an Ajax request
	 *
	 * @return boolean
	 */
	public static function isAjax() {
		return (isset ( $_SERVER ['HTTP_X_REQUESTED_WITH'] ) && ! empty ( $_SERVER ['HTTP_X_REQUESTED_WITH'] ) && strtolower ( $_SERVER ['HTTP_X_REQUESTED_WITH'] ) == 'xmlhttprequest');
	}

	/**
	 * Returns true if the request is sent by the POST method
	 *
	 * @return boolean
	 */
	public static function isPost() {
		return $_SERVER ['REQUEST_METHOD'] === 'POST';
	}

	/**
	 * Returns true if the request is cross site
	 *
	 * @return boolean
	 */
	public static function isCrossSite() {
		return stripos ( $_SERVER ['HTTP_REFERER'], $_SERVER ['SERVER_NAME'] ) === FALSE;
	}

	/**
	 * Returns true if request contentType is set to json
	 *
	 * @return boolean
	 */
	public static function isJSON() {
		$contentType = self::getContentType ();
		return \stripos ( $contentType, "json" ) !== false;
	}

	/**
	 * Returns the value of the $key variable passed by the get method or $default if the $key variable does not exist
	 *
	 * @param string $key
	 * @param string $default return value by default
	 * @return string
	 */
	public static function get($key, $default = NULL) {
		return isset ( $_GET [$key] ) ? $_GET [$key] : $default;
	}

	/**
	 * Returns a boolean at the key position in request
	 *
	 * @param string $key the key to add or set
	 * @return boolean
	 */
	public static function getBoolean($key) {
		$ret = false;
		if (isset ( $_REQUEST [$key] )) {
			$ret = UString::isBooleanTrue ( $_REQUEST [$key] );
		}
		return $ret;
	}

	/**
	 * Returns the value of the $key variable passed by the post method or $default if the $key variable does not exist
	 *
	 * @param string $key
	 * @param string $default return value by default
	 * @return string
	 */
	public static function post($key, $default = NULL) {
		return isset ( $_POST [$key] ) ? $_POST [$key] : $default;
	}

	public static function getUrl($url) {
		$config = Startup::getConfig ();
		$siteUrl = \rtrim ( $config ["siteUrl"], '/' );
		if (UString::startswith ( $url, "/" ) === false) {
			$url = "/" . $url;
		}
		return $siteUrl . $url;
	}

	public static function getUrlParts() {
		return \explode ( "/", $_GET ["c"] );
	}

	/**
	 * Returns the http method
	 *
	 * @return string
	 */
	public static function getMethod() {
		return \strtolower ( $_SERVER ['REQUEST_METHOD'] );
	}

	/**
	 * Returns the request origin
	 *
	 * @return string
	 */
	public static function getOrigin() {
		$headers = getallheaders ();
		if (isset ( $headers ['Origin'] )) {
			return $headers ['Origin'];
		}
		if (isset ( $_SERVER ['HTTP_ORIGIN'] )) {
			return $_SERVER ['HTTP_ORIGIN'];
		} else if (isset ( $_SERVER ['HTTP_REFERER'] )) {
			return $_SERVER ['HTTP_REFERER'];
		} else {
			return $_SERVER ['REMOTE_ADDR'];
		}
	}

	public static function cleanUrl($url) {
		$url = \str_replace ( "\\", "/", $url );
		return \str_replace ( "//", "/", $url );
	}

	/**
	 * Fix up PHP's messing up input containing dots, etc.
	 * `$source` can be either 'post' or 'get'
	 *
	 * @param string $source
	 * @return string[]
	 * @see https://stackoverflow.com/questions/68651/can-i-get-php-to-stop-replacing-characters-in-get-or-post-arrays#68667
	 */
	public static function getRealInput($source = 'post') {
		$pairs = explode ( "&", strtolower ( $source ) === 'post' ? file_get_contents ( "php://input" ) : $_SERVER ['QUERY_STRING'] );
		$vars = array ();
		foreach ( $pairs as $pair ) {
			$nv = explode ( "=", $pair );
			$name = urldecode ( $nv [0] );
			$value = urldecode ( $nv [1] ?? '');
			$vars [$name] = $value;
		}
		return $vars;
	}

	public static function getRealGET() {
		return self::getRealInput ( 'get' );
	}

	public static function getRealPOST() {
		return self::getRealInput ( 'post' );
	}
}


1		<?php
2
3		namespace Ubiquity\utils\http;
4
5		use Ubiquity\controllers\Startup;
6		use Ubiquity\utils\base\UString;
7
8		/**
9		* Http Request utilities, wrapper for accessing to $_GET, $_POST and php://input.
10		* Ubiquity\utils\http$URequest
11		* This class is part of Ubiquity
12		*
13		* @author jcheron <[email protected]>
14		* @version 1.0.0
15		*
16		*/
17		class URequest {
18
19		/**
20		* Affects member to member the values of the associative array $values to the members of the object $object
21		* Used for example to retrieve the variables posted and assign them to the members of an object
22		*
23		* @param object $object
24		* @param associative array $values
25		*/
26	3	public static function setValuesToObject($object, $values = null) {
27	3	if (! isset ( $values ))
28		$values = $_POST;
29	3	foreach ( $values as $key => $value ) {
30	3	$accessor = "set" . ucfirst ( $key );
31	3	if (method_exists ( $object, $accessor )) {
32	3	$object->$accessor ( $value );
33	3	$object->_rest [$key] = $value;
34		}
35		}
36	3	}
37
38		/**
39		* Affects member to member the values of $_GET to the members of the object $object
40		* $object must have accessors to each members
41		*
42		* @param object $object
43		*/
44		public static function setGetValuesToObject($object) {
45		self::setValuesToObject ( $object, $_GET );
46		}
47
48		/**
49		* Affects member to member the values of $_POST to the members of the object $object
50		* $object must have accessors to each members
51		*
52		* @param object $object
53		*/
54		public static function setPostValuesToObject($object) {
55		self::setValuesToObject ( $object, $_POST );
56		}
57
58		/**
59		* Call a cleaning function on the post
60		*
61		* @param string $function the cleaning function, default htmlentities
62		* @return array
63		*/
64		public static function getPost($function = "htmlentities") {
65		return array_map ( $function, $_POST );
66		}
67
68		/**
69		* Returns the query data, for PUT, DELETE PATCH methods
70		*/
71		public static function getInput() {
72		$put = array ();
73		\parse_str ( \file_get_contents ( 'php://input' ), $put );
74		return $put;
75		}
76
77		/**
78		* Returns the query data, regardless of the method
79		*
80		* @return array
81		*/
82		public static function getDatas() {
83		$method = \strtolower ( $_SERVER ['REQUEST_METHOD'] );
84		switch ($method) {
85		case 'post' :
86		if (self::getContentType () == 'application/x-www-form-urlencoded') {
87		return $_POST;
88		}
89		break;
90		case 'get' :
91		return $_GET;
92		default :
93		return self::getInput ();
94		}
95		return self::getInput ();
96		}
97
98		/**
99		* Returns the request content-type header
100		*
101		* @return string
102		*/
103		public static function getContentType() {
104		$headers = getallheaders ();
105		if (isset ( $headers ["Content-Type"] )) {
106		return $headers ["Content-Type"];
107		}
108		return null;
109		}
110
111		/**
112		* Copyright © 2008 Darrin Yeager
113		* https://www.dyeager.org/
114		* Licensed under BSD license.
115		* https://www.dyeager.org/downloads/license-bsd.txt
116		*/
117	1	public static function getDefaultLanguage() {
118	1	if (isset ( $_SERVER ["HTTP_ACCEPT_LANGUAGE"] ))
119	1	return self::parseDefaultLanguage ( $_SERVER ["HTTP_ACCEPT_LANGUAGE"] );
120		else
121		return self::parseDefaultLanguage ( NULL );
122		}
123
124	1	private static function parseDefaultLanguage($http_accept, $deflang = "en") {
125	1	if (isset ( $http_accept ) && strlen ( $http_accept ) > 1) {
126	1	$x = explode ( ",", $http_accept );
127	1	$lang = [ ];
128	1	foreach ( $x as $val ) {
129	1	if (preg_match ( "/(.*);q=([0-1]{0,1}.\d{0,4})/i", $val, $matches ))
130	1	$lang [$matches [1]] = ( float ) $matches [2];
131		else
132	1	$lang [$val] = 1.0;
133		}
134
135	1	$qval = 0.0;
136	1	foreach ( $lang as $key => $value ) {
137	1	if ($value > $qval) {
138	1	$qval = ( float ) $value;
139	1	$deflang = $key;
140		}
141		}
142		}
143	1	return $deflang;
144		}
145
146		public static function setLocale(string $locale) {
147		try {
148		if (class_exists ( 'Locale', false )) {
149		\Locale::setDefault ( $locale );
150		}
151		} catch ( \Exception $e ) {
152		// Nothing to do
153		}
154		}
155
156		/**
157		* Returns true if the request is an Ajax request
158		*
159		* @return boolean
160		*/
161	22	public static function isAjax() {
162	22	return (isset ( $_SERVER ['HTTP_X_REQUESTED_WITH'] ) && ! empty ( $_SERVER ['HTTP_X_REQUESTED_WITH'] ) && strtolower ( $_SERVER ['HTTP_X_REQUESTED_WITH'] ) == 'xmlhttprequest');
163		}
164
165		/**
166		* Returns true if the request is sent by the POST method
167		*
168		* @return boolean
169		*/
170	5	public static function isPost() {
171	5	return $_SERVER ['REQUEST_METHOD'] === 'POST';
172		}
173
174		/**
175		* Returns true if the request is cross site
176		*
177		* @return boolean
178		*/
179		public static function isCrossSite() {
180		return stripos ( $_SERVER ['HTTP_REFERER'], $_SERVER ['SERVER_NAME'] ) === FALSE;
181		}
182
183		/**
184		* Returns true if request contentType is set to json
185		*
186		* @return boolean
187		*/
188		public static function isJSON() {
189		$contentType = self::getContentType ();
190		return \stripos ( $contentType, "json" ) !== false;
191		}
192
193		/**
194		* Returns the value of the $key variable passed by the get method or $default if the $key variable does not exist
195		*
196		* @param string $key
197		* @param string $default return value by default
198		* @return string
199		*/
200		public static function get($key, $default = NULL) {
201		return isset ( $_GET [$key] ) ? $_GET [$key] : $default;
202		}
203
204		/**
205		* Returns a boolean at the key position in request
206		*
207		* @param string $key the key to add or set
208		* @return boolean
209		*/
210		public static function getBoolean($key) {
211		$ret = false;
212		if (isset ( $_REQUEST [$key] )) {
213		$ret = UString::isBooleanTrue ( $_REQUEST [$key] );
214		}
215		return $ret;
216		}
217
218		/**
219		* Returns the value of the $key variable passed by the post method or $default if the $key variable does not exist
220		*
221		* @param string $key
222		* @param string $default return value by default
223		* @return string
224		*/
225	5	public static function post($key, $default = NULL) {
226	5	return isset ( $_POST [$key] ) ? $_POST [$key] : $default;
227		}
228
229	20	public static function getUrl($url) {
230	20	$config = Startup::getConfig ();
231	20	$siteUrl = \rtrim ( $config ["siteUrl"], '/' );
232	20	if (UString::startswith ( $url, "/" ) === false) {
233	19	$url = "/" . $url;
234		}
235	20	return $siteUrl . $url;
236		}
237
238		public static function getUrlParts() {
239		return \explode ( "/", $_GET ["c"] );
240		}
241
242		/**
243		* Returns the http method
244		*
245		* @return string
246		*/
247	7	public static function getMethod() {
248	7	return \strtolower ( $_SERVER ['REQUEST_METHOD'] );
249		}
250
251		/**
252		* Returns the request origin
253		*
254		* @return string
255		*/
256		public static function getOrigin() {
257		$headers = getallheaders ();
258		if (isset ( $headers ['Origin'] )) {
259		return $headers ['Origin'];
260		}
261		if (isset ( $_SERVER ['HTTP_ORIGIN'] )) {
262		return $_SERVER ['HTTP_ORIGIN'];
263		} else if (isset ( $_SERVER ['HTTP_REFERER'] )) {
264		return $_SERVER ['HTTP_REFERER'];
265		} else {
266		return $_SERVER ['REMOTE_ADDR'];
267		}
268		}
269
270		public static function cleanUrl($url) {
271		$url = \str_replace ( "\\", "/", $url );
272		return \str_replace ( "//", "/", $url );
273		}
274
275		/**
276		* Fix up PHP's messing up input containing dots, etc.
277		* `$source` can be either 'post' or 'get'
278		*
279		* @param string $source
280		* @return string[]
281		* @see https://stackoverflow.com/questions/68651/can-i-get-php-to-stop-replacing-characters-in-get-or-post-arrays#68667
282		*/
283		public static function getRealInput($source = 'post') {
284		$pairs = explode ( "&", strtolower ( $source ) === 'post' ? file_get_contents ( "php://input" ) : $_SERVER ['QUERY_STRING'] );
285		$vars = array ();
286		foreach ( $pairs as $pair ) {
287		$nv = explode ( "=", $pair );
288		$name = urldecode ( $nv [0] );
289		$value = urldecode ( $nv [1] ?? '');
290		$vars [$name] = $value;
291		}
292		return $vars;
293		}
294
295		public static function getRealGET() {
296		return self::getRealInput ( 'get' );
297		}
298
299		public static function getRealPOST() {
300		return self::getRealInput ( 'post' );
301		}
302		}
303

phpMv / ubiquity

Push — master ( 696af1...07df9d )

URequest::setPostValuesToObject() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like