Zend\Form\Element\Checkbox
Synopsis
class Checkbox
extends Element
implements
InputProviderInterface
{
- // members
- protected array $attributes;
- protected ValidatorInterface $validator;
- protected bool $useHiddenElement;
- protected string $uncheckedValue;
- protected string $checkedValue;
- // Inherited members from Element
- protected array $attributes;
- protected null|string $label;
- protected array $labelAttributes;
- protected array $labelOptions;
- protected array $messages;
- protected array $options;
- protected mixed $value;
- // methods
- public Checkbox setOptions()
- public Checkbox setUseHiddenElement()
- public bool useHiddenElement()
- public Checkbox setUncheckedValue()
- public string getUncheckedValue()
- public Checkbox setCheckedValue()
- public string getCheckedValue()
- protected ValidatorInterface getValidator()
- public array getInputSpecification()
- public bool isChecked()
- public Checkbox setChecked()
- public Element setValue()
- // Inherited methods from Element
- public void __construct()
- public void init()
- public Element|ElementInterface setName()
- public string|int getName()
- public Element|ElementInterface setOptions()
- public array getOptions()
- public NULL|mixed getOption()
- public self setOption()
- public Element|ElementInterface setAttribute()
- public mixed|null getAttribute()
- public ElementInterface removeAttribute()
- public bool hasAttribute()
- public Element|ElementInterface setAttributes()
- public array|Traversable getAttributes()
- public ElementInterface removeAttributes()
- public Element|ElementInterface clearAttributes()
- public Element setValue()
- public mixed getValue()
- public Element|ElementInterface setLabel()
- public null|string getLabel()
- public Element|ElementInterface setLabelAttributes()
- public array getLabelAttributes()
- public Element|ElementInterface setLabelOptions()
- public array getLabelOptions()
- public Element|ElementInterface clearLabelOptions()
- public ElementInterface removeLabelOptions()
- public Element|ElementInterface setLabelOption()
- public mixed|null getLabelOption()
- public ElementInterface removeLabelOption()
- public bool hasLabelOption()
- public Element|ElementInterface setMessages()
- public array|Traversable getMessages()
Hierarchy
Extends
Extended by
Implements
Members
protected
- $attributes
—
array
Seed attributes - $attributes — array
- $checkedValue — string
- $label — Zend\Form\null|string
- $labelAttributes — array
- $labelOptions
—
array
Label specific options - $messages — array
- $options — array
- $uncheckedValue — string
- $useHiddenElement — Zend\Form\Element\bool
- $validator — \Zend\Validator\ValidatorInterface
- $value — mixed
Methods
protected
- getValidator() — Get validator
public
- getCheckedValue() — Get the value to use when checkbox is checked
- getInputSpecification() — Provide default input rules for this element
- getUncheckedValue() — Get the value to use when checkbox is unchecked
- isChecked() — Checks if this checkbox is checked.
- setChecked() — Checks or unchecks the checkbox.
- setCheckedValue() — Set the value to use when checkbox is checked
- setOptions() — Accepted options for MultiCheckbox: - use_hidden_element: do we render hidden element? - unchecked_value: value for checkbox when unchecked - checked_value: value for checkbox when checked
- setUncheckedValue() — Set the value to use when checkbox is unchecked
- setUseHiddenElement() — Do we render hidden element?
- setValue() — Checks or unchecks the checkbox.
- useHiddenElement() — Do we render hidden element?
Inherited from Zend\Form\Element
public
- clearAttributes() — Clear all attributes
- clearLabelOptions() — Clear all label options
- getAttribute() — Retrieve a single element attribute
- getAttributes() — Retrieve all attributes at once
- getLabel() — Retrieve the label used for this element
- getLabelAttributes() — Get the attributes to use with the label
- getLabelOption() — Retrieve a single label option
- getLabelOptions() — Get label specific options
- getMessages() — Get validation error messages, if any.
- getName() — Get value for name
- getOption() — Return the specified option
- getOptions() — Get defined options
- getValue() — Retrieve the element value
- hasAttribute() — Does the element has a specific attribute ?
- hasLabelOption() — Does the element has a specific label option ?
- init() — This function is automatically called when creating element with factory. It allows to perform various operations (add elements...)
- removeAttribute() — Remove a single attribute
- removeAttributes() — Remove many attributes at once
- removeLabelOption() — Remove a single label option
- removeLabelOptions() — Remove many attributes at once
- setAttribute() — Set a single element attribute
- setAttributes() — Set many attributes at once
- setLabel() — Set the label used for this element
- setLabelAttributes() — Set the attributes to use with the label
- setLabelOption() — Set a single label optionn
- setLabelOptions() — Set many label options at once
- setMessages() — Set a list of messages to report when validation fails
- setName() — Set value for name
- setOption() — Set a single option for an element
- setOptions() — Set options for an element. Accepted options are: - label: label to associate with the element - label_attributes: attributes to use when the label is rendered - label_options: label specific options
- setValue() — Set the element value