FauxRequest::getValues() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

FauxRequest::getValues() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: FauxRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Deal with importing all those nasty globals and things
 *
 * Copyright © 2003 Brion Vibber <[email protected]>
 * https://www.mediawiki.org/
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

use MediaWiki\Session\SessionManager;

/**
 * WebRequest clone which takes values from a provided array.
 *
 * @ingroup HTTP
 */
class FauxRequest extends WebRequest {
	private $wasPosted = false;
	private $requestUrl;
	protected $cookies = [];

	/**
	 * @param array $data Array of *non*-urlencoded key => value pairs, the
	 *   fake GET/POST values
	 * @param bool $wasPosted Whether to treat the data as POST
	 * @param MediaWiki\Session\Session|array|null $session Session, session
	 *  data array, or null
	 * @param string $protocol 'http' or 'https'
	 * @throws MWException
	 */
	public function __construct( $data = [], $wasPosted = false,
		$session = null, $protocol = 'http'
	) {
		$this->requestTime = microtime( true );

		if ( is_array( $data ) ) {
			$this->data = $data;
		} else {
			throw new MWException( "FauxRequest() got bogus data" );
		}
		$this->wasPosted = $wasPosted;
		if ( $session instanceof MediaWiki\Session\Session ) {
			$this->sessionId = $session->getSessionId();
		} elseif ( is_array( $session ) ) {
			$mwsession = SessionManager::singleton()->getEmptySession( $this );
			$this->sessionId = $mwsession->getSessionId();
			foreach ( $session as $key => $value ) {
				$mwsession->set( $key, $value );
			}
		} elseif ( $session !== null ) {
			throw new MWException( "FauxRequest() got bogus session" );
		}
		$this->protocol = $protocol;
	}

	/**
	 * Initialise the header list
	 */
	protected function initHeaders() {
		// Nothing to init
	}

	/**
	 * @param string $name
	 * @param string $default
	 * @return string
	 */
	public function getText( $name, $default = '' ) {
		# Override; don't recode since we're using internal data
		return (string)$this->getVal( $name, $default );
	}

	/**
	 * @return array
	 */
	public function getValues() {
		return $this->data;
	}

	/**
	 * @return array
	 */
	public function getQueryValues() {
		if ( $this->wasPosted ) {
			return [];
		} else {
			return $this->data;
		}
	}

	public function getMethod() {
		return $this->wasPosted ? 'POST' : 'GET';
	}

	/**
	 * @return bool
	 */
	public function wasPosted() {
		return $this->wasPosted;
	}

	public function getCookie( $key, $prefix = null, $default = null ) {
		if ( $prefix === null ) {
			global $wgCookiePrefix;
			$prefix = $wgCookiePrefix;
		}
		$name = $prefix . $key;
		return isset( $this->cookies[$name] ) ? $this->cookies[$name] : $default;
	}

	/**
	 * @since 1.26
	 * @param string $name Unprefixed name of the cookie to set
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @param string|null $value Value of the cookie to set
	 * @param string|null $prefix Cookie prefix. Defaults to $wgCookiePrefix
	 */
	public function setCookie( $key, $value, $prefix = null ) {
		$this->setCookies( [ $key => $value ], $prefix );
	}

	/**
	 * @since 1.26
	 * @param array $cookies
	 * @param string|null $prefix Cookie prefix. Defaults to $wgCookiePrefix
	 */
	public function setCookies( $cookies, $prefix = null ) {
		if ( $prefix === null ) {
			global $wgCookiePrefix;
			$prefix = $wgCookiePrefix;
		}
		foreach ( $cookies as $key => $value ) {
			$name = $prefix . $key;
			$this->cookies[$name] = $value;
		}
	}

	/**
	 * @since 1.25
	 */
	public function setRequestURL( $url ) {
		$this->requestUrl = $url;
	}

	/**
	 * @since 1.25 MWException( "getRequestURL not implemented" )
	 * no longer thrown.
	 */
	public function getRequestURL() {
		if ( $this->requestUrl === null ) {
			throw new MWException( 'Request URL not set' );
		}
		return $this->requestUrl;
	}

	public function getProtocol() {
		return $this->protocol;
	}

	/**
	 * @param string $name
	 * @param string $val
	 */
	public function setHeader( $name, $val ) {
		$this->setHeaders( [ $name => $val ] );
	}

	/**
	 * @since 1.26
	 * @param array $headers
	 */
	public function setHeaders( $headers ) {
		foreach ( $headers as $name => $val ) {
			$name = strtoupper( $name );
			$this->headers[$name] = $val;
		}
	}

	/**
	 * @return array|null
	 */
	public function getSessionArray() {
		if ( $this->sessionId !== null ) {
			return iterator_to_array( $this->getSession() );
		}
		return null;
	}

	/**
	 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
	 * @return string
	 */
	public function getRawQueryString() {
		return '';
	}

	/**
	 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
	 * @return string
	 */
	public function getRawPostString() {
		return '';
	}

	/**
	 * FauxRequests shouldn't depend on raw request data (but that could be implemented here)
	 * @return string
	 */
	public function getRawInput() {
		return '';
	}

	/**
	 * @codeCoverageIgnore
	 * @param array $extWhitelist
	 * @return bool
	 */
	public function checkUrlExtension( $extWhitelist = [] ) {
		return true;
	}

	/**
	 * @codeCoverageIgnore
	 * @return string
	 */
	protected function getRawIP() {
		return '127.0.0.1';
	}
}


1			<?php
2			/**
3			* Deal with importing all those nasty globals and things
4			*
5			* Copyright © 2003 Brion Vibber <[email protected]>
6			* https://www.mediawiki.org/
7			*
8			* This program is free software; you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation; either version 2 of the License, or
11			* (at your option) any later version.
12			*
13			* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17			*
18			* You should have received a copy of the GNU General Public License along
19			* with this program; if not, write to the Free Software Foundation, Inc.,
20			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21			* http://www.gnu.org/copyleft/gpl.html
22			*
23			* @file
24			*/
25
26			use MediaWiki\Session\SessionManager;
27
28			/**
29			* WebRequest clone which takes values from a provided array.
30			*
31			* @ingroup HTTP
32			*/
33			class FauxRequest extends WebRequest {
34			private $wasPosted = false;
35			private $requestUrl;
36			protected $cookies = [];
37
38			/**
39			* @param array $data Array of non-urlencoded key => value pairs, the
40			* fake GET/POST values
41			* @param bool $wasPosted Whether to treat the data as POST
42			* @param MediaWiki\Session\Session\|array\|null $session Session, session
43			* data array, or null
44			* @param string $protocol 'http' or 'https'
45			* @throws MWException
46			*/
47			public function __construct( $data = [], $wasPosted = false,
48			$session = null, $protocol = 'http'
49			) {
50			$this->requestTime = microtime( true );
51
52			if ( is_array( $data ) ) {
53			$this->data = $data;
54			} else {
55			throw new MWException( "FauxRequest() got bogus data" );
56			}
57			$this->wasPosted = $wasPosted;
58			if ( $session instanceof MediaWiki\Session\Session ) {
59			$this->sessionId = $session->getSessionId();
60			} elseif ( is_array( $session ) ) {
61			$mwsession = SessionManager::singleton()->getEmptySession( $this );
62			$this->sessionId = $mwsession->getSessionId();
63			foreach ( $session as $key => $value ) {
64			$mwsession->set( $key, $value );
65			}
66			} elseif ( $session !== null ) {
67			throw new MWException( "FauxRequest() got bogus session" );
68			}
69			$this->protocol = $protocol;
70			}
71
72			/**
73			* Initialise the header list
74			*/
75			protected function initHeaders() {
76			// Nothing to init
77			}
78
79			/**
80			* @param string $name
81			* @param string $default
82			* @return string
83			*/
84			public function getText( $name, $default = '' ) {
85			# Override; don't recode since we're using internal data
86			return (string)$this->getVal( $name, $default );
87			}
88
89			/**
90			* @return array
91			*/
92			public function getValues() {
93			return $this->data;
94			}
95
96			/**
97			* @return array
98			*/
99			public function getQueryValues() {
100			if ( $this->wasPosted ) {
101			return [];
102			} else {
103			return $this->data;
104			}
105			}
106
107			public function getMethod() {
108			return $this->wasPosted ? 'POST' : 'GET';
109			}
110
111			/**
112			* @return bool
113			*/
114			public function wasPosted() {
115			return $this->wasPosted;
116			}
117
118			public function getCookie( $key, $prefix = null, $default = null ) {
119			if ( $prefix === null ) {
120			global $wgCookiePrefix;
121			$prefix = $wgCookiePrefix;
122			}
123			$name = $prefix . $key;
124			return isset( $this->cookies[$name] ) ? $this->cookies[$name] : $default;
125			}
126
127			/**
128			* @since 1.26
129			* @param string $name Unprefixed name of the cookie to set
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report There is no parameter named `$name`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
130			* @param string\|null $value Value of the cookie to set
131			* @param string\|null $prefix Cookie prefix. Defaults to $wgCookiePrefix
132			*/
133			public function setCookie( $key, $value, $prefix = null ) {
134			$this->setCookies( [ $key => $value ], $prefix );
135			}
136
137			/**
138			* @since 1.26
139			* @param array $cookies
140			* @param string\|null $prefix Cookie prefix. Defaults to $wgCookiePrefix
141			*/
142			public function setCookies( $cookies, $prefix = null ) {
143			if ( $prefix === null ) {
144			global $wgCookiePrefix;
145			$prefix = $wgCookiePrefix;
146			}
147			foreach ( $cookies as $key => $value ) {
148			$name = $prefix . $key;
149			$this->cookies[$name] = $value;
150			}
151			}
152
153			/**
154			* @since 1.25
155			*/
156			public function setRequestURL( $url ) {
157			$this->requestUrl = $url;
158			}
159
160			/**
161			* @since 1.25 MWException( "getRequestURL not implemented" )
162			* no longer thrown.
163			*/
164			public function getRequestURL() {
165			if ( $this->requestUrl === null ) {
166			throw new MWException( 'Request URL not set' );
167			}
168			return $this->requestUrl;
169			}
170
171			public function getProtocol() {
172			return $this->protocol;
173			}
174
175			/**
176			* @param string $name
177			* @param string $val
178			*/
179			public function setHeader( $name, $val ) {
180			$this->setHeaders( [ $name => $val ] );
181			}
182
183			/**
184			* @since 1.26
185			* @param array $headers
186			*/
187			public function setHeaders( $headers ) {
188			foreach ( $headers as $name => $val ) {
189			$name = strtoupper( $name );
190			$this->headers[$name] = $val;
191			}
192			}
193
194			/**
195			* @return array\|null
196			*/
197			public function getSessionArray() {
198			if ( $this->sessionId !== null ) {
199			return iterator_to_array( $this->getSession() );
200			}
201			return null;
202			}
203
204			/**
205			* FauxRequests shouldn't depend on raw request data (but that could be implemented here)
206			* @return string
207			*/
208			public function getRawQueryString() {
209			return '';
210			}
211
212			/**
213			* FauxRequests shouldn't depend on raw request data (but that could be implemented here)
214			* @return string
215			*/
216			public function getRawPostString() {
217			return '';
218			}
219
220			/**
221			* FauxRequests shouldn't depend on raw request data (but that could be implemented here)
222			* @return string
223			*/
224			public function getRawInput() {
225			return '';
226			}
227
228			/**
229			* @codeCoverageIgnore
230			* @param array $extWhitelist
231			* @return bool
232			*/
233			public function checkUrlExtension( $extWhitelist = [] ) {
234			return true;
235			}
236
237			/**
238			* @codeCoverageIgnore
239			* @return string
240			*/
241			protected function getRawIP() {
242			return '127.0.0.1';
243			}
244			}
245

wikimedia / mediawiki

FauxRequest::getValues() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FauxRequest::getValues() A
last analyzed 2016-11-13 17:42 UTC