Base functionality for all form view helpers
package | Default |
---|---|
inherited_from | \Zend\Form\View\Helper\FormInput |
__invoke(\Zend\Form\ElementInterface|null $element= null
, null|string $labelPosition= null
) : string | \Zend\Form\View\Helper\FormMultiCheckbox
Proxies to \render().
inherited_from | \Zend\Form\View\Helper\FormInput::__invoke() |
---|
\Zend\Form\ElementInterface
null
null
string
string
\Zend\Form\View\Helper\FormMultiCheckbox
__invoke(\Zend\Form\ElementInterface|null $element = null
) : string | \Zend\Form\View\Helper\FormInput
Proxies to \render().
\Zend\Form\ElementInterface
null
string
\Zend\Form\View\Helper\FormInput
createAttributesString(array $attributes) : string
Escapes all attribute values
array
string
getDoctype() : string
string
getEncoding() : string
string
getId(\Zend\Form\ElementInterface $element) : null | string
If no ID attribute present, attempts to use the name attribute. If no name attribute is present, either, returns null.
\Zend\Form\ElementInterface
null
string
getInlineClosingBracket() : string
Closes as either "/>" for XHTML doctypes or ">" otherwise.
string
getLabelAttributes() : array | null
array
null
getLabelPosition() : string
string
getSeparator() : string
string
getTranslator() : \Zend\I18n\Translator\TranslatorInterface | null
inherited_from | \Zend\I18n\Translator\TranslatorAwareInterface::getTranslator() |
---|
\Zend\I18n\Translator\TranslatorInterface
null
getTranslatorTextDomain() : string
inherited_from | \Zend\I18n\Translator\TranslatorAwareInterface::getTranslatorTextDomain() |
---|
string
getUncheckedValue() : string
string
getUseHiddenElement() : boolean
boolean
getView() : null | \Zend\View\Renderer\RendererInterface
inherited_from | \Zend\View\Helper\HelperInterface::getView() |
---|
null
\Zend\View\Renderer\RendererInterface
hasTranslator() : boolean
inherited_from | \Zend\I18n\Translator\TranslatorAwareInterface::hasTranslator() |
---|
boolean
isTranslatorEnabled() : boolean
inherited_from | \Zend\I18n\Translator\TranslatorAwareInterface::isTranslatorEnabled() |
---|
boolean
render(\Zend\Form\ElementInterface $element) : string
inherited_from | \Zend\Form\View\Helper\FormInput::render() |
---|
\Zend\Form\ElementInterface
\Zend\Form\Exception\InvalidArgumentException |
---|
string
render(\Zend\Form\ElementInterface $element) : string
\Zend\Form\ElementInterface
\Zend\Form\Exception\DomainException |
---|
string
setDoctype(string $doctype) : \Zend\Form\View\Helper\AbstractHelper
string
\Zend\Form\View\Helper\AbstractHelper
setEncoding(string $encoding) : \Zend\Form\View\Helper\AbstractHelper
string
\Zend\Form\View\Helper\AbstractHelper
setLabelAttributes(array|null $attributes) : \Zend\Form\View\Helper\FormMultiCheckbox
array
null
\Zend\Form\View\Helper\FormMultiCheckbox
setLabelPosition(mixed $labelPosition) : \Zend\Form\View\Helper\FormMultiCheckbox
mixed
\Zend\Form\Exception\InvalidArgumentException |
---|
\Zend\Form\View\Helper\FormMultiCheckbox
setSeparator(string $separator) : \Zend\Form\View\Helper\FormMultiCheckbox
string
\Zend\Form\View\Helper\FormMultiCheckbox
setTranslator(\Zend\I18n\Translator\TranslatorInterface $translator= null
, string $textDomain= null
) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
inherited_from | \Zend\I18n\Translator\TranslatorAwareInterface::setTranslator() |
---|
\Zend\I18n\Translator\TranslatorInterface
[optional] translator. Default is null, which sets no translator.
string
[optional] text domain Default is null, which skips setTranslatorTextDomain
\Zend\I18n\View\Helper\AbstractTranslatorHelper
setTranslatorEnabled(boolean $enabled = true
) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
inherited_from | \Zend\I18n\Translator\TranslatorAwareInterface::setTranslatorEnabled() |
---|
boolean
\Zend\I18n\View\Helper\AbstractTranslatorHelper
setTranslatorTextDomain(string $textDomain = 'default'
) : \Zend\I18n\View\Helper\AbstractTranslatorHelper
inherited_from | \Zend\I18n\Translator\TranslatorAwareInterface::setTranslatorTextDomain() |
---|
string
\Zend\I18n\View\Helper\AbstractTranslatorHelper
setUncheckedValue(boolean $value) : \Zend\Form\View\Helper\FormMultiCheckbox
boolean
\Zend\Form\View\Helper\FormMultiCheckbox
setUseHiddenElement(boolean $useHiddenElement) : \Zend\Form\View\Helper\FormMultiCheckbox
boolean
\Zend\Form\View\Helper\FormMultiCheckbox
setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
inherited_from | \Zend\View\Helper\HelperInterface::setView() |
---|
\Zend\View\Renderer\RendererInterface
\Zend\View\Helper\AbstractHelper
getDoctypeHelper() : \Zend\View\Helper\Doctype
\Zend\View\Helper\Doctype
getEscapeHtmlAttrHelper() : \Zend\View\Helper\EscapeHtmlAttr
\Zend\View\Helper\EscapeHtmlAttr
getEscapeHtmlHelper() : \Zend\View\Helper\EscapeHtml
\Zend\View\Helper\EscapeHtml
getInputHelper() : \Zend\Form\View\Helper\FormInput
\Zend\Form\View\Helper\FormInput
getInputType() : string
string
getLabelHelper() : \Zend\Form\View\Helper\FormLabel
\Zend\Form\View\Helper\FormLabel
getName(\Zend\Form\ElementInterface $element) : string
\Zend\Form\ElementInterface
\Zend\Form\Exception\DomainException |
---|
string
getType(\Zend\Form\ElementInterface $element) : string
\Zend\Form\ElementInterface
string
prepareAttributes(array $attributes) : array
Ensures appropriate attributes are present (e.g., if "name" is present, but no "id", sets the latter to the former).
Removes any invalid attributes
array
array
prepareBooleanAttributeValue(string $attribute, mixed $value) : string
Prepares the expected representation for the boolean attribute specified.
string
mixed
string
renderHiddenElement(\Zend\Form\Element\MultiCheckbox $element, array $attributes) : string
\Zend\Form\Element\MultiCheckbox
array
string
renderOptions(\Zend\Form\Element\MultiCheckbox $element, array $options, array $selectedOptions, array $attributes) : string
\Zend\Form\Element\MultiCheckbox
array
array
array
string
$booleanAttributes : array
array('autofocus' => array('on' => 'autofocus', 'off' => ''), 'checked' => array('on' => 'checked', 'off' => ''), 'disabled' => array('on' => 'disabled', 'off' => ''), 'multiple' => array('on' => 'multiple', 'off' => ''), 'readonly' => array('on' => 'readonly', 'off' => ''), 'required' => array('on' => 'required', 'off' => ''), 'selected' => array('on' => 'selected', 'off' => ''))
$doctypeHelper : \Zend\View\Helper\Doctype
$escapeHtmlAttrHelper : \Zend\View\Helper\EscapeHtmlAttr
$escapeHtmlHelper : \Zend\View\Helper\EscapeHtml
$inputHelper : \Zend\Form\View\Helper\FormInput
$labelAttributes : array
$labelHelper : \Zend\Form\View\Helper\FormLabel
$labelPosition : string
self::LABEL_APPEND
$separator : string
''
$translatableAttributes : array
array('placeholder' => true, 'title' => true)
$translator : \Zend\I18n\Translator\TranslatorInterface
$translatorEnabled : boolean
true
$translatorTextDomain : string
'default'
$uncheckedValue : string
''
$useHiddenElement : boolean
false
$validGlobalAttributes : array
array('accesskey' => true, 'class' => true, 'contenteditable' => true, 'contextmenu' => true, 'dir' => true, 'draggable' => true, 'dropzone' => true, 'hidden' => true, 'id' => true, 'lang' => true, 'onabort' => true, 'onblur' => true, 'oncanplay' => true, 'oncanplaythrough' => true, 'onchange' => true, 'onclick' => true, 'oncontextmenu' => true, 'ondblclick' => true, 'ondrag' => true, 'ondragend' => true, 'ondragenter' => true, 'ondragleave' => true, 'ondragover' => true, 'ondragstart' => true, 'ondrop' => true, 'ondurationchange' => true, 'onemptied' => true, 'onended' => true, 'onerror' => true, 'onfocus' => true, 'oninput' => true, 'oninvalid' => true, 'onkeydown' => true, 'onkeypress' => true, 'onkeyup' => true, 'onload' => true, 'onloadeddata' => true, 'onloadedmetadata' => true, 'onloadstart' => true, 'onmousedown' => true, 'onmousemove' => true, 'onmouseout' => true, 'onmouseover' => true, 'onmouseup' => true, 'onmousewheel' => true, 'onpause' => true, 'onplay' => true, 'onplaying' => true, 'onprogress' => true, 'onratechange' => true, 'onreadystatechange' => true, 'onreset' => true, 'onscroll' => true, 'onseeked' => true, 'onseeking' => true, 'onselect' => true, 'onshow' => true, 'onstalled' => true, 'onsubmit' => true, 'onsuspend' => true, 'ontimeupdate' => true, 'onvolumechange' => true, 'onwaiting' => true, 'role' => true, 'aria-labelledby' => true, 'aria-describedby' => true, 'spellcheck' => true, 'style' => true, 'tabindex' => true, 'title' => true, 'xml:base' => true, 'xml:lang' => true, 'xml:space' => true)
$validTagAttributes : array
array()
This should be overridden in extending classes
$validTypes : array
array('text' => true, 'button' => true, 'checkbox' => true, 'file' => true, 'hidden' => true, 'image' => true, 'password' => true, 'radio' => true, 'reset' => true, 'select' => true, 'submit' => true, 'color' => true, 'date' => true, 'datetime' => true, 'datetime-local' => true, 'email' => true, 'month' => true, 'number' => true, 'range' => true, 'search' => true, 'tel' => true, 'time' => true, 'url' => true, 'week' => true)
$view : \Zend\View\Renderer\RendererInterface
null
LABEL_APPEND = 'append'
LABEL_PREPEND = 'prepend'