Zend\Form\View\Helper\FormMultiCheckbox
Synopsis
class FormMultiCheckbox
extends FormInput
{
- // constants
- const LABEL_APPEND = 'append';
- const LABEL_PREPEND = 'prepend';
- // members
- protected array $labelAttributes;
- protected string $labelPosition;
- protected string $separator;
- protected bool $useHiddenElement;
- protected string $uncheckedValue;
- protected FormInput $inputHelper;
- protected FormLabel $labelHelper;
- // Inherited members from FormInput
- protected array $validTagAttributes;
- protected array $validTypes;
- // Inherited members from AbstractHelper
- protected array $booleanAttributes;
- protected array $translatableAttributes;
- protected Doctype $doctypeHelper;
- protected EscapeHtml $escapeHtmlHelper;
- protected EscapeHtmlAttr $escapeHtmlAttrHelper;
- protected array $validGlobalAttributes;
- protected array $validTagAttributes;
- // Inherited members from AbstractTranslatorHelper
- protected TranslatorInterface $translator;
- protected string $translatorTextDomain;
- protected bool $translatorEnabled;
- // Inherited members from AbstractHelper
- protected RendererInterface $view;
- // methods
- public string|FormMultiCheckbox __invoke()
- public string render()
- protected string renderOptions()
- protected string renderHiddenElement()
- public FormMultiCheckbox setLabelAttributes()
- public array|null getLabelAttributes()
- public FormMultiCheckbox setLabelPosition()
- public string getLabelPosition()
- public FormMultiCheckbox setSeparator()
- public string getSeparator()
- public FormMultiCheckbox setUseHiddenElement()
- public bool getUseHiddenElement()
- public FormMultiCheckbox setUncheckedValue()
- public string getUncheckedValue()
- protected string getInputType()
- protected static string getName()
- protected FormInput getInputHelper()
- protected FormLabel getLabelHelper()
- // Inherited methods from FormInput
- public string|FormInput __invoke()
- public string render()
- protected string getType()
- // Inherited methods from AbstractHelper
- public AbstractHelper setDoctype()
- public string getDoctype()
- public AbstractHelper setEncoding()
- public string getEncoding()
- public string createAttributesString()
- public null|string getId()
- public string getInlineClosingBracket()
- protected Doctype getDoctypeHelper()
- protected EscapeHtml getEscapeHtmlHelper()
- protected EscapeHtmlAttr getEscapeHtmlAttrHelper()
- protected array prepareAttributes()
- protected string prepareBooleanAttributeValue()
- // Inherited methods from AbstractTranslatorHelper
- public AbstractTranslatorHelper setTranslator()
- public Translator|null getTranslator()
- public bool hasTranslator()
- public AbstractTranslatorHelper setTranslatorEnabled()
- public bool isTranslatorEnabled()
- public AbstractTranslatorHelper setTranslatorTextDomain()
- public string getTranslatorTextDomain()
- // Inherited methods from AbstractHelper
- public AbstractHelper setView()
- public null|Renderer getView()
Hierarchy
Tasks
Line | Task |
---|---|
228 | Escape event attributes like AbstractHtmlElement view helper does in htmlAttribs ?? |
Constants
Name | Value |
---|---|
LABEL_APPEND | 'append' |
LABEL_PREPEND | 'prepend' |
Members
protected
- $booleanAttributes
—
array
Standard boolean attributes, with expected values for enabling/disabling - $doctypeHelper — Zend\View\Helper\Doctype
- $escapeHtmlAttrHelper — Zend\View\Helper\EscapeHtmlAttr
- $escapeHtmlHelper — Zend\View\Helper\EscapeHtml
- $inputHelper
—
Zend\Form\View\Helper\FormInput
Form input helper instance - $labelAttributes
—
array
The attributes applied to option label - $labelHelper
—
Zend\Form\View\Helper\FormLabel
Form label helper instance - $labelPosition
—
string
Where will be label rendered? - $separator
—
string
Separator for checkbox elements - $translatableAttributes
—
array
Translatable attributes - $translator
—
Zend\I18n\Translator\TranslatorInterface
Translator (optional) - $translatorEnabled
—
Zend\I18n\View\Helper\bool
Whether translator should be used - $translatorTextDomain
—
string
Translator text domain (optional) - $uncheckedValue
—
string
The unchecked value used when "UseHiddenElement" is turned on - $useHiddenElement
—
Zend\Form\View\Helper\bool
Prefixing the element with a hidden element for the unset value? - $validGlobalAttributes
—
array
Attributes globally valid for all tags - $validTagAttributes
—
array
Attributes valid for the input tag - $validTagAttributes
—
array
Attributes valid for the tag represented by this helper - $validTypes
—
array
Valid values for the input type - $view
—
Zend\View\Renderer\RendererInterface
View object instance
Methods
protected
- getInputHelper() — Retrieve the FormInput helper
- getInputType() — Return input type
- getLabelHelper() — Retrieve the FormLabel helper
- getName() — Get element name
- renderHiddenElement() — Render a hidden element for empty/unchecked value
- renderOptions() — Render options
public
- __invoke() — Invoke helper as functor
- getLabelAttributes() — Returns the attributes applied to each option label.
- getLabelPosition() — Get position of label
- getSeparator() — Get separator for checkbox elements
- getUncheckedValue() — Returns the unchecked value used when "UseHiddenElement" is turned on.
- getUseHiddenElement() — Returns the option for prefixing the element with a hidden element for the unset value.
- render() — Render a form <input> element from the provided $element
- setLabelAttributes() — Sets the attributes applied to option label.
- setLabelPosition() — Set value for labelPosition
- setSeparator() — Set separator string for checkbox elements
- setUncheckedValue() — Sets the unchecked value used when "UseHiddenElement" is turned on.
- setUseHiddenElement() — Sets the option for prefixing the element with a hidden element for the unset value.
Inherited from Zend\Form\View\Helper\FormInput
protected
- getType() — Determine input type to use
public
- __invoke() — Invoke helper as functor
- render() — Render a form <input> element from the provided $element
Inherited from Zend\Form\View\Helper\AbstractHelper
protected
- getDoctypeHelper() — Retrieve the doctype helper
- getEscapeHtmlAttrHelper() — Retrieve the escapeHtmlAttr helper
- getEscapeHtmlHelper() — Retrieve the escapeHtml helper
- prepareAttributes() — Prepare attributes for rendering
- prepareBooleanAttributeValue() — Prepare a boolean attribute value
public
- createAttributesString() — Create a string of all attribute/value pairs
- getDoctype() — Get value for doctype
- getEncoding() — Get character encoding
- getId() — Get the ID of an element
- getInlineClosingBracket() — Get the closing bracket for an inline tag
- setDoctype() — Set value for doctype
- setEncoding() — Set value for character encoding
Inherited from Zend\I18n\View\Helper\AbstractTranslatorHelper
public
- getTranslator() — Returns translator used in helper
- getTranslatorTextDomain() — Return the translation text domain
- hasTranslator() — Checks if the helper has a translator
- isTranslatorEnabled() — Returns whether translator is enabled and should be used
- setTranslator() — Sets translator to use in helper
- setTranslatorEnabled() — Sets whether translator is enabled and should be used
- setTranslatorTextDomain() — Set translation text domain