Controller/Response/Abstract.php
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
- Version
- $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Response_Abstract
Zend_Controller_Response_Abstract
Base class for Zend_Controller responses
- Children
- \Zend_Controller_Response_Http
- \Zend_Controller_Response_Cli
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_body = array()Body content
array()Details- Type
- array
array $_headers = array()Array of headers.
Each header is an array with keys 'name' and 'value'
array()Details- Type
- array
array $_headersRaw = array()Array of raw headers.
Each header is a single string, the entire header to emit
array()Details- Type
- array
int $_httpResponseCode = 200HTTP response code to use in headers
200Details- Type
- int
boolean $_isRedirect = falseFlag; is this response a redirect?
falseDetails- Type
- boolean
boolean $_renderExceptions = falseWhether or not to render exceptions; off by default
falseDetails- Type
- boolean
boolean $headersSentThrowsException = trueFlag; 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.
trueDetails- Type
- boolean
- See
- \global\canSendHeaders()
Methods
__toString() : stringMagic __toString functionality
Proxies to sendResponse() and returns response value as string using output buffering.
| Type | Description |
|---|---|
| string |
_normalizeHeader(string $name) : stringNormalize a header name
Normalizes a header name to X-Capitalized-Names
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| string |
append(string $name, string $content) : \Zend_Controller_Response_AbstractAppend a named body segment to the body content array
If segment already exists, replaces with $content and places at end of array.
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $content | string |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
appendBody(string $content, null | string $name = null) : \Zend_Controller_Response_AbstractAppend content to the body content
| Name | Type | Description |
|---|---|---|
| $content | string | |
| $name | null | string |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
canSendHeaders(boolean $throw = false) : booleanCan we send headers?
| Name | Type | Description |
|---|---|---|
| $throw | boolean | Whether or not to throw an exception if headers have been sent; defaults to false |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Controller_Response_Exception |
clearAllHeaders() : \Zend_Controller_Response_AbstractClear all headers, normal and raw
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
clearBody(string $name = null) : booleanClear 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.
| Name | Type | Description |
|---|---|---|
| $name | string | Named segment to clear |
| Type | Description |
|---|---|
| boolean |
clearHeader(string $name) : \Zend_Controller_Response_AbstractClears the specified HTTP header
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
clearHeaders() : \Zend_Controller_Response_AbstractClear headers
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
clearRawHeader(string $headerRaw) : \Zend_Controller_Response_AbstractClears the specified raw HTTP header
| Name | Type | Description |
|---|---|---|
| $headerRaw | string |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
clearRawHeaders() : \Zend_Controller_Response_AbstractClear all {@link setRawHeader() raw HTTP headers}
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
getBody(boolean $spec = false) : string | array | nullReturn 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.
| Name | Type | Description |
|---|---|---|
| $spec | boolean |
| Type | Description |
|---|---|
| string | array | null |
getException() : arrayRetrieve the exception stack
| Type | Description |
|---|---|
| array |
getExceptionByCode(mixed $code) : voidRetrieve all exceptions of a given code
| Name | Type | Description |
|---|---|---|
| $code | mixed |
getExceptionByMessage(string $message) : false | arrayRetrieve all exceptions of a given message
| Name | Type | Description |
|---|---|---|
| $message | string |
| Type | Description |
|---|---|
| false | array |
getExceptionByType(string $type) : false | arrayRetrieve all exceptions of a given type
| Name | Type | Description |
|---|---|---|
| $type | string |
| Type | Description |
|---|---|
| false | array |
getHeaders() : arrayReturn array of headers; see {@link $_headers} for format
| Type | Description |
|---|---|
| array |
getHttpResponseCode() : intRetrieve HTTP response code
| Type | Description |
|---|---|
| int |
getRawHeaders() : arrayRetrieve all {@link setRawHeader() raw HTTP headers}
| Type | Description |
|---|---|
| array |
hasExceptionOfCode(int $code) : booleanDoes the response object contain an exception with a given code?
| Name | Type | Description |
|---|---|---|
| $code | int |
| Type | Description |
|---|---|
| boolean |
hasExceptionOfMessage(string $message) : booleanDoes the response object contain an exception with a given message?
| Name | Type | Description |
|---|---|---|
| $message | string |
| Type | Description |
|---|---|
| boolean |
hasExceptionOfType(string $type) : booleanDoes the response object contain an exception of a given type?
| Name | Type | Description |
|---|---|---|
| $type | string |
| Type | Description |
|---|---|
| boolean |
insert(string $name, string $content, string $parent = null, boolean $before = false) : \Zend_Controller_Response_AbstractInsert a named segment into the body content array
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $content | string | |
| $parent | string | |
| $before | boolean | Whether to insert the new segment before or after the parent. Defaults to false (after) |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
isException() : booleanHas an exception been registered with the response?
| Type | Description |
|---|---|
| boolean |
isRedirect() : booleanIs this a redirect?
| Type | Description |
|---|---|
| boolean |
outputBody() : voidEcho the body segments
prepend(string $name, string $content) : voidPrepend a named body segment to the body content array
If segment already exists, replaces with $content and places at top of array.
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $content | string |
renderExceptions(boolean $flag = null) : booleanWhether 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.
| Name | Type | Description |
|---|---|---|
| $flag | boolean | Optional |
| Type | Description |
|---|---|
| boolean |
sendHeaders() : \Zend_Controller_Response_AbstractSend all headers
Sends any headers specified. If an HTTP response code has been specified, it is sent with the first header.
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
sendResponse() : voidSend the response, including all headers, rendering exceptions if so requested.
setBody(string $content, null | string $name = null) : \Zend_Controller_Response_AbstractSet 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.
| Name | Type | Description |
|---|---|---|
| $content | string | |
| $name | null | string |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
setException(\Exception $e) : \Zend_Controller_Response_AbstractRegister an exception with the response
| Name | Type | Description |
|---|---|---|
| $e | \Exception |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
setHeader(string $name, string $value, boolean $replace = false) : \Zend_Controller_Response_AbstractSet a header
If $replace is true, replaces any headers already defined with that $name.
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string | |
| $replace | boolean |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
setHttpResponseCode(int $code) : \Zend_Controller_Response_AbstractSet HTTP response code to use with headers
| Name | Type | Description |
|---|---|---|
| $code | int |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
setRawHeader(string $value) : \Zend_Controller_Response_AbstractSet raw HTTP header
Allows setting non key => value headers, such as status codes
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |
setRedirect(string $url, int $code = 302) : \Zend_Controller_Response_AbstractSet redirect URL
Sets Location header and response code. Forces replacement of any prior redirects.
| Name | Type | Description |
|---|---|---|
| $url | string | |
| $code | int |
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract |