abstract class BaseControl extends Component implements Control

Base class that implements the basic functionality common to form controls.

Properties

static $idMask
mixed $value
Html read-only $control
Html read-only $label
bool $disabled
string|bool|null $htmlId
string|Stringable $caption
bool $omitted
bool $required
Form read-only $form
string read-only $htmlName
Html read-only $controlPrototype
Html read-only $labelPrototype
bool read-only $filled
array read-only $errors
array read-only $options
string read-only $error

Methods

__construct(string|Stringable|null $caption = null)

No description

setCaption(string|Stringable $caption)

Sets textual caption or label.

string|Stringable|null
getCaption()

No description

Form|null
getForm(bool $throw = true)

Returns form.

void
loadHttpData()

Loads HTTP data.

mixed
getHttpData($type, string|null $htmlTail = null)

Loads HTTP data.

string
getHtmlName()

Returns HTML name of control.

setValue(mixed $value)

Sets control's value.

mixed
getValue()

Returns control's value.

bool
isFilled()

Is control filled?

setDefaultValue($value)

Sets control's default value.

setDisabled(bool $value = true)

Disables or enables control.

bool
isDisabled()

Is control disabled?

setOmitted(bool $value = true)

Sets whether control value is excluded from $form->getValues() result.

bool
isOmitted()

Is control value excluded from $form->getValues() result?

Html|string
getControl()

Generates control's HTML element.

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

Generates label's HTML element.

Html|null
getControlPart()

No description

Html|null
getLabelPart()

No description

Html
getControlPrototype()

Returns control's HTML element template.

Html
getLabelPrototype()

Returns label's HTML element template.

setHtmlId(string|bool|null $id)

Changes control's HTML id.

string|bool|null
getHtmlId()

Returns control's HTML id.

setHtmlAttribute(string $name, mixed $value = true)

Changes control's HTML attribute.

setAttribute(string $name, mixed $value = true) deprecated

No description

setTranslator(Translator|null $translator)

Sets translate adapter.

Translator|null
getTranslator()

Returns translate adapter.

mixed
translate($value, ...$parameters)

Returns translated string.

addRule(callable|string $validator, string|Stringable|null $errorMessage = null, mixed $arg = null)

Adds a validation rule.

addCondition($validator, $value = null)

Adds a validation condition a returns new branch.

addConditionOn(Control $control, $validator, $value = null)

Adds a validation condition based on another control a returns new branch.

addFilter(callable $filter)

Adds an input filter callback.

getRules()

No description

setRequired(string|Stringable|bool $value = true)

Makes control mandatory.

bool
isRequired()

Is control mandatory?

void
validate()

Performs the server side validation.

void
addError(string|Stringable $message, bool $translate = true)

Adds error message to the list.

string|null
getError()

Returns errors corresponding to control.

array
getErrors()

Returns errors corresponding to control.

bool
hasErrors()

No description

void
cleanErrors()

No description

setOption($key, mixed $value)

Sets user-specific option.

mixed
getOption($key)

Returns user-specific option.

array
getOptions()

Returns user-specific options.

mixed
__call(string $name, array $args)

No description

static void
extensionMethod(string $name, $callback)

No description

Details

at line 63
__construct(string|Stringable|null $caption = null)

No description

Parameters

string|Stringable|null $caption

at line 81
BaseControl setCaption(string|Stringable $caption)

Sets textual caption or label.

Parameters

string|Stringable $caption

Return Value

BaseControl

at line 88
string|Stringable|null getCaption()

No description

Return Value

string|Stringable|null

at line 98
Form|null getForm(bool $throw = true)

Returns form.

Parameters

bool $throw

Return Value

Form|null

at line 107
void loadHttpData()

Loads HTTP data.

Return Value

void

at line 116
protected mixed getHttpData($type, string|null $htmlTail = null)

Loads HTTP data.

Parameters

$type
string|null $htmlTail

Return Value

mixed

at line 125
string getHtmlName()

Returns HTML name of control.

Return Value

string

at line 138
Control setValue(mixed $value)

internal  
 

Sets control's value.

Parameters

mixed $value

Return Value

Control

at line 149
mixed getValue()

Returns control's value.

Return Value

mixed

at line 158
bool isFilled()

Is control filled?

Return Value

bool

at line 168
BaseControl setDefaultValue($value)

Sets control's default value.

Parameters

$value

Return Value

BaseControl

at line 182
BaseControl setDisabled(bool $value = true)

Disables or enables control.

Parameters

bool $value

Return Value

BaseControl

at line 197
bool isDisabled()

Is control disabled?

Return Value

bool

at line 206
BaseControl setOmitted(bool $value = true)

Sets whether control value is excluded from $form->getValues() result.

Parameters

bool $value

Return Value

BaseControl

at line 216
bool isOmitted()

Is control value excluded from $form->getValues() result?

Return Value

bool

at line 228
Html|string getControl()

Generates control's HTML element.

Return Value

Html|string

at line 246
Html|string|null getLabel(string|Stringable|null $caption = null)

Generates label's HTML element.

Parameters

string|Stringable|null $caption

Return Value

Html|string|null

at line 257
Html|null getControlPart()

No description

Return Value

Html|null

at line 263
Html|null getLabelPart()

No description

Return Value

Html|null

at line 272
Html getControlPrototype()

Returns control's HTML element template.

Return Value

Html

at line 281
Html getLabelPrototype()

Returns label's HTML element template.

Return Value

Html

at line 290
BaseControl setHtmlId(string|bool|null $id)

Changes control's HTML id.

Parameters

string|bool|null $id

Return Value

BaseControl

at line 300
string|bool|null getHtmlId()

Returns control's HTML id.

Return Value

string|bool|null

at line 317
BaseControl setHtmlAttribute(string $name, mixed $value = true)

Changes control's HTML attribute.

Parameters

string $name
mixed $value

Return Value

BaseControl

at line 337
BaseControl setAttribute(string $name, mixed $value = true) deprecated

deprecated use setHtmlAttribute()

No description

Parameters

string $name
mixed $value

Return Value

BaseControl

at line 349
BaseControl setTranslator(Translator|null $translator)

Sets translate adapter.

Parameters

Translator|null $translator

Return Value

BaseControl

at line 359
Translator|null getTranslator()

Returns translate adapter.

Return Value

Translator|null

at line 374
mixed translate($value, ...$parameters)

Returns translated string.

Parameters

$value
...$parameters

Return Value

mixed

at line 395
BaseControl addRule(callable|string $validator, string|Stringable|null $errorMessage = null, mixed $arg = null)

Adds a validation rule.

Parameters

callable|string $validator
string|Stringable|null $errorMessage
mixed $arg

Return Value

BaseControl

at line 409
Rules addCondition($validator, $value = null)

Adds a validation condition a returns new branch.

Parameters

$validator
$value

Return Value

Rules

at line 418
Rules addConditionOn(Control $control, $validator, $value = null)

Adds a validation condition based on another control a returns new branch.

Parameters

Control $control
$validator
$value

Return Value

Rules

at line 427
BaseControl addFilter(callable $filter)

Adds an input filter callback.

Parameters

callable $filter

Return Value

BaseControl

at line 434
Rules getRules()

No description

Return Value

Rules

at line 443
BaseControl setRequired(string|Stringable|bool $value = true)

Makes control mandatory.

Parameters

string|Stringable|bool $value

Return Value

BaseControl

at line 453
bool isRequired()

Is control mandatory?

Return Value

bool

at line 462
void validate()

Performs the server side validation.

Return Value

void

at line 476
void addError(string|Stringable $message, bool $translate = true)

Adds error message to the list.

Parameters

string|Stringable $message
bool $translate

Return Value

void

at line 485
string|null getError()

Returns errors corresponding to control.

Return Value

string|null

at line 494
array getErrors()

Returns errors corresponding to control.

Return Value

array

at line 500
bool hasErrors()

No description

Return Value

bool

at line 506
void cleanErrors()

No description

Return Value

void

at line 518
BaseControl setOption($key, mixed $value)

Sets user-specific option.

Parameters

$key
mixed $value

Return Value

BaseControl

at line 533
mixed getOption($key)

Returns user-specific option.

Parameters

$key

Return Value

mixed

at line 546
array getOptions()

Returns user-specific options.

Return Value

array

at line 555
mixed __call(string $name, array $args)

No description

Parameters

string $name
array $args

Return Value

mixed

at line 570
static void extensionMethod(string $name, $callback)

No description

Parameters

string $name
$callback

Return Value

void