BaseControl
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
No description
Sets textual caption or label.
No description
Returns form.
Loads HTTP data.
Loads HTTP data.
Returns HTML name of control.
Returns control's value.
Is control filled?
Sets control's default value.
Disables or enables control.
Is control disabled?
Sets whether control value is excluded from $form->getValues() result.
Is control value excluded from $form->getValues() result?
Generates control's HTML element.
Generates label's HTML element.
No description
No description
Returns control's HTML element template.
Returns label's HTML element template.
Changes control's HTML id.
Returns control's HTML id.
Changes control's HTML attribute.
Sets translate adapter.
Returns translate adapter.
Returns translated string.
Adds a validation rule.
Adds a validation condition a returns new branch.
Adds a validation condition based on another control a returns new branch.
Adds an input filter callback.
Makes control mandatory.
Is control mandatory?
Performs the server side validation.
Adds error message to the list.
Returns errors corresponding to control.
Returns errors corresponding to control.
No description
No description
Sets user-specific option.
Returns user-specific option.
Returns user-specific options.
No description
No description
Details
at line 61
__construct(string|Stringable|null $caption = null)
No description
at line 79
BaseControl
setCaption(string|Stringable $caption)
Sets textual caption or label.
at line 86
string|Stringable|null
getCaption()
No description
at line 96
Form|null
getForm(bool $throw = true)
Returns form.
at line 105
void
loadHttpData()
Loads HTTP data.
at line 114
protected mixed
getHttpData($type, string|null $htmlTail = null)
Loads HTTP data.
at line 123
string
getHtmlName()
Returns HTML name of control.
at line 136
Control
setValue(mixed $value)
| internal |
Sets control's value.
at line 147
mixed
getValue()
Returns control's value.
at line 156
bool
isFilled()
Is control filled?
at line 166
BaseControl
setDefaultValue($value)
Sets control's default value.
at line 180
BaseControl
setDisabled(bool $state = true)
Disables or enables control.
at line 196
bool
isDisabled()
Is control disabled?
at line 205
BaseControl
setOmitted(bool $state = true)
Sets whether control value is excluded from $form->getValues() result.
at line 215
bool
isOmitted()
Is control value excluded from $form->getValues() result?
at line 227
Html|string
getControl()
Generates control's HTML element.
at line 245
Html|string|null
getLabel(string|Stringable|null $caption = null)
Generates label's HTML element.
at line 256
Html|null
getControlPart()
No description
at line 262
Html|null
getLabelPart()
No description
at line 271
Html
getControlPrototype()
Returns control's HTML element template.
at line 280
Html
getLabelPrototype()
Returns label's HTML element template.
at line 289
BaseControl
setHtmlId(string|bool|null $id)
Changes control's HTML id.
at line 299
string|bool|null
getHtmlId()
Returns control's HTML id.
at line 316
BaseControl
setHtmlAttribute(string $name, mixed $value = true)
Changes control's HTML attribute.
at line 336
BaseControl
setAttribute(string $name, mixed $value = true)
deprecated
deprecated
No description
at line 348
BaseControl
setTranslator(Translator|null $translator)
Sets translate adapter.
at line 358
Translator|null
getTranslator()
Returns translate adapter.
at line 373
mixed
translate($value, ...$parameters)
Returns translated string.
at line 394
BaseControl
addRule(callable|string $validator, string|Stringable|null $errorMessage = null, mixed $arg = null)
Adds a validation rule.
at line 408
Rules
addCondition($validator, $value = null)
Adds a validation condition a returns new branch.
at line 417
Rules
addConditionOn(Control $control, $validator, $value = null)
Adds a validation condition based on another control a returns new branch.
at line 426
BaseControl
addFilter(callable $filter)
Adds an input filter callback.
at line 433
Rules
getRules()
No description
at line 442
BaseControl
setRequired(string|Stringable|bool $value = true)
Makes control mandatory.
at line 452
bool
isRequired()
Is control mandatory?
at line 461
void
validate()
Performs the server side validation.
at line 475
void
addError(string|Stringable $message, bool $translate = true)
Adds error message to the list.
at line 484
string|null
getError()
Returns errors corresponding to control.
at line 493
array
getErrors()
Returns errors corresponding to control.
at line 499
bool
hasErrors()
No description
at line 505
void
cleanErrors()
No description
at line 517
BaseControl
setOption($key, mixed $value)
Sets user-specific option.
at line 532
mixed
getOption($key)
Returns user-specific option.
at line 545
array
getOptions()
Returns user-specific options.
at line 554
__call(string $name, array $args)
No description
at line 569
static void
extensionMethod(string $name, $callback)
No description