Form/Decorator/FormErrors.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
- Subpackage
- Decorator
\Zend_Form_Decorator_FormErrors
Package: Zend_Form\Decorator
Returns
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.
- 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
array $_defaults = array('ignoreSubForms' => false, 'showCustomFormErrors' => true, 'onlyCustomFormErrors' => false, 'markupElementLabelEnd' => '</b>', 'markupElementLabelStart' => '<b>', 'markupListEnd' => '</ul>', 'markupListItemEnd' => '</li>', 'markupListItemStart' => '<li>', 'markupListStart' => '<ul class="form-errors">')
Default values for markup options
Default value
array('ignoreSubForms' => false, 'showCustomFormErrors' => true, 'onlyCustomFormErrors' => false, 'markupElementLabelEnd' => '</b>', 'markupElementLabelStart' => '<b>', 'markupListEnd' => '</ul>', 'markupListItemEnd' => '</li>', 'markupListItemStart' => '<li>', 'markupListStart' => '<ul class="form-errors">')
Details- Type
- array
Methods
_recurseForm(\Zend_Form $form, \Zend_View_Interface $view) : string
Recurse through a form object, rendering errors
Parameters
Returns
Name | Type | Description |
---|---|---|
$form | \Zend_Form | |
$view | \Zend_View_Interface |
Type | Description |
---|---|
string |
render(string $content) : string
Render errors
Parameters
Returns
Name | Type | Description |
---|---|---|
$content | string |
Type | Description |
---|---|
string |
renderLabel(\Zend_Form_Element $element, \Zend_View_Interface $view) : string
Render element label
Parameters
Returns
Name | Type | Description |
---|---|---|
$element | \Zend_Form_Element | |
$view | \Zend_View_Interface |
Type | Description |
---|---|
string |
setEscape(bool $flag) : \Zend_Form_Decorator_FormErrors
Set whether or not to escape error label and error message
Sets also the 'escape' option for the view helper
ParametersName | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |
setIgnoreSubForms(bool $ignoreSubForms) : \Zend_Form_Decorator_FormErrors
Set ignoreSubForms
Parameters
Returns
Name | Type | Description |
---|---|---|
$ignoreSubForms | bool |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |
setMarkupElementLabelEnd(string $markupElementLabelEnd) : \Zend_Form_Decorator_FormErrors
Set markupElementLabelEnd
Parameters
Returns
Name | Type | Description |
---|---|---|
$markupElementLabelEnd | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |
setMarkupElementLabelStart(string $markupElementLabelStart) : \Zend_Form_Decorator_FormErrors
Set markupElementLabelStart
Parameters
Returns
Name | Type | Description |
---|---|---|
$markupElementLabelStart | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |
setMarkupListEnd(string $markupListEnd) : \Zend_Form_Decorator_FormErrors
Set markupListEnd
Parameters
Returns
Name | Type | Description |
---|---|---|
$markupListEnd | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |
setMarkupListItemEnd(string $markupListItemEnd) : \Zend_Form_Decorator_FormErrors
Set markupListItemEnd
Parameters
Returns
Name | Type | Description |
---|---|---|
$markupListItemEnd | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |
setMarkupListItemStart(string $markupListItemStart) : \Zend_Form_Decorator_FormErrors
Set markupListItemStart
Parameters
Returns
Name | Type | Description |
---|---|---|
$markupListItemStart | string |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |
setMarkupListStart(string $markupListStart) : \Zend_Form_Decorator_FormErrors
Set markupListStart
Parameters
Returns
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.
Parameters
Returns
Name | Type | Description |
---|---|---|
$onlyCustomFormErrors | bool |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |
setShowCustomFormErrors(bool $showCustomFormErrors) : \Zend_Form_Decorator_FormErrors
Set showCustomFormErrors
Parameters
Returns
Name | Type | Description |
---|---|---|
$showCustomFormErrors | bool |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |