Summary

Fully Qualified Name:	Zend\Form\View\Helper\FormElementErrors
Extends:	AbstractHelper

Description

Methods

Name	Description	Defined By
__invoke()	Invoke helper as functor	FormElementErrors
addDefaultTranslatableAttribute()	Adds an HTML attribute to the list of the default translatable attributes	AbstractHelper
addDefaultTranslatableAttributePrefix()	Adds an HTML attribute to the list of translatable attributes	AbstractHelper
addTranslatableAttribute()	Adds an HTML attribute to the list of translatable attributes	AbstractHelper
addTranslatableAttributePrefix()	Adds an HTML attribute to the list of translatable attributes	AbstractHelper
addValidAttribute()	Adds an HTML attribute to the list of valid attributes	AbstractHelper
addValidAttributePrefix()	Adds a prefix to the list of valid attribute prefixes	AbstractHelper
createAttributesString()	Create a string of all attribute/value pairs	AbstractHelper
getAttributes()	Get the attributes that will go on the message open format	FormElementErrors
getDoctype()	Get value for doctype	AbstractHelper
getEncoding()	Get character encoding	AbstractHelper
getId()	Get the ID of an element	AbstractHelper
getInlineClosingBracket()	Get the closing bracket for an inline tag	AbstractHelper
getMessageCloseString()	Get the string used to close message representation	FormElementErrors
getMessageOpenFormat()	Get the formatted string used to open message representation	FormElementErrors
getMessageSeparatorString()	Get the string used to separate messages	FormElementErrors
getTranslator()	Returns translator used in helper	AbstractTranslatorHelper
getTranslatorTextDomain()	Return the translation text domain	AbstractTranslatorHelper
getView()	Get the view object	AbstractHelper
hasTranslator()	Checks if the helper has a translator	AbstractTranslatorHelper
isTranslatorEnabled()	Returns whether translator is enabled and should be used	AbstractTranslatorHelper
render()	Render validation errors for the provided $element	FormElementErrors
setAttributes()	Set the attributes that will go on the message open format	FormElementErrors
setDoctype()	Set value for doctype	AbstractHelper
setEncoding()	Set value for character encoding	AbstractHelper
setMessageCloseString()	Set the string used to close message representation	FormElementErrors
setMessageOpenFormat()	Set the formatted string used to open message representation	FormElementErrors
setMessageSeparatorString()	Set the string used to separate messages	FormElementErrors
setTranslateMessages()	Set the flag detailing whether or not to translate error messages.	FormElementErrors
setTranslator()	Sets translator to use in helper	AbstractTranslatorHelper
setTranslatorEnabled()	Sets whether translator is enabled and should be used	AbstractTranslatorHelper
setTranslatorTextDomain()	Set translation text domain	AbstractTranslatorHelper
setView()	Set the View object	AbstractHelper

Method Details

__invoke()

Invoke helper as functor

Proxies to {@link render()} if an element is passed.

Parameter Name	Type	Description
$element	\ElementInterface
$attributes	array

Returns: string|\FormElementErrors

addDefaultTranslatableAttribute()

Adds an HTML attribute to the list of the default translatable attributes

Parameter Name	Type	Description
$attribute	string

Returns:

addDefaultTranslatableAttributePrefix()

Adds an HTML attribute to the list of translatable attributes

Parameter Name	Type	Description
$prefix	string

Returns:

addTranslatableAttribute()

Adds an HTML attribute to the list of translatable attributes

Parameter Name	Type	Description
$attribute	string

Returns: \AbstractHelper

addTranslatableAttributePrefix()

Adds an HTML attribute to the list of translatable attributes

Parameter Name	Type	Description
$prefix	string

Returns: \AbstractHelper

addValidAttribute()

Adds an HTML attribute to the list of valid attributes

Parameter Name	Type	Description
$attribute	string

Returns: \AbstractHelper

addValidAttributePrefix()

Adds a prefix to the list of valid attribute prefixes

Parameter Name	Type	Description
$prefix	string

Returns: \AbstractHelper

createAttributesString()

Create a string of all attribute/value pairs

Escapes all attribute values

Parameter Name	Type	Description
$attributes	array

Returns: string

getAttributes()

Get the attributes that will go on the message open format

Returns: array

getDoctype()

Get value for doctype

Returns: string

getEncoding()

Get character encoding

Returns: string

getId()

Get the ID of an element

If no ID attribute present, attempts to use the name attribute. If no name attribute is present, either, returns null.

Parameter Name	Type	Description
$element	\ElementInterface

Returns: null|string

getInlineClosingBracket()

Get the closing bracket for an inline tag

Closes as either "/>" for XHTML doctypes or ">" otherwise.

Returns: string

getMessageCloseString()

Get the string used to close message representation

Returns: string

getMessageOpenFormat()

Get the formatted string used to open message representation

Returns: string

getMessageSeparatorString()

Get the string used to separate messages

Returns: string

getTranslator()

Returns translator used in helper

Returns: \Translator|null

getTranslatorTextDomain()

Return the translation text domain

Returns: string

getView()

Get the view object

Returns: null|\Renderer

hasTranslator()

Checks if the helper has a translator

Returns: bool

isTranslatorEnabled()

Returns whether translator is enabled and should be used

Returns: bool

render()

Render validation errors for the provided $element

If {@link $translateErrorMessages} is true, and a translator is composed, messages retrieved from the element will be translated; if either is not the case, they will not.

Parameter Name	Type	Description
$element	\ElementInterface
$attributes	array

Returns: string

setAttributes()

Set the attributes that will go on the message open format

Parameter Name	Type	Description
$attributes	array	key

Returns: \FormElementErrors

setDoctype()

Set value for doctype

Parameter Name	Type	Description
$doctype	string

Returns: \AbstractHelper

setEncoding()

Set value for character encoding

Parameter Name	Type	Description
$encoding	string

Returns: \AbstractHelper

setMessageCloseString()

Set the string used to close message representation

Parameter Name	Type	Description
$messageCloseString	string

Returns: \FormElementErrors

setMessageOpenFormat()

Set the formatted string used to open message representation

Parameter Name	Type	Description
$messageOpenFormat	string

Returns: \FormElementErrors

setMessageSeparatorString()

Set the string used to separate messages

Parameter Name	Type	Description
$messageSeparatorString	string

Returns: \FormElementErrors

setTranslateMessages()

Set the flag detailing whether or not to translate error messages.

Parameter Name	Type	Description
$flag	bool

Returns: self

setTranslator()

Sets translator to use in helper

Parameter Name	Type	Description
$translator	\Translator	[optional]
$textDomain	string	[optional]

Returns: \AbstractTranslatorHelper

setTranslatorEnabled()

Sets whether translator is enabled and should be used

Parameter Name	Type	Description
$enabled	bool

Returns: \AbstractTranslatorHelper

setTranslatorTextDomain()

Set translation text domain

Parameter Name	Type	Description
$textDomain	string

Returns: \AbstractTranslatorHelper

setView()

Set the View object

Parameter Name	Type	Description
$view	\Renderer

Returns: \AbstractHelper