938. Class

938.1. Zend\Form\View\Helper\FormMultiCheckbox

938.1.1. Methods

938.1.1.1. setLabelPosition

setLabelPosition()

Set value for labelPosition

Parameters:mixed – Throws ExceptionInvalidArgumentException:   Return type:$this

938.1.1.2. getLabelPosition

getLabelPosition()

Get position of label

Return type:string

938.1.1.3. setSeparator

setSeparator()

Set separator string for checkbox elements

Parameters:string – Return type:FormMultiCheckbox

938.1.1.4. getSeparator

getSeparator()

Get separator for checkbox elements

Return type:string

938.1.1.5. setLabelAttributes

setLabelAttributes()

Sets the attributes applied to option label.

Parameters:array|null – Return type:FormMultiCheckbox

938.1.1.6. getLabelAttributes

getLabelAttributes()

Returns the attributes applied to each option label.

Return type:array|null

938.1.1.7. getUseHiddenElement

getUseHiddenElement()

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

Return type:bool

938.1.1.8. setUseHiddenElement

setUseHiddenElement()

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

Parameters:bool – Return type:FormMultiCheckbox

938.1.1.9. getUncheckedValue

getUncheckedValue()

Returns the unchecked value used when “UseHiddenElement” is turned on.

Return type:string

938.1.1.10. setUncheckedValue

setUncheckedValue()

Sets the unchecked value used when “UseHiddenElement” is turned on.

Parameters:bool – Return type:FormMultiCheckbox

938.1.1.11. render

render()

Render a form <input> element from the provided $element

Parameters:ElementInterface – Throws ExceptionInvalidArgumentException:   Throws ExceptionDomainException:   Return type:string

938.1.1.12. renderOptions

renderOptions()

Render options

Parameters:

• MultiCheckboxElement –
• array –
• array –
• array –

Return type:

string

938.1.1.13. renderHiddenElement

renderHiddenElement()

Render a hidden element for empty/unchecked value

Parameters:

• MultiCheckboxElement –
• array –

Return type:

string

938.1.1.14. __invoke

__invoke()

Invoke helper as functor

Proxies to {@link render()}.

Parameters:

• ElementInterface|null –
• null|string –

Return type:

string|FormMultiCheckbox

938.1.1.15. getInputType

getInputType()

Return input type

Return type:string

938.1.1.16. getInputHelper

getInputHelper()

Retrieve the FormInput helper

Return type:FormInput

938.1.1.17. getLabelHelper

getLabelHelper()

Retrieve the FormLabel helper

Return type:FormLabel

938.1.1.18. getName

getName()

Get element name

Parameters:ElementInterface – Throws ExceptionDomainException:   Return type:string

938.1.2. Constants

938.1.2.1. LABEL_APPEND

938.1.2.2. LABEL_PREPEND