Base functionality for all form view helpers

category Zend
package Zend_Form
subpackage View

 Methods

Invoke helper as functor

__invoke(\Zend\Form\ElementInterface $element, null | string $labelPosition) : string | \Zend\Form\View\Helper\FormMultiCheckbox
Inherited

Proxies to render().

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::__invoke()

Parameters

$labelPosition

nullstring

Returns

Create a string of all attribute/value pairs

createAttributesString(array $attributes) : string
Inherited

Escapes all attribute values

inherited_from \Zend\Form\View\Helper\AbstractHelper::createAttributesString()
inherited_from \Zend\Form\View\Helper\FormInput::createAttributesString()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::createAttributesString()

Parameters

$attributes

array

Returns

string

Get value for doctype

getDoctype() : string
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::getDoctype()
inherited_from \Zend\Form\View\Helper\FormInput::getDoctype()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getDoctype()

Returns

string

Get character encoding

getEncoding() : string
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::getEncoding()
inherited_from \Zend\Form\View\Helper\FormInput::getEncoding()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getEncoding()

Returns

string

Get the ID of an element

getId(\Zend\Form\ElementInterface $element) : null | string
Inherited

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

inherited_from \Zend\Form\View\Helper\AbstractHelper::getId()
inherited_from \Zend\Form\View\Helper\FormInput::getId()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getId()

Parameters

Returns

nullstring

Get the closing bracket for an inline tag

getInlineClosingBracket() : string
Inherited

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

inherited_from \Zend\Form\View\Helper\AbstractHelper::getInlineClosingBracket()
inherited_from \Zend\Form\View\Helper\FormInput::getInlineClosingBracket()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getInlineClosingBracket()

Returns

string

Returns the attributes applied to each option label.

getLabelAttributes() : array | null
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getLabelAttributes()

Returns

arraynull

Get position of label

getLabelPosition() : string
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getLabelPosition()

Returns

string

Get separator for checkbox elements

getSeparator() : string
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getSeparator()

Returns

string

Returns translator used in helper

getTranslator() : \Zend\I18n\Translator\Translator | null
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getTranslator()
inherited_from \Zend\Form\View\Helper\AbstractHelper::getTranslator()
inherited_from \Zend\Form\View\Helper\FormInput::getTranslator()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getTranslator()

Returns

Return the translation text domain

getTranslatorTextDomain() : string
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getTranslatorTextDomain()
inherited_from \Zend\Form\View\Helper\AbstractHelper::getTranslatorTextDomain()
inherited_from \Zend\Form\View\Helper\FormInput::getTranslatorTextDomain()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getTranslatorTextDomain()

Returns

string

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

getUncheckedValue() : string
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getUncheckedValue()

Returns

string

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

getUseHiddenElement() : bool
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getUseHiddenElement()

Returns

bool

Get the view object

getView() : null | \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::getView()
inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::getView()
inherited_from \Zend\Form\View\Helper\AbstractHelper::getView()
inherited_from \Zend\Form\View\Helper\FormInput::getView()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getView()

Returns

Checks if the helper has a translator

hasTranslator() : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::hasTranslator()
inherited_from \Zend\Form\View\Helper\AbstractHelper::hasTranslator()
inherited_from \Zend\Form\View\Helper\FormInput::hasTranslator()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::hasTranslator()

Returns

bool

Returns whether translator is enabled and should be used

isTranslatorEnabled() : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::isTranslatorEnabled()
inherited_from \Zend\Form\View\Helper\AbstractHelper::isTranslatorEnabled()
inherited_from \Zend\Form\View\Helper\FormInput::isTranslatorEnabled()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::isTranslatorEnabled()

Returns

bool

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

render(\Zend\Form\ElementInterface $element) : string
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::render()

Parameters

Exceptions

\Zend\Form\Exception\InvalidArgumentException
\Zend\Form\Exception\DomainException

Returns

string

Set value for doctype

setDoctype(string $doctype) : \Zend\Form\View\Helper\AbstractHelper
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::setDoctype()
inherited_from \Zend\Form\View\Helper\FormInput::setDoctype()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setDoctype()

Parameters

$doctype

string

Returns

Set value for character encoding

setEncoding(string $encoding) : \Zend\Form\View\Helper\AbstractHelper
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::setEncoding()
inherited_from \Zend\Form\View\Helper\FormInput::setEncoding()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setEncoding()

Parameters

$encoding

string

Returns

Sets the attributes applied to option label.

setLabelAttributes(array | null $attributes) : \Zend\Form\View\Helper\FormMultiCheckbox
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setLabelAttributes()

Parameters

$attributes

arraynull

Returns

Set value for labelPosition

setLabelPosition(mixed $labelPosition) : \Zend\Form\View\Helper\$this
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setLabelPosition()

Parameters

$labelPosition

mixed

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

\Zend\Form\View\Helper\$this

Set separator string for checkbox elements

setSeparator(string $separator) : \Zend\Form\View\Helper\FormMultiCheckbox
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setSeparator()

Parameters

$separator

string

Returns

Sets translator to use in helper

setTranslator(\Zend\I18n\Translator\Translator $translator, string $textDomain) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslator()
inherited_from \Zend\Form\View\Helper\AbstractHelper::setTranslator()
inherited_from \Zend\Form\View\Helper\FormInput::setTranslator()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setTranslator()

Parameters

$translator

\Zend\I18n\Translator\Translator

[optional] translator. Default is null, which sets no translator.

$textDomain

string

[optional] text domain Default is null, which skips setTranslatorTextDomain

Returns

Sets whether translator is enabled and should be used

setTranslatorEnabled(bool $enabled) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslatorEnabled()
inherited_from \Zend\Form\View\Helper\AbstractHelper::setTranslatorEnabled()
inherited_from \Zend\Form\View\Helper\FormInput::setTranslatorEnabled()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setTranslatorEnabled()

Parameters

$enabled

bool

[optional] whether translator should be used. Default is true.

Returns

Set translation text domain

setTranslatorTextDomain(string $textDomain) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setTranslatorTextDomain()
inherited_from \Zend\Form\View\Helper\AbstractHelper::setTranslatorTextDomain()
inherited_from \Zend\Form\View\Helper\FormInput::setTranslatorTextDomain()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setTranslatorTextDomain()

Parameters

$textDomain

string

Returns

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

setUncheckedValue(bool $value) : \Zend\Form\View\Helper\FormMultiCheckbox
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setUncheckedValue()

Parameters

$value

bool

Returns

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

setUseHiddenElement(bool $useHiddenElement) : \Zend\Form\View\Helper\FormMultiCheckbox
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setUseHiddenElement()

Parameters

$useHiddenElement

bool

Returns

Set the View object

setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::setView()
inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::setView()
inherited_from \Zend\Form\View\Helper\AbstractHelper::setView()
inherited_from \Zend\Form\View\Helper\FormInput::setView()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::setView()

Parameters

Returns

Retrieve the doctype helper

getDoctypeHelper() : \Zend\View\Helper\Doctype
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::getDoctypeHelper()
inherited_from \Zend\Form\View\Helper\FormInput::getDoctypeHelper()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getDoctypeHelper()

Returns

Retrieve the escapeHtmlAttr helper

getEscapeHtmlAttrHelper() : \Zend\View\Helper\EscapeHtmlAttr
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::getEscapeHtmlAttrHelper()
inherited_from \Zend\Form\View\Helper\FormInput::getEscapeHtmlAttrHelper()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getEscapeHtmlAttrHelper()

Returns

Retrieve the escapeHtml helper

getEscapeHtmlHelper() : \Zend\View\Helper\EscapeHtml
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::getEscapeHtmlHelper()
inherited_from \Zend\Form\View\Helper\FormInput::getEscapeHtmlHelper()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getEscapeHtmlHelper()

Returns

Retrieve the FormInput helper

getInputHelper() : \Zend\Form\View\Helper\FormInput
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getInputHelper()

Returns

Return input type

getInputType() : string

Returns

string

Retrieve the FormLabel helper

getLabelHelper() : \Zend\Form\View\Helper\FormLabel
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getLabelHelper()

Returns

Get element name

getName(\Zend\Form\ElementInterface $element) : string

Parameters

Exceptions

\Zend\Form\Exception\DomainException

Returns

string

Determine input type to use

getType(\Zend\Form\ElementInterface $element) : string
Inherited

inherited_from \Zend\Form\View\Helper\FormInput::getType()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::getType()

Parameters

Returns

string

Prepare attributes for rendering

prepareAttributes(array $attributes) : array
Inherited

Ensures appropriate attributes are present (e.g., if "name" is present, but no "id", sets the latter to the former).

Removes any invalid attributes

inherited_from \Zend\Form\View\Helper\AbstractHelper::prepareAttributes()
inherited_from \Zend\Form\View\Helper\FormInput::prepareAttributes()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::prepareAttributes()

Parameters

$attributes

array

Returns

array

Prepare a boolean attribute value

prepareBooleanAttributeValue(string $attribute, mixed $value) : string
Inherited

Prepares the expected representation for the boolean attribute specified.

inherited_from \Zend\Form\View\Helper\AbstractHelper::prepareBooleanAttributeValue()
inherited_from \Zend\Form\View\Helper\FormInput::prepareBooleanAttributeValue()
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::prepareBooleanAttributeValue()

Parameters

$attribute

string

$value

mixed

Returns

string

Render a hidden element for empty/unchecked value

renderHiddenElement(\Zend\Form\Element\MultiCheckbox $element, array $attributes) : string
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::renderHiddenElement()

Parameters

$attributes

array

Returns

string

Render options

renderOptions(\Zend\Form\Element\MultiCheckbox $element, array $options, array $selectedOptions, array $attributes) : string
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::renderOptions()

Parameters

$options

array

$selectedOptions

array

$attributes

array

Returns

string

 Properties

 

Standard boolean attributes, with expected values for enabling/disabling

$booleanAttributes : array
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$booleanAttributes
inherited_from \Zend\Form\View\Helper\FormInput::$$booleanAttributes
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$booleanAttributes
 

$doctypeHelper

$doctypeHelper : \Zend\View\Helper\Doctype
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$doctypeHelper
inherited_from \Zend\Form\View\Helper\FormInput::$$doctypeHelper
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$doctypeHelper
 

$escapeHtmlAttrHelper

$escapeHtmlAttrHelper : \Zend\View\Helper\EscapeHtmlAttr
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$escapeHtmlAttrHelper
inherited_from \Zend\Form\View\Helper\FormInput::$$escapeHtmlAttrHelper
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$escapeHtmlAttrHelper
 

$escapeHtmlHelper

$escapeHtmlHelper : \Zend\View\Helper\EscapeHtml
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$escapeHtmlHelper
inherited_from \Zend\Form\View\Helper\FormInput::$$escapeHtmlHelper
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$escapeHtmlHelper
 

$inputHelper

$inputHelper : \Zend\Form\View\Helper\FormInput
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$inputHelper
 

$labelAttributes

$labelAttributes : array
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$labelAttributes
 

$labelHelper

$labelHelper : \Zend\Form\View\Helper\FormLabel
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$labelHelper
 

$labelPosition

$labelPosition : string
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$labelPosition
 

$separator

$separator : string
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$separator
 

Translatable attributes

$translatableAttributes : array
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$translatableAttributes
inherited_from \Zend\Form\View\Helper\FormInput::$$translatableAttributes
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$translatableAttributes
 

Translator (optional)

$translator : \Zend\I18n\Translator\Translator
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translator
inherited_from \Zend\Form\View\Helper\AbstractHelper::$$translator
inherited_from \Zend\Form\View\Helper\FormInput::$$translator
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$translator
 

Whether translator should be used

$translatorEnabled : bool
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translatorEnabled
inherited_from \Zend\Form\View\Helper\AbstractHelper::$$translatorEnabled
inherited_from \Zend\Form\View\Helper\FormInput::$$translatorEnabled
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$translatorEnabled
 

Translator text domain (optional)

$translatorTextDomain : string
Inherited

inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$translatorTextDomain
inherited_from \Zend\Form\View\Helper\AbstractHelper::$$translatorTextDomain
inherited_from \Zend\Form\View\Helper\FormInput::$$translatorTextDomain
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$translatorTextDomain
 

$uncheckedValue

$uncheckedValue : string
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$uncheckedValue
 

$useHiddenElement

$useHiddenElement : bool
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$useHiddenElement
 

Attributes globally valid for all tags

$validGlobalAttributes : array
Inherited

inherited_from \Zend\Form\View\Helper\AbstractHelper::$$validGlobalAttributes
inherited_from \Zend\Form\View\Helper\FormInput::$$validGlobalAttributes
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$validGlobalAttributes
 

Attributes valid for the input tag

$validTagAttributes : array
Inherited

This should be overridden in extending classes

inherited_from \Zend\Form\View\Helper\FormInput::$$validTagAttributes
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$validTagAttributes
 

Valid values for the input type

$validTypes : array
Inherited

inherited_from \Zend\Form\View\Helper\FormInput::$$validTypes
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$validTypes
 

View object

$view : \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::$$view
inherited_from \Zend\I18n\View\Helper\AbstractTranslatorHelper::$$view
inherited_from \Zend\Form\View\Helper\AbstractHelper::$$view
inherited_from \Zend\Form\View\Helper\FormInput::$$view
inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::$$view

 Constants

 

LABEL_APPEND

LABEL_APPEND 
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::LABEL_APPEND
 

LABEL_PREPEND

LABEL_PREPEND 
Inherited

inherited_from \Zend\Form\View\Helper\FormMultiCheckbox::LABEL_PREPEND