Form/Decorator/Callback.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_Form
- Subpackage
- Decorator
\Zend_Form_Decorator_Callback
Zend_Form_Decorator_Callback
Execute an arbitrary callback to decorate an element. Callbacks should take three arguments, $content, $element, and $options:
function mycallback($content, $element, array $options) { }
and should return a string. ($options are whatever options were provided to the decorator.)
To specify a callback, pass a valid callback as the 'callback' option.
Callback results will be either appended, prepended, or replace the provided content. To replace the content, specify a placement of boolean false; defaults to append content.
- Parent(s)
- \Zend_Form_Decorator_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: Callback.php 24593 2012-01-05 20:35:02Z matthew $
Constants
PREPEND
= 'PREPEND'- Inherited_from
- \Zend_Form_Decorator_Abstract::PREPEND
Properties
string|array $_callback = Callback
- Type
- string | array
\Zend_Form_Element|\Zend_Form $_element = - Type
- \Zend_Form_Element | \Zend_Form
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_element
array $_options = array()
array()Details- Type
- array
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_options
string $_placement = 'APPEND'
'APPEND'Details- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_placement
string $_separator = PHP_EOLSeparator between new content and old
Inherited from: \Zend_Form_Decorator_Abstract::$$_separatorPHP_EOLDetails- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_separator
Methods
__construct(array | \Zend_Config $options = null) : voidAccept options during initialization.
| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config |
clearOptions() : \Zend_Form_Decorator_Abstract
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
getCallback() : null | string | arrayGet registered callback
If not previously registered, checks to see if it exists in registered options.
| Type | Description |
|---|---|
| null | string | array |
getElement() : \Zend_Form_Element | \Zend_Form
| Type | Description |
|---|---|
| \Zend_Form_Element | \Zend_Form |
getOption(string $key) : mixed
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed |
getOptions() : array
| Type | Description |
|---|---|
| array |
getPlacement() : stringDetermine if decorator should append or prepend content
Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()| Type | Description |
|---|---|
| string |
getSeparator() : stringRetrieve separator to use between old and new content
Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()| Type | Description |
|---|---|
| string |
removeOption(mixed $key) : void
| Name | Type | Description |
|---|---|---|
| $key | mixed |
render(string $content) : stringRender
If no callback registered, returns callback. Otherwise, gets return value of callback and either appends, prepends, or replaces passed in content.
| Name | Type | Description |
|---|---|---|
| $content | string |
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_Form_Decorator_Exception | when unimplemented |
setCallback(callback $callback) : \Zend_Form_Decorator_CallbackSet callback
| Name | Type | Description |
|---|---|---|
| $callback | callback |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Callback |
| Exception | Description |
|---|---|
| \Zend_Form_Exception |
setConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
setElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract
While the name is "setElement", a form decorator could decorate either an element or a form object.
| Name | Type | Description |
|---|---|---|
| $element | \Zend_Form_Element | \Zend_Form |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
| Exception | Description |
|---|---|
| \Zend_Form_Decorator_Exception | on invalid element type |
setOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
setOptions(array $options) : \Zend_Form_Decorator_Abstract
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |