FauxResponse.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Request;
 
use MediaWiki\Config\Config;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
 
class FauxResponse extends WebResponse {
    private $headers;
    private $cookies = [];
    private $code;
 
    private $cookieConfig = null;
 
    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 );
        }
    }
 
    public function statusHeader( $code ) {
        $this->code = intval( $code );
    }
 
    public function headersSent() {
        return false;
    }
 
    public function getHeader( $key ) {
        $key = strtoupper( $key );
 
        return $this->headers[$key] ?? null;
    }
 
    public function getStatusCode() {
        return $this->code;
    }
 
    private function getCookieConfig(): Config {
        if ( !$this->cookieConfig ) {
            $this->cookieConfig = MediaWikiServices::getInstance()->getMainConfig();
        }
        return $this->cookieConfig;
    }
 
    public function setCookieConfig( Config $cookieConfig ): void {
        $this->cookieConfig = $cookieConfig;
    }
 
    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'],
        ];
    }
 
    public function getCookie( $name ) {
        if ( isset( $this->cookies[$name] ) ) {
            return $this->cookies[$name]['value'];
        }
        return null;
    }
 
    public function getCookieData( $name ) {
        return $this->cookies[$name] ?? null;
    }
 
    public function getCookies() {
        return $this->cookies;
    }
 
    public function hasCookies() {
        return count( $this->cookies ) > 0;
    }
 
}
 
class_alias( FauxResponse::class, 'FauxResponse' );