Hidden and value kits¶
Kits in src/Kits/Field/ that carry data without a visible input.
HiddenKit¶
A hidden input; its value is sent to the browser.
| Class | Drupal\formfactorykits\Kits\Field\HiddenKit (src/Kits/Field/HiddenKit.php) |
| Extends | FieldKit |
| Factory method | $kits->hidden() |
Form API #type |
hidden |
| Default ID | hidden |
| Traits | DefaultValueTrait, PrefixTrait, SuffixTrait, ValueTrait |
Setters
| Method | From |
|---|---|
setDefaultValue(array\|string\|null $value) |
DefaultValueTrait (trait) |
setPrefix(array\|string\|null $value) |
PrefixTrait (trait) |
setSuffix(array\|string\|null $value) |
SuffixTrait (trait) |
setValue(array\|string\|null $value) |
ValueTrait (trait) |
Example
$kit = $kits->hidden('token')->setValue('abc');
Generated render array ([$kit->getID() => $kit->getArray()])
[
'token' => [
'#type' => 'hidden',
'#value' => 'abc',
],
]
ValueKit¶
A value element; its value stays on the server and is available in form state.
| Class | Drupal\formfactorykits\Kits\Field\ValueKit (src/Kits/Field/ValueKit.php) |
| Extends | FieldKit |
| Factory method | $kits->value() |
Form API #type |
value |
| Default ID | value |
| Traits | DefaultValueTrait, PrefixTrait, SuffixTrait, ValueTrait |
Setters
| Method | From |
|---|---|
setDefaultValue(array\|string\|null $value) |
DefaultValueTrait (trait) |
setPrefix(array\|string\|null $value) |
PrefixTrait (trait) |
setSuffix(array\|string\|null $value) |
SuffixTrait (trait) |
setValue(array\|string\|null $value) |
ValueTrait (trait) |
Example
$kit = $kits->value('nid')->setValue('42');
Generated render array ([$kit->getID() => $kit->getArray()])
[
'nid' => [
'#type' => 'value',
'#value' => '42',
],
]