wiki.techinc.nl/includes/Rest/Response.php
daniel 91a1741787 Introduce Modules into the REST framework
Modules group together endpoints by a shared prefix. The idea is that each module has its own version and can generated self-contained self-documentation. This allows clients to have clear expectations about the endpoints of each module, no matter what wiki they are accessing. So far, each wiki may be exposing a different set of endpoints, with no way to provide a spec that describes that set of endpoints in a way that would be consistent across wikis and stable over time.

Bug: T362480
Change-Id: Iebcde4645d472d27eee5a30adb6eee12cc7d046b
2024-05-08 16:12:30 +02:00

126 lines
2.6 KiB
PHP

<?php
namespace MediaWiki\Rest;
use HttpStatus;
use Psr\Http\Message\StreamInterface;
class Response implements ResponseInterface {
private int $statusCode = 200;
private string $reasonPhrase = 'OK';
private string $protocolVersion = '1.1';
private StreamInterface $body;
private HeaderContainer $headerContainer;
private array $cookies = [];
/**
* @param string|StreamInterface $body
*
* @internal Use ResponseFactory
*/
public function __construct( $body = '' ) {
if ( is_string( $body ) ) {
$body = new StringStream( $body );
}
$this->body = $body;
$this->headerContainer = new HeaderContainer;
}
/**
* @internal for backwards compatibility code
*/
public static function cast( ResponseInterface $iResponse ): Response {
if ( $iResponse instanceof Response ) {
return $iResponse;
}
$resp = new Response(
$iResponse->getBody()
);
foreach ( $iResponse->getHeaders() as $name => $values ) {
$resp->setHeader( $name, $values );
}
return $resp;
}
public function getStatusCode() {
return $this->statusCode;
}
public function getReasonPhrase() {
return $this->reasonPhrase;
}
public function setStatus( $code, $reasonPhrase = '' ) {
$this->statusCode = $code;
if ( $reasonPhrase === '' ) {
$reasonPhrase = HttpStatus::getMessage( $code ) ?? '';
}
$this->reasonPhrase = $reasonPhrase;
}
public function getProtocolVersion() {
return $this->protocolVersion;
}
public function getHeaders() {
return $this->headerContainer->getHeaders();
}
public function hasHeader( $name ) {
return $this->headerContainer->hasHeader( $name );
}
public function getHeader( $name ) {
return $this->headerContainer->getHeader( $name );
}
public function getHeaderLine( $name ) {
return $this->headerContainer->getHeaderLine( $name );
}
public function getBody() {
return $this->body;
}
public function setProtocolVersion( $version ) {
$this->protocolVersion = $version;
}
public function setHeader( $name, $value ) {
$this->headerContainer->setHeader( $name, $value );
}
public function addHeader( $name, $value ) {
$this->headerContainer->addHeader( $name, $value );
}
public function removeHeader( $name ) {
$this->headerContainer->removeHeader( $name );
}
public function setBody( StreamInterface $body ) {
$this->body = $body;
}
public function getRawHeaderLines() {
return $this->headerContainer->getRawHeaderLines();
}
public function setCookie( $name, $value, $expire = 0, $options = [] ) {
$this->cookies[] = [
'name' => $name,
'value' => $value,
'expire' => $expire,
'options' => $options
];
}
public function getCookies() {
return $this->cookies;
}
}