Summary

Fully Qualified Name:	Laminas\Form\View\Helper\FormMultiCheckbox
Extends:	FormInput

Description

Methods

Name	Description	Defined By
__invoke()	Invoke helper as functor	FormMultiCheckbox
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
getLabelAttributes()	Returns the attributes applied to each option label.	FormMultiCheckbox
getLabelPosition()	Get position of label	FormMultiCheckbox
getSeparator()	Get separator for checkbox elements	FormMultiCheckbox
getTranslator()	Returns translator used in helper	AbstractTranslatorHelper
getTranslatorTextDomain()	Return the translation text domain	AbstractTranslatorHelper
getUncheckedValue()	Returns the unchecked value used when "UseHiddenElement" is turned on.	FormMultiCheckbox
getUseHiddenElement()	Returns the option for prefixing the element with a hidden element for the unset value.	FormMultiCheckbox
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	FormMultiCheckbox
setDoctype()	Set value for doctype	AbstractHelper
setEncoding()	Set value for character encoding	AbstractHelper
setLabelAttributes()	Sets the attributes applied to option label.	FormMultiCheckbox
setLabelPosition()	Set value for labelPosition	FormMultiCheckbox
setSeparator()	Set separator string for checkbox elements	FormMultiCheckbox
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
setUncheckedValue()	Sets the unchecked value used when "UseHiddenElement" is turned on.	FormMultiCheckbox
setUseHiddenElement()	Sets the option for prefixing the element with a hidden element for the unset value.	FormMultiCheckbox
setView()	Set the View object	AbstractHelper

Method Details

__invoke()

Invoke helper as functor

Proxies to {@link render()}.

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

Returns: string|\FormMultiCheckbox

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: $this

addTranslatableAttributePrefix()

Adds an HTML attribute to the list of translatable attributes

Parameter Name	Type	Description
$prefix	string

Returns: $this

addValidAttribute()

Adds an HTML attribute to the list of valid attributes

Parameter Name	Type	Description
$attribute	string

Returns: $this

addValidAttributePrefix()

Adds a prefix to the list of valid attribute prefixes

Parameter Name	Type	Description
$prefix	string

Returns: $this

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

getLabelAttributes()

Returns the attributes applied to each option label.

Returns: array|null

getLabelPosition()

Get position of label

Returns: string

getSeparator()

Get separator for checkbox elements

Returns: string

getTranslator()

Returns translator used in helper

Returns: \Translator|null

getTranslatorTextDomain()

Return the translation text domain

Returns: string

getUncheckedValue()

Returns the unchecked value used when "UseHiddenElement" is turned on.

Returns: string

getUseHiddenElement()

Returns the option for prefixing the element with a hidden element for the unset value.

Returns: bool

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

setDoctype()

Set value for doctype

Parameter Name	Type	Description
$doctype	string

Returns: $this

setEncoding()

Set value for character encoding

Parameter Name	Type	Description
$encoding	string

Returns: $this

setLabelAttributes()

Sets the attributes applied to option label.

Parameter Name	Type	Description
$attributes	array|null

Returns: $this

setLabelPosition()

Set value for labelPosition

Parameter Name	Type	Description
$labelPosition	mixed

Returns: $this

setSeparator()

Set separator string for checkbox elements

Parameter Name	Type	Description
$separator	string

Returns: $this

setTranslator()

Sets translator to use in helper

Parameter Name	Type	Description
$translator	\Translator|null	Default
$textDomain	string|null	Default

Returns: $this

setTranslatorEnabled()

Sets whether translator is enabled and should be used

Parameter Name	Type	Description
$enabled	bool

Returns: $this

setTranslatorTextDomain()

Set translation text domain

Parameter Name	Type	Description
$textDomain	string

Returns: $this

setUncheckedValue()

Sets the unchecked value used when "UseHiddenElement" is turned on.

Parameter Name	Type	Description
$value	bool

Returns: $this

setUseHiddenElement()

Sets the option for prefixing the element with a hidden element for the unset value.

Parameter Name	Type	Description
$useHiddenElement	bool

Returns: $this

setView()

Set the View object

Parameter Name	Type	Description
$view	\Renderer

Returns: \AbstractHelper