API Documentation

Zend/Form/Decorator/FormErrors.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

Properties

Propertyprotectedarray  $_defaults= 'array( 'ignoreSubForms' => false'

Default values for markup options

Default valuearray( 'ignoreSubForms' => falseDetails
Type
array
Propertyprotected  $_ignoreSubForms= ''
Details
Type
Propertyprotected  $_markupElementLabelEnd= ''
Details
Type
Propertyprotected  $_markupElementLabelStart= ''
Details
Type
Propertyprotected  $_markupListEnd= ''
Details
Type
Propertyprotected  $_markupListItemEnd= ''
Details
Type
Propertyprotected  $_markupListItemStart= ''
Details
Type
Propertyprotected  $_markupListStart= ''
Details
Type
Propertyprotected  $_onlyCustomFormErrors= ''
Details
Type
Propertyprotected  $_showCustomFormErrors= ''
Details
Type

Methods

methodprotected_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
methodpublicgetMarkupElementLabelEnd( ) : string

Retrieve markupElementLabelEnd

Returns
Type Description
string
methodpublicgetMarkupElementLabelStart( ) : string

Retrieve markupElementLabelStart

Returns
Type Description
string
methodpublicgetMarkupListEnd( ) : string

Retrieve markupListEnd

Returns
Type Description
string
methodpublicgetMarkupListItemEnd( ) : string

Retrieve markupListItemEnd

Returns
Type Description
string
methodpublicgetMarkupListItemStart( ) : string

Retrieve markupListItemStart

Returns
Type Description
string
methodpublicgetMarkupListStart( ) : string

Retrieve markupListStart

Returns
Type Description
string
methodpublicgetOnlyCustomFormErrors( ) : bool

Get onlyCustomFormErrors

Returns
Type Description
bool
methodpublicgetShowCustomFormErrors( ) : bool

Get showCustomFormErrors

Returns
Type Description
bool
methodpublicignoreSubForms( ) : bool

Retrieve ignoreSubForms

Returns
Type Description
bool
methodpublicinitOptions( ) : void

Initialize options

methodpublicrender( string $content ) : string

Render errors

Parameters
Name Type Description
$content string
Returns
Type Description
string
methodpublicrenderLabel( \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
methodpublicsetIgnoreSubForms( bool $ignoreSubForms ) : \Zend_Form_Decorator_FormErrors

Set ignoreSubForms

Parameters
Name Type Description
$ignoreSubForms bool
Returns
Type Description
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupElementLabelEnd( string $markupElementLabelEnd ) : \Zend_Form_Decorator_FormErrors

Set markupElementLabelEnd

Parameters
Name Type Description
$markupElementLabelEnd string
Returns
Type Description
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupElementLabelStart( string $markupElementLabelStart ) : \Zend_Form_Decorator_FormErrors

Set markupElementLabelStart

Parameters
Name Type Description
$markupElementLabelStart string
Returns
Type Description
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupListEnd( string $markupListEnd ) : \Zend_Form_Decorator_FormErrors

Set markupListEnd

Parameters
Name Type Description
$markupListEnd string
Returns
Type Description
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupListItemEnd( string $markupListItemEnd ) : \Zend_Form_Decorator_FormErrors

Set markupListItemEnd

Parameters
Name Type Description
$markupListItemEnd string
Returns
Type Description
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupListItemStart( string $markupListItemStart ) : \Zend_Form_Decorator_FormErrors

Set markupListItemStart

Parameters
Name Type Description
$markupListItemStart string
Returns
Type Description
\Zend_Form_Decorator_FormErrors
methodpublicsetMarkupListStart( string $markupListStart ) : \Zend_Form_Decorator_FormErrors

Set markupListStart

Parameters
Name Type Description
$markupListStart string
Returns
Type Description
\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
Name Type Description
$onlyCustomFormErrors bool
Returns
Type Description
\Zend_Form_Decorator_FormErrors
methodpublicsetShowCustomFormErrors( bool $showCustomFormErrors ) : \Zend_Form_Decorator_FormErrors

Set showCustomFormErrors

Parameters
Name Type Description
$showCustomFormErrors bool
Returns
Type Description
\Zend_Form_Decorator_FormErrors
Documentation was generated by DocBlox 0.15.1.