Form/Decorator/FormErrors.php

Show:

inherited

Classes
- \Zend_Form_Decorator_FormErrors

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 [email protected] 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
jump to top

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

 
                APPEND
                = 'APPEND'

inherited

Placement constants

Inherited from: \Zend_Form_Decorator_Abstract::APPEND

Inherited_from: \Zend_Form_Decorator_Abstract::APPEND

 
                PREPEND
                = 'PREPEND'

inheritedInherited from: \Zend_Form_Decorator_Abstract::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">')

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

\Zend_Form_Element|\Zend_Form $_element =

inherited

Inherited from: \Zend_Form_Decorator_Abstract::$$_element

Details

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

bool $_escape =

Whether or not to escape error label and error message

Details

Type: bool

$_ignoreSubForms =

Details

Type: n/a

$_markupElementLabelEnd =

Details

Type: n/a

$_markupElementLabelStart =

Details

Type: n/a

$_markupListEnd =

Details

Type: n/a

$_markupListItemEnd =

Details

Type: n/a

$_markupListItemStart =

Details

Type: n/a

$_markupListStart =

Details

Type: n/a

$_onlyCustomFormErrors =

Details

Type: n/a

array $_options = array()

inherited

Decorator options

Inherited from: \Zend_Form_Decorator_Abstract::$$_options

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Decorator_Abstract::$$_options

string $_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

string $_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

$_showCustomFormErrors =

Details

Type: n/a

Methods

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

inherited

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters

Name	Type	Description
$options	array \| \Zend_Config

_recurseForm(\Zend_Form $form, \Zend_View_Interface $view) : string

Recurse through a form object, rendering errors

Parameters

Name	Type	Description
$form	\Zend_Form
$view	\Zend_View_Interface

Returns

Type	Description
string

clearOptions() : \Zend_Form_Decorator_Abstract

inherited

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()

Returns

Type	Description
\Zend_Form_Decorator_Abstract

getElement() : \Zend_Form_Element | \Zend_Form

inherited

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()

Returns

Type	Description
\Zend_Form_Element \| \Zend_Form

getEscape() : bool

Get escape flag

Returns

Type	Description
bool

getMarkupElementLabelEnd() : string

Retrieve markupElementLabelEnd

Returns

Type	Description
string

getMarkupElementLabelStart() : string

Retrieve markupElementLabelStart

Returns

Type	Description
string

getMarkupListEnd() : string

Retrieve markupListEnd

Returns

Type	Description
string

getMarkupListItemEnd() : string

Retrieve markupListItemEnd

Returns

Type	Description
string

getMarkupListItemStart() : string

Retrieve markupListItemStart

Returns

Type	Description
string

getMarkupListStart() : string

Retrieve markupListStart

Returns

Type	Description
string

getOnlyCustomFormErrors() : bool

Get onlyCustomFormErrors

Returns

Type	Description
bool

getOption(string $key) : mixed

inherited

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getOptions() : array

inherited

Retrieve options

Inherited from: \Zend_Form_Decorator_Abstract::getOptions()

Returns

Type	Description
array

getPlacement() : string

inherited

Determine if decorator should append or prepend content

Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()

Returns

Type	Description
string

getSeparator() : string

inherited

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()

Returns

Type	Description
string

getShowCustomFormErrors() : bool

Get showCustomFormErrors

Returns

Type	Description
bool

ignoreSubForms() : bool

Retrieve ignoreSubForms

Returns

Type	Description
bool

initOptions() : void

Initialize options

removeOption(mixed $key) : void

inherited

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()

Parameters

Name	Type	Description
$key	mixed

render(string $content) : string

Render errors

Parameters

Name	Type	Description
$content	string

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Form_Decorator_Exception	when unimplemented

renderLabel(\Zend_Form_Element $element, \Zend_View_Interface $view) : string

Render element label

Parameters

Name	Type	Description
$element	\Zend_Form_Element
$view	\Zend_View_Interface

Returns

Type	Description
string

setConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract

inherited

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Form_Decorator_Abstract

setElement(\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

Name	Type	Description
$element	\Zend_Form_Element \| \Zend_Form

Returns

Type	Description
\Zend_Form_Decorator_Abstract

Throws

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

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_Decorator_FormErrors

setIgnoreSubForms(bool $ignoreSubForms) : \Zend_Form_Decorator_FormErrors

Set ignoreSubForms

Parameters

Name	Type	Description
$ignoreSubForms	bool

Returns

Type	Description
\Zend_Form_Decorator_FormErrors

setMarkupElementLabelEnd(string $markupElementLabelEnd) : \Zend_Form_Decorator_FormErrors

Set markupElementLabelEnd

Parameters

Name	Type	Description
$markupElementLabelEnd	string

Returns

Type	Description
\Zend_Form_Decorator_FormErrors

setMarkupElementLabelStart(string $markupElementLabelStart) : \Zend_Form_Decorator_FormErrors

Set markupElementLabelStart

Parameters

Name	Type	Description
$markupElementLabelStart	string

Returns

Type	Description
\Zend_Form_Decorator_FormErrors

setMarkupListEnd(string $markupListEnd) : \Zend_Form_Decorator_FormErrors

Set markupListEnd

Parameters

Name	Type	Description
$markupListEnd	string

Returns

Type	Description
\Zend_Form_Decorator_FormErrors

setMarkupListItemEnd(string $markupListItemEnd) : \Zend_Form_Decorator_FormErrors

Set markupListItemEnd

Parameters

Name	Type	Description
$markupListItemEnd	string

Returns

Type	Description
\Zend_Form_Decorator_FormErrors

setMarkupListItemStart(string $markupListItemStart) : \Zend_Form_Decorator_FormErrors

Set markupListItemStart

Parameters

Name	Type	Description
$markupListItemStart	string

Returns

Type	Description
\Zend_Form_Decorator_FormErrors

setMarkupListStart(string $markupListStart) : \Zend_Form_Decorator_FormErrors

Set markupListStart

Parameters

Name	Type	Description
$markupListStart	string

Returns

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

Name	Type	Description
$onlyCustomFormErrors	bool

Returns

Type	Description
\Zend_Form_Decorator_FormErrors

setOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract

inherited

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()

Parameters

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\Zend_Form_Decorator_Abstract

setOptions(array $options) : \Zend_Form_Decorator_Abstract

inherited

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Form_Decorator_Abstract

setShowCustomFormErrors(bool $showCustomFormErrors) : \Zend_Form_Decorator_FormErrors

Set showCustomFormErrors

Parameters

Name	Type	Description
$showCustomFormErrors	bool

Returns

Type	Description
\Zend_Form_Decorator_FormErrors

Form/Decorator/FormErrors.php

\Zend_Form_Decorator_FormErrorsjump to top

Constants

Properties

Methods

\Zend_Form_Decorator_FormErrors
jump to top