abstract class BaseControl extends Component implements Control

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

Properties

static string $idMask
mixed $value
Html read-only $control
Html read-only $label
bool $disabled
mixed $htmlId
string|object $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|object $caption = null)

No description

setCaption(object|string $caption)

Sets textual caption or label.

object|string
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|object $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.

mixed
getHtmlId()

Returns control's HTML id.

setHtmlAttribute(string $name, $value = true)

Changes control's HTML attribute.

setAttribute(string $name, $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|object $errorMessage = null, $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 a input filter callback.

getRules()

No description

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

Makes control mandatory.

bool
isRequired()

Is control mandatory?

void
validate()

Performs the server side validation.

void
addError(string|object $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, $value)

Sets user-specific option.

mixed
getOption($key, $default = null)

Returns user-specific option.

array
getOptions()

Returns user-specific options.

__call(string $name, array $args)

No description

static void
extensionMethod(string $name, $callback)

No description

Details

at line 81
__construct(string|object $caption = null)

No description

Parameters

string|object $caption

at line 101
BaseControl setCaption(object|string $caption)

Sets textual caption or label.

Parameters

object|string $caption

Return Value

BaseControl

at line 109
object|string getCaption()

No description

Return Value

object|string

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

Returns form.

Parameters

bool $throw

Return Value

Form|null

at line 127
void loadHttpData()

Loads HTTP data.

Return Value

void

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

Loads HTTP data.

Parameters

$type
string|null $htmlTail

Return Value

mixed

at line 146
string getHtmlName()

Returns HTML name of control.

Return Value

string

at line 160
Control setValue(mixed $value)

internal  
 

Sets control's value.

Parameters

mixed $value

Return Value

Control

at line 171
mixed getValue()

Returns control's value.

Return Value

mixed

at line 180
bool isFilled()

Is control filled?

Return Value

bool

at line 191
BaseControl setDefaultValue($value)

Sets control's default value.

Parameters

$value

Return Value

BaseControl

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

Disables or enables control.

Parameters

bool $value

Return Value

BaseControl

at line 222
bool isDisabled()

Is control disabled?

Return Value

bool

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

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

Parameters

bool $value

Return Value

BaseControl

at line 242
bool isOmitted()

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

Return Value

bool

at line 255
Html|string getControl()

Generates control's HTML element.

Return Value

Html|string

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

Generates label's HTML element.

Parameters

string|object $caption

Return Value

Html|string|null

at line 285
Html|null getControlPart()

No description

Return Value

Html|null

at line 291
Html|null getLabelPart()

No description

Return Value

Html|null

at line 300
Html getControlPrototype()

Returns control's HTML element template.

Return Value

Html

at line 309
Html getLabelPrototype()

Returns label's HTML element template.

Return Value

Html

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

Changes control's HTML id.

Parameters

string|bool|null $id

Return Value

BaseControl

at line 331
mixed getHtmlId()

Returns control's HTML id.

Return Value

mixed

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

Changes control's HTML attribute.

Parameters

string $name
$value

Return Value

BaseControl

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

deprecated use setHtmlAttribute()

No description

Parameters

string $name
$value

Return Value

BaseControl

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

Sets translate adapter.

Parameters

Translator|null $translator

Return Value

BaseControl

at line 393
Translator|null getTranslator()

Returns translate adapter.

Return Value

Translator|null

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

Returns translated string.

Parameters

$value
...$parameters

Return Value

mixed

at line 433
BaseControl addRule(callable|string $validator, string|object $errorMessage = null, $arg = null)

Adds a validation rule.

Parameters

callable|string $validator
string|object $errorMessage
$arg

Return Value

BaseControl

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

Adds a validation condition a returns new branch.

Parameters

$validator
$value

Return Value

Rules

at line 452
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 462
BaseControl addFilter(callable $filter)

Adds a input filter callback.

Parameters

callable $filter

Return Value

BaseControl

at line 469
Rules getRules()

No description

Return Value

Rules

at line 480
BaseControl setRequired(bool|string|object $value = true)

Makes control mandatory.

Parameters

bool|string|object $value

Return Value

BaseControl

at line 490
bool isRequired()

Is control mandatory?

Return Value

bool

at line 499
void validate()

Performs the server side validation.

Return Value

void

at line 514
void addError(string|object $message, bool $translate = true)

Adds error message to the list.

Parameters

string|object $message
bool $translate

Return Value

void

at line 523
string|null getError()

Returns errors corresponding to control.

Return Value

string|null

at line 532
array getErrors()

Returns errors corresponding to control.

Return Value

array

at line 538
bool hasErrors()

No description

Return Value

bool

at line 544
void cleanErrors()

No description

Return Value

void

at line 557
BaseControl setOption($key, $value)

Sets user-specific option.

Parameters

$key
$value

Return Value

BaseControl

at line 573
mixed getOption($key, $default = null)

Returns user-specific option.

Parameters

$key
$default

Return Value

mixed

at line 582
array getOptions()

Returns user-specific options.

Return Value

array

at line 591
__call(string $name, array $args)

No description

Parameters

string $name
array $args

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

No description

Parameters

string $name
$callback

Return Value

void