Form/Decorator/Abstract.php
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Form
\Zend_Form_Decorator_Abstract
- Implements
- \Zend_Form_Decorator_Interface
- Children
- \Zend_Dojo_Form_Decorator_DijitContainer
- \Zend_Form_Decorator_Errors
- \Zend_Form_Decorator_Fieldset
- \Zend_Form_Decorator_ViewHelper
- \Zend_Form_Decorator_FormErrors
- \Zend_Form_Decorator_Callback
- \Zend_Form_Decorator_Form
- \Zend_Form_Decorator_Tooltip
- \Zend_Form_Decorator_Label
- \Zend_Form_Decorator_File
- \Zend_Form_Decorator_Captcha_ReCaptcha
- \Zend_Form_Decorator_Captcha_Word
- \Zend_Form_Decorator_Image
- \Zend_Form_Decorator_Captcha
- \Zend_Form_Decorator_Description
- \Zend_Form_Decorator_FormElements
- \Zend_Form_Decorator_ViewScript
- \Zend_Form_Decorator_DtDdWrapper
- \Zend_Form_Decorator_HtmlTag
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: Abstract.php 24593 2012-01-05 20:35:02Z matthew $
Constants
Properties
Methods


__construct(array | \Zend_Config $options = null) : void
Constructor
Accept options during initialization.
Name | Type | Description |
---|---|---|
$options | array | \Zend_Config |


clearOptions() : \Zend_Form_Decorator_Abstract
Clear all options
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


getElement() : \Zend_Form_Element | \Zend_Form
Retrieve current element
Type | Description |
---|---|
\Zend_Form_Element | \Zend_Form |


getOption(string $key) : mixed
Get option
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |


getPlacement() : string
Determine if decorator should append or prepend content
Type | Description |
---|---|
string |


getSeparator() : string
Retrieve separator to use between old and new content
Type | Description |
---|---|
string |


render(string $content) : string
Decorate content and/or element
Name | Type | Description |
---|---|---|
$content | string |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Form_Decorator_Exception | when unimplemented |


setConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
Set options from config object
Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


setElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract
Set current form element
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
Set option
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


setOptions(array $options) : \Zend_Form_Decorator_Abstract
Set options
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |