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.
Zend_Form_Decorator_FormErrors
Displays all form errors in one view.
Any options passed will be used as HTML attributes of the ul tag for the errors.

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

_recurseForm(
\Zend_Form $form, \Zend_View_Interface $view
)
:
string
Recurse through a form object, rendering errors
Name | Type | Description |
---|---|---|
$form | \Zend_Form | |
$view | \Zend_View_Interface |
Type | Description |
---|---|
string |

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

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

getMarkupElementLabelStart(
)
:
string
Retrieve markupElementLabelStart
Type | Description |
---|---|
string |

getOption(
string $key
)
:
mixed
Get option
Inherited from: \Zend_Form_Decorator_Abstract::getOption()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

getOptions(
)
:
array
Retrieve options
Inherited from: \Zend_Form_Decorator_Abstract::getOptions()Type | Description |
---|---|
array |

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

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

removeOption(
mixed $key
)
:
void
Remove single option
Inherited from: \Zend_Form_Decorator_Abstract::removeOption()Name | Type | Description |
---|---|---|
$key | mixed |

render(
string $content
)
:
string
Render errors
Name | Type | Description |
---|---|---|
$content | string |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Form_Decorator_Exception | when unimplemented |

renderLabel(
\Zend_Form_Element $element, \Zend_View_Interface $view
)
:
string
Render element label
Name | Type | Description |
---|---|---|
$element | \Zend_Form_Element | |
$view | \Zend_View_Interface |
Type | Description |
---|---|
string |

setConfig(
\Zend_Config $config
)
:
\Zend_Form_Decorator_Abstract
Set options from config object
Inherited from: \Zend_Form_Decorator_Abstract::setConfig()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
Inherited from: \Zend_Form_Decorator_Abstract::setElement()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 |

setIgnoreSubForms(
bool $ignoreSubForms
)
:
\Zend_Form_Decorator_FormErrors
Set ignoreSubForms
Name | Type | Description |
---|---|---|
$ignoreSubForms | bool |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |

setMarkupElementLabelEnd(
string $markupElementLabelEnd
)
:
\Zend_Form_Decorator_FormErrors
Set markupElementLabelEnd
Name | Type | Description |
---|---|---|
$markupElementLabelEnd | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |

setMarkupElementLabelStart(
string $markupElementLabelStart
)
:
\Zend_Form_Decorator_FormErrors
Set markupElementLabelStart
Name | Type | Description |
---|---|---|
$markupElementLabelStart | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |

setMarkupListEnd(
string $markupListEnd
)
:
\Zend_Form_Decorator_FormErrors
Set markupListEnd
Name | Type | Description |
---|---|---|
$markupListEnd | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |

setMarkupListItemEnd(
string $markupListItemEnd
)
:
\Zend_Form_Decorator_FormErrors
Set markupListItemEnd
Name | Type | Description |
---|---|---|
$markupListItemEnd | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |

setMarkupListItemStart(
string $markupListItemStart
)
:
\Zend_Form_Decorator_FormErrors
Set markupListItemStart
Name | Type | Description |
---|---|---|
$markupListItemStart | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |

setMarkupListStart(
string $markupListStart
)
:
\Zend_Form_Decorator_FormErrors
Set markupListStart
Name | Type | Description |
---|---|---|
$markupListStart | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |

setOnlyCustomFormErrors(
bool $onlyCustomFormErrors
)
:
\Zend_Form_Decorator_FormErrors
Set onlyCustomFormErrors, whether to display elements messages in addition to custom form messages.
Name | Type | Description |
---|---|---|
$onlyCustomFormErrors | bool |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |

setOption(
string $key, mixed $value
)
:
\Zend_Form_Decorator_Abstract
Set option
Inherited from: \Zend_Form_Decorator_Abstract::setOption()Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |

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

setShowCustomFormErrors(
bool $showCustomFormErrors
)
:
\Zend_Form_Decorator_FormErrors
Set showCustomFormErrors
Name | Type | Description |
---|---|---|
$showCustomFormErrors | bool |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |