Page MenuHomeWickedGov Phorge
Files F4133870

Response.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

Response.php
View Options

<?php
namespace MediaWiki\Extension\OAuth;
use InvalidArgumentException;
use MediaWiki\Rest\Response as RestResponse;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;
class Response extends RestResponse implements ResponseInterface {
public function __construct( $bodyContents = '' ) {
parent::__construct( $bodyContents );
}
/**
* Return an instance with the specified HTTP protocol version.
*
* The version string MUST contain only the HTTP version number (e.g.,
* "1.1", "1.0").
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new protocol version.
*
* @param string $version HTTP protocol version
* @return static
*/
public function withProtocolVersion( $version ) {
$response = clone $this;
$response->setProtocolVersion( $version );
return $response;
}
/**
* Return an instance with the provided value replacing the specified header.
*
* While header names are case-insensitive, the casing of the header will
* be preserved by this function, and returned from getHeaders().
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new and/or updated header and value.
*
* @param string $name Case-insensitive header field name.
* @param string|string[] $value Header value(s).
* @return static
* @throws InvalidArgumentException for invalid header names or values.
*/
public function withHeader( $name, $value ) {
$response = clone $this;
$response->setHeader( $name, $value );
return $response;
}
/**
* Return an instance with the specified header appended with the given value.
*
* Existing values for the specified header will be maintained. The new
* value(s) will be appended to the existing list. If the header did not
* exist previously, it will be added.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new header and/or value.
*
* @param string $name Case-insensitive header field name to add.
* @param string|string[] $value Header value(s).
* @return static
* @throws InvalidArgumentException for invalid header names or values.
*/
public function withAddedHeader( $name, $value ) {
$response = clone $this;
$response->addHeader( $name, $value );
return $response;
}
/**
* Return an instance without the specified header.
*
* Header resolution MUST be done without case-sensitivity.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that removes
* the named header.
*
* @param string $name Case-insensitive header field name to remove.
* @return static
*/
public function withoutHeader( $name ) {
$response = clone $this;
$response->removeHeader( $name );
return $response;
}
/**
* Return an instance with the specified message body.
*
* The body MUST be a StreamInterface object.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return a new instance that has the
* new body stream.
*
* @param StreamInterface $body
* @return static
* @throws InvalidArgumentException When the body is not valid.
*/
public function withBody( StreamInterface $body ) {
$response = clone $this;
$response->setBody( $body );
return $response;
}
/**
* Return an instance with the specified status code and, optionally, reason phrase.
*
* If no reason phrase is specified, implementations MAY choose to default
* to the RFC 7231 or IANA recommended reason phrase for the response's
* status code.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* updated status and reason phrase.
*
* @link http://tools.ietf.org/html/rfc7231#section-6
* @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
* @param int $code The 3-digit integer result code to set.
* @param string $reasonPhrase The reason phrase to use with the
* provided status code; if none is provided, implementations MAY
* use the defaults as suggested in the HTTP specification.
* @return static
* @throws InvalidArgumentException For invalid status code arguments.
*/
public function withStatus( $code, $reasonPhrase = '' ) {
$response = clone $this;
$response->setStatus( $code, $reasonPhrase );
return $response;
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 12:21 (3 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
11/63/2db124c6a9c1ef51bedb9b5a11a9
Default Alt Text
Response.php (4 KB)

Event Timeline