Page MenuHomeWickedGov Phorge
Files F4123058

FauxResponse.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

FauxResponse.php
View Options

<?php
/**
* Classes used to send headers and cookies back to the user
*
* 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\Config\Config;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
/**
* @ingroup HTTP
*/
class FauxResponse extends WebResponse {
/** @var null|string[] */
private $headers;
/** @var array[] */
private $cookies = [];
/** @var int|null */
private $code;
/** @var ?Config */
private $cookieConfig = null;
/**
* Stores a HTTP header
* @param string $string Header to output
* @param bool $replace Replace current similar header
* @param null|int $http_response_code Forces the HTTP response code to the specified value.
*/
public function header( $string, $replace = true, $http_response_code = null ) {
if ( $this->disableForPostSend ) {
return;
}
if ( str_starts_with( $string, 'HTTP/' ) ) {
$parts = explode( ' ', $string, 3 );
$this->code = intval( $parts[1] );
} else {
[ $key, $val ] = array_map( 'trim', explode( ":", $string, 2 ) );
$key = strtoupper( $key );
if ( $replace || !isset( $this->headers[$key] ) ) {
$this->headers[$key] = $val;
}
}
if ( $http_response_code ) {
$this->code = intval( $http_response_code );
}
}
/**
* @since 1.26
* @param int $code Status code
*/
public function statusHeader( $code ) {
$this->code = intval( $code );
}
public function headersSent() {
return false;
}
/**
* @param string $key The name of the header to get (case insensitive).
* @return string|null The header value (if set); null otherwise.
*/
public function getHeader( $key ) {
$key = strtoupper( $key );
return $this->headers[$key] ?? null;
}
/**
* Get the HTTP response code, null if not set
*
* @return int|null
*/
public function getStatusCode() {
return $this->code;
}
/**
* @return Config
*/
private function getCookieConfig(): Config {
if ( !$this->cookieConfig ) {
$this->cookieConfig = MediaWikiServices::getInstance()->getMainConfig();
}
return $this->cookieConfig;
}
/**
* @param Config $cookieConfig
*/
public function setCookieConfig( Config $cookieConfig ): void {
$this->cookieConfig = $cookieConfig;
}
/**
* @param string $name The name of the cookie.
* @param string $value The value to be stored in the cookie.
* @param int|null $expire Ignored in this faux subclass.
* @param array $options Ignored in this faux subclass.
*/
public function setCookie( $name, $value, $expire = 0, $options = [] ) {
if ( $this->disableForPostSend ) {
return;
}
$cookieConfig = $this->getCookieConfig();
$cookiePath = $cookieConfig->get( MainConfigNames::CookiePath );
$cookiePrefix = $cookieConfig->get( MainConfigNames::CookiePrefix );
$cookieDomain = $cookieConfig->get( MainConfigNames::CookieDomain );
$cookieSecure = $cookieConfig->get( MainConfigNames::CookieSecure );
$cookieExpiration = $cookieConfig->get( MainConfigNames::CookieExpiration );
$cookieHttpOnly = $cookieConfig->get( MainConfigNames::CookieHttpOnly );
$options = array_filter( $options, static function ( $a ) {
return $a !== null;
} ) + [
'prefix' => $cookiePrefix,
'domain' => $cookieDomain,
'path' => $cookiePath,
'secure' => $cookieSecure,
'httpOnly' => $cookieHttpOnly,
'raw' => false,
];
if ( $expire === null ) {
$expire = 0; // Session cookie
} elseif ( $expire == 0 && $cookieExpiration != 0 ) {
$expire = time() + $cookieExpiration;
}
$this->cookies[$options['prefix'] . $name] = [
'value' => (string)$value,
'expire' => (int)$expire,
'path' => (string)$options['path'],
'domain' => (string)$options['domain'],
'secure' => (bool)$options['secure'],
'httpOnly' => (bool)$options['httpOnly'],
'raw' => (bool)$options['raw'],
];
}
/**
* @param string $name
* @return string|null
*/
public function getCookie( $name ) {
if ( isset( $this->cookies[$name] ) ) {
return $this->cookies[$name]['value'];
}
return null;
}
/**
* @param string $name
* @return array|null
*/
public function getCookieData( $name ) {
return $this->cookies[$name] ?? null;
}
/**
* @return array[]
*/
public function getCookies() {
return $this->cookies;
}
/**
* @inheritDoc
*/
public function hasCookies() {
return count( $this->cookies ) > 0;
}
}
/** @deprecated class alias since 1.40 */
class_alias( FauxResponse::class, 'FauxResponse' );

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 05:54 (10 h, 31 m ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
c6/a6/62ff3c8e88b3d4d739446c7eebd9
Default Alt Text
FauxResponse.php (5 KB)

Event Timeline