Class FormRow

Summary

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

Description

Methods

Name Description Defined By
__invoke() Invoke helper as functor FormRow
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
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
getInputErrorClass() Get the class that is added to element that have errors FormRow
getLabelAttributes() Get the attributes for the row label FormRow
getLabelPosition() Get the label position FormRow
getPartial() Retrieve current partial FormRow
getRenderErrors() Retrieve if the errors are rendered by this helper FormRow
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() Utility form helper that renders a label (if it exists), an element and errors FormRow
setDoctype() Set value for doctype AbstractHelper
setEncoding() Set value for character encoding AbstractHelper
setInputErrorClass() Set the class that is added to element that have errors FormRow
setLabelAttributes() Set the attributes for the row label FormRow
setLabelPosition() Set the label position FormRow
setPartial() Set a partial view script to use for rendering the row FormRow
setRenderErrors() Set if the errors are rendered by this helper FormRow
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()}.

Parameter Name Type Description
$element null|\ElementInterface
$labelPosition null|string
$renderErrors bool
$partial string|null

Returns: string|\FormRow

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

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

getInputErrorClass()

Get the class that is added to element that have errors

Returns: string

getLabelAttributes()

Get the attributes for the row label

Returns: array

getLabelPosition()

Get the label position

Returns: string

getPartial()

Retrieve current partial

Returns: null|string

getRenderErrors()

Retrieve if the errors are rendered by this helper

Returns: bool

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()

Utility form helper that renders a label (if it exists), an element and errors

Parameter Name Type Description
$element \ElementInterface
$labelPosition null|string

Returns: string

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

setInputErrorClass()

Set the class that is added to element that have errors

Parameter Name Type Description
$inputErrorClass string

Returns: \FormRow

setLabelAttributes()

Set the attributes for the row label

Parameter Name Type Description
$labelAttributes array

Returns: \FormRow

setLabelPosition()

Set the label position

Parameter Name Type Description
$labelPosition string

Returns: \FormRow

setPartial()

Set a partial view script to use for rendering the row

Parameter Name Type Description
$partial null|string

Returns: \FormRow

setRenderErrors()

Set if the errors are rendered by this helper

Parameter Name Type Description
$renderErrors bool

Returns: \FormRow

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

Top