MediaWiki  master
MediaWiki\Rest\Response Class Reference
Inheritance diagram for MediaWiki\Rest\Response:
Collaboration diagram for MediaWiki\Rest\Response:

Public Member Functions

 __construct ( $bodyContents='')
 
 addHeader ( $name, $value)
 Append the given value to the specified header. More...
 
 getBody ()
 Gets the body of the message. More...
 
 getCookies ()
 Get all previously set cookies as a list of associative arrays with the following keys: More...
 
 getHeader ( $name)
 Retrieves a message header value by the given case-insensitive name. More...
 
 getHeaderLine ( $name)
 Retrieves a comma-separated string of the values for a single header. More...
 
 getHeaders ()
 Retrieves all message header values. More...
 
 getProtocolVersion ()
 Retrieves the HTTP protocol version as a string. More...
 
 getRawHeaderLines ()
 Get the full header lines including colon-separated name and value, for passing directly to header(). More...
 
 getReasonPhrase ()
 Gets the response reason phrase associated with the status code. More...
 
 getStatusCode ()
 Gets the response status code. More...
 
 hasHeader ( $name)
 Checks if a header exists by the given case-insensitive name. More...
 
 removeHeader ( $name)
 Remove the specified header. More...
 
 setBody (StreamInterface $body)
 Set the message body. More...
 
 setCookie ( $name, $value, $expire=0, $options=[])
 Set a cookie. More...
 
 setHeader ( $name, $value)
 Set or replace the specified header. More...
 
 setProtocolVersion ( $version)
 Set the HTTP protocol version. More...
 
 setStatus ( $code, $reasonPhrase='')
 Set the status code and, optionally, reason phrase. More...
 

Private Attributes

StreamInterface $body
 
array $cookies = []
 
HeaderContainer $headerContainer
 
string $protocolVersion = '1.1'
 
string $reasonPhrase = 'OK'
 
int $statusCode = 200
 

Detailed Description

Definition at line 8 of file Response.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Response::__construct (   $bodyContents = '')

Definition at line 31 of file Response.php.

Member Function Documentation

◆ addHeader()

MediaWiki\Rest\Response::addHeader (   $name,
  $value 
)

Append the given value to the specified header.

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.

Parameters
string$nameCase-insensitive header field name to add.
string|string[]$value Header value(s).
Exceptions

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 84 of file Response.php.

◆ getBody()

MediaWiki\Rest\Response::getBody ( )

Gets the body of the message.

Returns
StreamInterface Returns the body as a stream.

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 72 of file Response.php.

References MediaWiki\Rest\Response\$body.

◆ getCookies()

MediaWiki\Rest\Response::getCookies ( )

Get all previously set cookies as a list of associative arrays with the following keys:

  • name: The cookie name
  • value: The cookie value
  • expire: The requested expiry time
  • options: An associative array of further options
Returns
array -return array{name:string,value:mixed,expire:int,options:array}

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 109 of file Response.php.

References MediaWiki\Rest\Response\$cookies.

◆ getHeader()

MediaWiki\Rest\Response::getHeader (   $name)

Retrieves a message header value by the given case-insensitive name.

This method returns an array of all the header values of the given case-insensitive header name.

If the header does not appear in the message, this method MUST return an empty array.

Parameters
string$nameCase-insensitive header field name.
Returns
string[] An array of string values as provided for the given header. If the header does not appear in the message, this method MUST return an empty array.

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 64 of file Response.php.

◆ getHeaderLine()

MediaWiki\Rest\Response::getHeaderLine (   $name)

Retrieves a comma-separated string of the values for a single header.

This method returns all of the header values of the given case-insensitive header name as a string concatenated together using a comma.

NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating.

If the header does not appear in the message, this method MUST return an empty string.

Parameters
string$nameCase-insensitive header field name.
Returns
string A string of values as provided for the given header concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 68 of file Response.php.

◆ getHeaders()

MediaWiki\Rest\Response::getHeaders ( )

Retrieves all message header values.

The keys represent the header name as it will be sent over the wire, and each value is an array of strings associated with the header.

// Represent the headers as a string
foreach ($message->getHeaders() as $name => $values) {
    echo $name . ': ' . implode(', ', $values);
}

// Emit headers iteratively:
foreach ($message->getHeaders() as $name => $values) {
    foreach ($values as $value) {
        header(sprintf('%s: %s', $name, $value), false);
    }
}

While header names are not case-sensitive, getHeaders() will preserve the exact case in which headers were originally specified.

Returns
string[][] Returns an associative array of the message's headers. Each key MUST be a header name, and each value MUST be an array of strings for that header.

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 56 of file Response.php.

◆ getProtocolVersion()

MediaWiki\Rest\Response::getProtocolVersion ( )

Retrieves the HTTP protocol version as a string.

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

Returns
string HTTP protocol version.

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 52 of file Response.php.

References MediaWiki\Rest\Response\$protocolVersion.

◆ getRawHeaderLines()

MediaWiki\Rest\Response::getRawHeaderLines ( )

Get the full header lines including colon-separated name and value, for passing directly to header().

Not including the status line.

Returns
string[]

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 96 of file Response.php.

◆ getReasonPhrase()

MediaWiki\Rest\Response::getReasonPhrase ( )

Gets the response reason phrase associated with the status code.

Because a reason phrase is not a required element in a response status line, the reason phrase value MAY be empty. Implementations MAY choose to return the default RFC 7231 recommended reason phrase (or those listed in the IANA HTTP Status Code Registry) for the response's status code.

See also
http://tools.ietf.org/html/rfc7231#section-6
http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
Returns
string Reason phrase; must return an empty string if none present.

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 40 of file Response.php.

References MediaWiki\Rest\Response\$reasonPhrase.

◆ getStatusCode()

MediaWiki\Rest\Response::getStatusCode ( )

Gets the response status code.

The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.

Returns
int Status code.

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 36 of file Response.php.

References MediaWiki\Rest\Response\$statusCode.

◆ hasHeader()

MediaWiki\Rest\Response::hasHeader (   $name)

Checks if a header exists by the given case-insensitive name.

Parameters
string$nameCase-insensitive header field name.
Returns
bool Returns true if any header names match the given header name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 60 of file Response.php.

◆ removeHeader()

MediaWiki\Rest\Response::removeHeader (   $name)

Remove the specified header.

Header resolution MUST be done without case-sensitivity.

Parameters
string$nameCase-insensitive header field name to remove.

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 88 of file Response.php.

◆ setBody()

MediaWiki\Rest\Response::setBody ( StreamInterface  $body)

Set the message body.

The body MUST be a StreamInterface object.

Parameters
StreamInterface$bodyBody.
Exceptions

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 92 of file Response.php.

References MediaWiki\Rest\Response\$body.

◆ setCookie()

MediaWiki\Rest\Response::setCookie (   $name,
  $value,
  $expire = 0,
  $options = [] 
)

Set a cookie.

The name will have the cookie prefix added to it before it is sent over the network.

Parameters
string$nameThe name of the cookie, not including prefix.
string$valueThe value to be stored in the cookie.
int | null$expireUnix timestamp (in seconds) when the cookie should expire. 0 (the default) causes it to expire $wgCookieExpiration seconds from now. null causes it to be a session cookie.
array$optionsAssoc of additional cookie options: prefix: string, name prefix ($wgCookiePrefix) domain: string, cookie domain ($wgCookieDomain) path: string, cookie path ($wgCookiePath) secure: bool, secure attribute ($wgCookieSecure) httpOnly: bool, httpOnly attribute ($wgCookieHttpOnly)

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 100 of file Response.php.

◆ setHeader()

MediaWiki\Rest\Response::setHeader (   $name,
  $value 
)

Set or replace the specified header.

While header names are case-insensitive, the casing of the header will be preserved by this function, and returned from getHeaders().

Parameters
string$nameCase-insensitive header field name.
string|string[]$value Header value(s).
Exceptions

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 80 of file Response.php.

◆ setProtocolVersion()

MediaWiki\Rest\Response::setProtocolVersion (   $version)

Set the HTTP protocol version.

The version string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

Parameters
string$versionHTTP protocol version

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 76 of file Response.php.

◆ setStatus()

MediaWiki\Rest\Response::setStatus (   $code,
  $reasonPhrase = '' 
)

Set the 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.

See also
http://tools.ietf.org/html/rfc7231#section-6
http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
Parameters
int$codeThe 3-digit integer result code to set.
string$reasonPhraseThe reason phrase to use with the provided status code; if none is provided, implementations MAY use the defaults as suggested in the HTTP specification.
Exceptions

Implements MediaWiki\Rest\ResponseInterface.

Definition at line 44 of file Response.php.

References MediaWiki\Rest\Response\$reasonPhrase, and HttpStatus\getMessage().

Member Data Documentation

◆ $body

StreamInterface MediaWiki\Rest\Response::$body
private

◆ $cookies

array MediaWiki\Rest\Response::$cookies = []
private

Definition at line 25 of file Response.php.

Referenced by MediaWiki\Rest\Response\getCookies().

◆ $headerContainer

HeaderContainer MediaWiki\Rest\Response::$headerContainer
private

Definition at line 22 of file Response.php.

◆ $protocolVersion

string MediaWiki\Rest\Response::$protocolVersion = '1.1'
private

Definition at line 16 of file Response.php.

Referenced by MediaWiki\Rest\Response\getProtocolVersion().

◆ $reasonPhrase

string MediaWiki\Rest\Response::$reasonPhrase = 'OK'
private

◆ $statusCode

int MediaWiki\Rest\Response::$statusCode = 200
private

Definition at line 10 of file Response.php.

Referenced by MediaWiki\Rest\Response\getStatusCode().


The documentation for this class was generated from the following file: