Zend_Controller_Response_Abstract
Zend_Controller_Response_Abstract
Base class for Zend_Controller responses
Located in /Controller/Response/Abstract.php (line 32)
| Class | Description |
|---|---|
Zend_Controller_Response_Http
|
Zend_Controller_Response_Http |
|
Zend_Controller_Response_Cli
|
Zend_Controller_Response_Cli |
Zend_Controller_Response_Abstract
insert
(string $name, string $content, [string $parent = null], [boolean $before = false])
Zend_Controller_Response_Abstract
setHeader
(string $name, string $value, [boolean $replace = false])
boolean
$headersSentThrowsException
= true (line 84)
Flag; if true, when header operations are called after headers have been sent, an exception will be raised; otherwise, processing will continue as normal. Defaults to true.
- Zend_Controller_Response_Cli::$headersSentThrowsException : Flag; if true, when header operations are called after headers have been sent, an exception will be raised; otherwise, processing will continue as normal. Defaults to false.
array
$_body
= array() (line 38)
Body content
Exception
$_exceptions
= array() (line 44)
Exception stack
array
$_headers
= array() (line 50)
Array of headers. Each header is an array with keys 'name' and 'value'
array
$_headersRaw
= array() (line 56)
Array of raw headers. Each header is a single string, the entire header to emit
int
$_httpResponseCode
= 200 (line 62)
HTTP response code to use in headers
boolean
$_isRedirect
= false (line 68)
Flag; is this response a redirect?
boolean
$_renderExceptions
= false (line 74)
Whether or not to render exceptions; off by default
append (line 483)
Append a named body segment to the body content array
If segment already exists, replaces with $content and places at end of array.
- string $name
- string $content
appendBody (line 404)
Append content to the body content
- string $content
- null|string $name
canSendHeaders (line 316)
Can we send headers?
- boolean $throw: Whether or not to throw an exception if headers have been sent; defaults to false
- Zend_Controller_Response_HttpTestCase::canSendHeaders() : Can we send headers?
clearAllHeaders (line 270)
Clear all headers, normal and raw
clearBody (line 431)
Clear body array
With no arguments, clears the entire body array. Given a $name, clears just that named segment; if no segment matching $name exists, returns false to indicate an error.
- string $name: Named segment to clear
clearHeader (line 193)
Clears the specified HTTP header
- string $name
clearRawHeader (line 253)
Clears the specified raw HTTP header
- string $headerRaw
clearRawHeaders (line 241)
Clear all setRawHeader()
getBody (line 458)
Return the body content
If $spec is false, returns the concatenated values of the body content array. If $spec is boolean true, returns the body content array. If $spec is a string and matches a named segment, returns the contents of that segment; otherwise, returns null.
- boolean $spec
- Zend_Controller_Response_HttpTestCase::getBody() : Get body and/or body segments
getException (line 606)
Retrieve the exception stack
getExceptionByCode (line 723)
Retrieve all exceptions of a given code
- mixed $code
getExceptionByMessage (line 701)
Retrieve all exceptions of a given message
- string $message
getExceptionByType (line 679)
Retrieve all exceptions of a given type
- string $type
getHeaders (line 170)
Return array of headers; see $_headers for format
getHttpResponseCode (line 304)
Retrieve HTTP response code
getRawHeaders (line 231)
Retrieve all setRawHeader()
hasExceptionOfCode (line 661)
Does the response object contain an exception with a given code?
- int $code
hasExceptionOfMessage (line 644)
Does the response object contain an exception with a given message?
- string $message
hasExceptionOfType (line 627)
Does the response object contain an exception of a given type?
- string $type
insert (line 534)
Insert a named segment into the body content array
- string $name
- string $content
- string $parent
- boolean $before: Whether to insert the new segment before or after the parent. Defaults to false (after)
isException (line 616)
Has an exception been registered with the response?
isRedirect (line 160)
Is this a redirect?
outputBody (line 583)
Echo the body segments
- Zend_Controller_Response_HttpTestCase::outputBody() : Return the concatenated body segments
prepend (line 507)
Prepend a named body segment to the body content array
If segment already exists, replaces with $content and places at top of array.
- string $name
- string $content
renderExceptions (line 749)
Whether or not to render exceptions (off by default)
If called with no arguments or a null argument, returns the value of the flag; otherwise, sets it and returns the current value.
- boolean $flag: Optional
sendHeaders (line 335)
Send all headers
Sends any headers specified. If an HTTP response code has been specified, it is sent with the first header.
- Zend_Controller_Response_HttpTestCase::sendHeaders() : "send" headers by returning array of all headers that would be sent
sendResponse (line 764)
Send the response, including all headers, rendering exceptions if so requested.
- Zend_Controller_Response_HttpTestCase::sendResponse() : "send" Response
setBody (line 386)
Set body content
If $name is not passed, or is not a string, resets the entire body and sets the 'default' key to $content.
If $name is a string, sets the named segment in the body array to $content.
- string $content
- null|string $name
setException (line 595)
Register an exception with the response
- Exception $e
setHeader (line 113)
Set a header
If $replace is true, replaces any headers already defined with that $name.
- string $name
- string $value
- boolean $replace
setHttpResponseCode (line 282)
Set HTTP response code to use with headers
- int $code
setRawHeader (line 216)
Set raw HTTP header
Allows setting non key => value headers, such as status codes
- string $value
setRedirect (line 146)
Set redirect URL
Sets Location header and response code. Forces replacement of any prior redirects.
- string $url
- int $code
_normalizeHeader (line 94)
Normalize a header name
Normalizes a header name to X-Capitalized-Names
- string $name
__toString (line 788)
Magic __toString functionality
Proxies to sendResponse() and returns response value as string using output buffering.
- Zend_Controller_Response_Cli::__toString() : Magic __toString functionality
Documentation generated on Mon, 21 Jun 2010 15:05:31 -0400 by phpDocumentor 1.4.3