Form/Decorator/FormErrors.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2012 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
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

>VConstant  APPEND = 'APPEND'
inherited
Placement constants
Inherited from: \Zend_Form_Decorator_Abstract::APPEND
>VConstant  PREPEND = 'PREPEND'

Properties

>VPropertyprotectedarray $_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 valuearray('ignoreSubForms' => false, 'showCustomFormErrors' => true, 'onlyCustomFormErrors' => false, 'markupElementLabelEnd' => '</b>', 'markupElementLabelStart' => '<b>', 'markupListEnd' => '</ul>', 'markupListItemEnd' => '</li>', 'markupListItemStart' => '<li>', 'markupListStart' => '<ul class="form-errors">')Details
Type
array
>VPropertyprotected\Zend_Form_Element|\Zend_Form $_element
>VPropertyprotectedbool $_escape
Whether or not to escape error label and error message
Details
Type
bool
>VPropertyprotected$_ignoreSubForms
Details
Type
n/a
>VPropertyprotected$_markupElementLabelEnd
Details
Type
n/a
>VPropertyprotected$_markupElementLabelStart
Details
Type
n/a
>VPropertyprotected$_markupListEnd
Details
Type
n/a
>VPropertyprotected$_markupListItemEnd
Details
Type
n/a
>VPropertyprotected$_markupListItemStart
Details
Type
n/a
>VPropertyprotected$_markupListStart
Details
Type
n/a
>VPropertyprotected$_onlyCustomFormErrors
Details
Type
n/a
>VPropertyprotectedarray $_options = array()
inherited
Decorator options
Inherited from: \Zend_Form_Decorator_Abstract::$$_options
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Decorator_Abstract::$$_options  
>VPropertyprotectedstring $_placement = 'APPEND'
inherited
Default placement: append
Inherited from: \Zend_Form_Decorator_Abstract::$$_placement
Default value'APPEND'Details
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_placement  
>VPropertyprotectedstring $_separator = PHP_EOL
inherited
Separator between new content and old
Inherited from: \Zend_Form_Decorator_Abstract::$$_separator
Default valuePHP_EOLDetails
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_separator  
>VPropertyprotected$_showCustomFormErrors
Details
Type
n/a

Methods

methodpublic__construct(array | \Zend_Config $options = null) : void
inherited

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodprotected_recurseForm(\Zend_Form $form, \Zend_View_Interface $view) : string

Recurse through a form object, rendering errors

Parameters
NameTypeDescription
$form\Zend_Form
$view\Zend_View_Interface
Returns
TypeDescription
string
methodpublicclearOptions() : \Zend_Form_Decorator_Abstract
inherited

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicgetElement() : \Zend_Form_Element | \Zend_Form
inherited

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()
Returns
TypeDescription
\Zend_Form_Element | \Zend_Form
methodpublicgetEscape() : bool

Get escape flag

Returns
TypeDescription
bool
methodpublicgetMarkupElementLabelEnd() : string

Retrieve markupElementLabelEnd

Returns
TypeDescription
string
methodpublicgetMarkupElementLabelStart() : string

Retrieve markupElementLabelStart

Returns
TypeDescription
string
methodpublicgetMarkupListEnd() : string

Retrieve markupListEnd

Returns
TypeDescription
string
methodpublicgetMarkupListItemEnd() : string

Retrieve markupListItemEnd

Returns
TypeDescription
string
methodpublicgetMarkupListItemStart() : string

Retrieve markupListItemStart

Returns
TypeDescription
string
methodpublicgetMarkupListStart() : string

Retrieve markupListStart

Returns
TypeDescription
string
methodpublicgetOnlyCustomFormErrors() : bool

Get onlyCustomFormErrors

Returns
TypeDescription
bool
methodpublicgetOption(string $key) : mixed
inherited

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetOptions() : array
inherited

Retrieve options

Inherited from: \Zend_Form_Decorator_Abstract::getOptions()
Returns
TypeDescription
array
methodpublicgetPlacement() : string
inherited

Determine if decorator should append or prepend content

Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()
Returns
TypeDescription
string
methodpublicgetSeparator() : string
inherited

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()
Returns
TypeDescription
string
methodpublicgetShowCustomFormErrors() : bool

Get showCustomFormErrors

Returns
TypeDescription
bool
methodpublicignoreSubForms() : bool

Retrieve ignoreSubForms

Returns
TypeDescription
bool
methodpublicinitOptions() : void

Initialize options

methodpublicremoveOption(mixed $key) : void
inherited

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()
Parameters
NameTypeDescription
$keymixed
methodpublicrender(string $content) : string

Render errors

Parameters
NameTypeDescription
$contentstring
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionwhen unimplemented
methodpublicrenderLabel(\Zend_Form_Element $element, \Zend_View_Interface $view) : string

Render element label

Parameters
NameTypeDescription
$element\Zend_Form_Element
$view\Zend_View_Interface
Returns
TypeDescription
string
methodpublicsetConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
inherited

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract
inherited

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.

Parameters
NameTypeDescription
$element\Zend_Form_Element | \Zend_Form
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionon invalid element type
methodpublicsetEscape(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

Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_Decorator_FormErrors
methodpublicsetIgnoreSubForms(bool $ignoreSubForms) : \Zend_Form_Decorator_FormErrors

Set ignoreSubForms

Parameters
NameTypeDescription
$ignoreSubFormsbool
Returns
TypeDescription
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupElementLabelEnd(string $markupElementLabelEnd) : \Zend_Form_Decorator_FormErrors

Set markupElementLabelEnd

Parameters
NameTypeDescription
$markupElementLabelEndstring
Returns
TypeDescription
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupElementLabelStart(string $markupElementLabelStart) : \Zend_Form_Decorator_FormErrors

Set markupElementLabelStart

Parameters
NameTypeDescription
$markupElementLabelStartstring
Returns
TypeDescription
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupListEnd(string $markupListEnd) : \Zend_Form_Decorator_FormErrors

Set markupListEnd

Parameters
NameTypeDescription
$markupListEndstring
Returns
TypeDescription
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupListItemEnd(string $markupListItemEnd) : \Zend_Form_Decorator_FormErrors

Set markupListItemEnd

Parameters
NameTypeDescription
$markupListItemEndstring
Returns
TypeDescription
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupListItemStart(string $markupListItemStart) : \Zend_Form_Decorator_FormErrors

Set markupListItemStart

Parameters
NameTypeDescription
$markupListItemStartstring
Returns
TypeDescription
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupListStart(string $markupListStart) : \Zend_Form_Decorator_FormErrors

Set markupListStart

Parameters
NameTypeDescription
$markupListStartstring
Returns
TypeDescription
\Zend_Form_Decorator_FormErrors
methodpublicsetOnlyCustomFormErrors(bool $onlyCustomFormErrors) : \Zend_Form_Decorator_FormErrors

Set onlyCustomFormErrors, whether to display elements messages in addition to custom form messages.

Parameters
NameTypeDescription
$onlyCustomFormErrorsbool
Returns
TypeDescription
\Zend_Form_Decorator_FormErrors
methodpublicsetOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract
inherited

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetOptions(array $options) : \Zend_Form_Decorator_Abstract
inherited

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetShowCustomFormErrors(bool $showCustomFormErrors) : \Zend_Form_Decorator_FormErrors

Set showCustomFormErrors

Parameters
NameTypeDescription
$showCustomFormErrorsbool
Returns
TypeDescription
\Zend_Form_Decorator_FormErrors
Documentation was generated by phpDocumentor 2.0.0a12.