Summary

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

Description

Methods

Name	Description	Defined By
__invoke()	Invoke helper as functor	FormSelect
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
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 a form element from the provided $element	FormSelect
renderOptgroup()	Render an optgroup	FormSelect
renderOptions()	Render an array of options	FormSelect
setDoctype()	Set value for doctype	AbstractHelper
setEncoding()	Set value for character encoding	AbstractHelper
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	\ElementInterface|null

Returns: string|\FormSelect

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

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 a form element from the provided $element

Parameter Name	Type	Description
$element	\ElementInterface

Returns: string

renderOptgroup()

Render an optgroup

See {@link renderOptions()} for the options specification. Basically, an optgroup is simply an option that has an additional "options" key with an array following the specification for renderOptions().

Parameter Name	Type	Description
$optgroup	array
$selectedOptions	array

Returns: string

renderOptions()

Render an array of options

Individual options should be of the form:

array(

'value'    => 'value',
'label'    => 'label',
'disabled' => $booleanFlag,
'selected' => $booleanFlag,

)

Parameter Name	Type	Description
$options	array
$selectedOptions	array	Option

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

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