Form/Decorator/Interface.php
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
\Zend_Form_Decorator_Interface
Package: Zend_Form\Decorator
Returns
Zend_Form_Decorator_Interface
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id$
Methods
__construct(array | \Zend_Config $options = null) : void
Constructor
Accept options during initialization.
ParametersName | Type | Description |
---|---|---|
$options | array | \Zend_Config |
clearOptions() : \Zend_Form_Decorator_Interface
Clear all options
Returns
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |
getOption(string $key) : mixed
Retrieve a single option
Parameters
Returns
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |
removeOption(string $key) : bool
Delete a single option
Parameters
Returns
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
bool |
render(string $content) : string
Render the element
Parameters
Returns
Name | Type | Description |
---|---|---|
$content | string | Content to decorate |
Type | Description |
---|---|
string |
setConfig(\Zend_Config $config) : \Zend_Form_Decorator_Interface
Set decorator options from a config object
Parameters
Returns
Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |
setElement(mixed $element) : \Zend_Form_Decorator_Interface
Set an element to decorate
While the name is "setElement", a form decorator could decorate either
an element or a form object.
ParametersName | Type | Description |
---|---|---|
$element | mixed |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |
setOption(string $key, mixed $value) : \Zend_Form_Decorator_Interface
Set a single option
Parameters
Returns
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |
setOptions(array $options) : \Zend_Form_Decorator_Interface
Set decorator options from an array
Parameters
Returns
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |