Form/Decorator/FormErrors.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
- Subpackage
- Decorator
\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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: FormErrors.php 25257 2013-02-13 16:47:18Z frosch $
Constants

PREPEND
= 'PREPEND'
- Inherited_from
- \Zend_Form_Decorator_Abstract::PREPEND
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">')
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


\Zend_Form_Element|\Zend_Form $_element
- Type
- \Zend_Form_Element | \Zend_Form
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_element


array $_options = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_options


string $_placement = 'APPEND'
'APPEND'
Details- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_placement


string $_separator = PHP_EOL
PHP_EOL
Details- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_separator
Methods


__construct(array | \Zend_Config $options = null) : void
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 |


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 |


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
Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


setElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract
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 |


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
Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_Decorator_FormErrors |


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
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


setOptions(array $options) : \Zend_Form_Decorator_Abstract
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 |