Form/Decorator/Callback.php
Show:
inherited
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 license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Form
- Subpackage
- Decorator
\Zend_Form_Decorator_Callback
Package: Zend_Form\Decorator
Returns
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id$
Properties
Methods
getCallback() : null | string | arrayGet registered callback
If not previously registered, checks to see if it exists in registered
options.
Returns| Type | Description |
|---|---|
| null | string | array |
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.
Parameters| Name | Type | Description |
|---|---|---|
| $content | string |
| Type | Description |
|---|---|
| string |
setCallback(callback $callback) : \Zend_Form_Decorator_CallbackSet callback
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $callback | callback |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Callback |
| Exception | Description |
|---|---|
| \Zend_Form_Exception |