class HiddenField extends BaseControl

Hidden form control used to store a non-displayed value.

Methods

__construct($persistentValue = null)

No description

setValue(mixed $value)

Sets control's value.

mixed
getValue()

Returns control's value.

setNullable(bool $value = true)

Sets whether getValue() returns null instead of empty string.

addFilter(callable $filter)

Appends input string filter callback.

Html|string
getControl()

Generates control's HTML element.

Html|string|null
getLabel(string|object $caption = null)

Bypasses label generation.

void
addError($message, bool $translate = true)

Adds error message to the list.

Details

at line 27
__construct($persistentValue = null)

Parameters

$persistentValue

at line 45
IControl setValue(mixed $value)

Sets control's value.

Parameters

mixed $value

Return Value

IControl

at line 59
mixed getValue()

Returns control's value.

Return Value

mixed

at line 69
HiddenField setNullable(bool $value = true)

Sets whether getValue() returns null instead of empty string.

Parameters

bool $value

Return Value

HiddenField

at line 80
HiddenField addFilter(callable $filter)

Appends input string filter callback.

Parameters

callable $filter

Return Value

HiddenField

at line 87
Html|string getControl()

Generates control's HTML element.

Return Value

Html|string

at line 102
Html|string|null getLabel(string|object $caption = null)

Bypasses label generation.

Parameters

string|object $caption

Return Value

Html|string|null

at line 112
void addError($message, bool $translate = true)

Adds error message to the list.

Parameters

$message
bool $translate

Return Value

void