On this page
Caution
The documentation you are viewing is for an older version of this component.
Switch to the latest (v3) version.
Elements
Color
Laminas\Form\Element\Color
is meant to be paired with
Laminas\Form\View\Helper\FormColor
for HTML5 inputs with type "color".
This element adds filters and a Regex
validator to its input filter
specification in order to validate an HTML5 valid simple color
value on the server.
Basic Usage
This element automatically adds a type
attribute of value color
.
use Laminas\Form\Element;
use Laminas\Form\Form;
$color = new Element\Color('color');
$color->setLabel('Background color');
$form = new Form('my-form');
$form->add($color);
The following uses array notation instead:
use Laminas\Form\Element;
use Laminas\Form\Form;
$form = new Form('my-form');
$form->add([
'type' => Element\Color::class,
'name' => 'color',
'options' => [
'label' => 'Background color',
],
]);
Public Methods
The following methods are specific to the Color
element; all other methods
defined by the parent Element
class are also
available.
Method signature | Description |
---|---|
getInputSpecification() : array |
Returns an input filter specification, which includes Laminas\Filter\StringTrim and Laminas\Filter\StringToLower filters, and a Laminas\Validator\Regex to validate the RGB hex format. |