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 64
__construct(string|Stringable|null $caption = null)
No description
at line 82
BaseControl
setCaption(string|Stringable|null $caption)
Sets textual caption or label.
at line 89
string|Stringable|null
getCaption()
No description
at line 99
Form|null
getForm(bool $throw = true)
Returns form.
at line 108
void
loadHttpData()
Loads HTTP data.
at line 117
protected mixed
getHttpData($type, string|null $htmlTail = null)
Loads HTTP data.
at line 126
string
getHtmlName()
Returns HTML name of control.
at line 140
Control
setValue(mixed $value)
| internal |
Sets control's value.
at line 151
mixed
getValue()
Returns control's value.
at line 160
bool
isFilled()
Is control filled?
at line 171
BaseControl
setDefaultValue($value)
Sets control's default value.
at line 186
BaseControl
setDisabled(bool $state = true)
Disables or enables control.
at line 202
bool
isDisabled()
Is control disabled?
at line 211
BaseControl
setOmitted(bool $state = true)
Sets whether control value is excluded from $form->getValues() result.
at line 221
bool
isOmitted()
Is control value excluded from $form->getValues() result?
at line 234
Html|string
getControl()
Generates control's HTML element.
at line 252
Html|string|null
getLabel(string|Stringable|null $caption = null)
Generates label's HTML element.
at line 263
Html|null
getControlPart()
No description
at line 269
Html|null
getLabelPart()
No description
at line 278
Html
getControlPrototype()
Returns control's HTML element template.
at line 287
Html
getLabelPrototype()
Returns label's HTML element template.
at line 296
BaseControl
setHtmlId(string|bool|null $id)
Changes control's HTML id.
at line 306
string|bool|null
getHtmlId()
Returns control's HTML id.
at line 323
BaseControl
setHtmlAttribute(string $name, mixed $value = true)
Changes control's HTML attribute.
at line 343
BaseControl
setAttribute(string $name, mixed $value = true)
deprecated
deprecated
No description
at line 355
BaseControl
setTranslator(Translator|null $translator)
Sets translate adapter.
at line 365
Translator|null
getTranslator()
Returns translate adapter.
at line 380
mixed
translate($value, ...$parameters)
Returns translated string.
at line 402
BaseControl
addRule(callable|string $validator, string|Stringable|null $errorMessage = null, mixed $arg = null)
Adds a validation rule.
at line 415
Rules
addCondition($validator, $value = null)
Adds a validation condition a returns new branch.
at line 424
Rules
addConditionOn(Control $control, $validator, $value = null)
Adds a validation condition based on another control a returns new branch.
at line 433
BaseControl
addFilter(callable $filter)
Adds an input filter callback.
at line 440
Rules
getRules()
No description
at line 449
BaseControl
setRequired(string|Stringable|bool $value = true)
Makes control mandatory.
at line 459
bool
isRequired()
Is control mandatory?
at line 468
void
validate()
Performs the server side validation.
at line 482
void
addError(string|Stringable $message, bool $translate = true)
Adds error message to the list.
at line 491
string|null
getError()
Returns errors corresponding to control.
at line 500
array
getErrors()
Returns errors corresponding to control.
at line 506
bool
hasErrors()
No description
at line 512
void
cleanErrors()
No description
at line 524
BaseControl
setOption($key, mixed $value)
Sets user-specific option.
at line 539
mixed
getOption($key)
Returns user-specific option.
at line 552
array
getOptions()
Returns user-specific options.
at line 561
__call(string $name, array $args)
No description
at line 576
static void
extensionMethod(string $name, $callback)
No description