RestfulService_Response
class RestfulService_Response extends SS_HTTPResponse (View source)
Methods
Create a new HTTP response
The text to be given alongside the status code ("reason phrase").
Add a HTTP header to the response, replacing any header of the same name.
Return the HTTP header of the given name.
Remove an existing HTTP header by its name, e.g. "Content-Type".
Returns true if this response is "finished", that is, no more script execution should be done.
No description
get the cached response object. This allows you to access the cached eaders, not just the cached body.
No description
No description
Return an array of xpath matches
Return the first xpath match
Details
__construct(string $body, int $statusCode = 200, $headers = null)
Create a new HTTP response
$this
setStatusCode(int $code, string $description = null)
$this
setStatusDescription(string $description)
The text to be given alongside the status code ("reason phrase").
Caution: Will be overwritten by {@link setStatusCode()}.
int
getStatusCode()
string
getStatusDescription()
bool
isError()
Returns true if this HTTP response is in error
$this
setBody(string $body)
null|string
getBody()
$this
addHeader(string $header, string $value)
Add a HTTP header to the response, replacing any header of the same name.
getHeader(string $header, $anyCase = false)
Return the HTTP header of the given name.
array
getHeaders()
$this
removeHeader(string $header)
Remove an existing HTTP header by its name, e.g. "Content-Type".
$this
redirect(string $dest, int $code = 302)
output()
Send this HTTPReponse to the browser
bool
isFinished()
Returns true if this response is "finished", that is, no more script execution should be done.
Specifically, returns true if a redirect has already been requested
simpleXML()
RestfulService_Response|false
getCachedResponse()
get the cached response object. This allows you to access the cached eaders, not just the cached body.
string|false
getCachedBody()
setCachedBody($content)
deprecated
deprecated
setCachedResponse($response)
xpath($xpath)
Return an array of xpath matches
xpath_one($xpath)
Return the first xpath match