6eec17e9a9
Add doc-typehints to class properties found by the PropertyDocumentation sniff to improve the documentation. Once the sniff is enabled it avoids that new code is missing type declarations. This is focused on documentation and does not change code. Change-Id: I1da4b272a6b28c419cc8e860d142dae19ca0bbcf
109 lines
2.9 KiB
PHP
109 lines
2.9 KiB
PHP
<?php
|
|
/**
|
|
* Deal with importing all those nasty globals and things
|
|
*
|
|
* Copyright © 2003 Brooke Vibber <bvibber@wikimedia.org>
|
|
* 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
|
|
*/
|
|
|
|
namespace MediaWiki\Request;
|
|
|
|
use MediaWiki\Session\Session;
|
|
|
|
/**
|
|
* Similar to MediaWiki\Request\FauxRequest, but only fakes URL parameters and method
|
|
* (POST or GET) and use the base request for the remaining stuff
|
|
* (cookies, session and headers).
|
|
*
|
|
* @newable
|
|
*
|
|
* @ingroup HTTP
|
|
* @since 1.19
|
|
*/
|
|
class DerivativeRequest extends FauxRequest {
|
|
private WebRequest $base;
|
|
/** @var string|null */
|
|
private $ip;
|
|
|
|
/**
|
|
* @stable to call
|
|
*
|
|
* @param WebRequest $base
|
|
* @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
|
|
*/
|
|
public function __construct( WebRequest $base, $data, $wasPosted = false ) {
|
|
$this->base = $base;
|
|
parent::__construct( $data, $wasPosted );
|
|
}
|
|
|
|
public function getCookie( $key, $prefix = null, $default = null ) {
|
|
return $this->base->getCookie( $key, $prefix, $default );
|
|
}
|
|
|
|
public function getHeader( $name, $flags = 0 ) {
|
|
return $this->base->getHeader( $name, $flags );
|
|
}
|
|
|
|
public function getAllHeaders() {
|
|
return $this->base->getAllHeaders();
|
|
}
|
|
|
|
public function getSession(): Session {
|
|
return $this->base->getSession();
|
|
}
|
|
|
|
public function getSessionData( $key ) {
|
|
return $this->base->getSessionData( $key );
|
|
}
|
|
|
|
public function setSessionData( $key, $data ) {
|
|
$this->base->setSessionData( $key, $data );
|
|
}
|
|
|
|
public function getAcceptLang() {
|
|
return $this->base->getAcceptLang();
|
|
}
|
|
|
|
public function getIP(): string {
|
|
return $this->ip ?: $this->base->getIP();
|
|
}
|
|
|
|
public function setIP( $ip ) {
|
|
$this->ip = $ip;
|
|
}
|
|
|
|
public function getProtocol() {
|
|
return $this->base->getProtocol();
|
|
}
|
|
|
|
public function getUpload( $key ) {
|
|
// @phan-suppress-next-line PhanTypeMismatchReturnSuperType
|
|
return $this->base->getUpload( $key );
|
|
}
|
|
|
|
public function getElapsedTime() {
|
|
return $this->base->getElapsedTime();
|
|
}
|
|
}
|
|
|
|
/** @deprecated class alias since 1.40 */
|
|
class_alias( DerivativeRequest::class, 'DerivativeRequest' );
|