class SubmitButton extends Button implements SubmitterControl

Submittable button control.

Properties

$onClick

Occurs when the button is clicked and form is successfully validated

$onInvalidClick
bool read-only $submittedBy

Methods

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

No description

void
loadHttpData()

Loads HTTP data.

bool
isSubmittedBy()

Tells if the form was submitted by this button.

setValidationScope(iterable|null $scope)

Sets the validation scope. Clicking the button validates only the controls within the specified scope.

array|null
getValidationScope()

Returns the validation scope, or null if the entire form is validated.

void
click()

Invokes the onClick handlers.

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

Generates control's HTML element.

Details

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

No description

Parameters

string|Stringable|null $caption

at line 44
void loadHttpData()

Loads HTTP data.

Return Value

void

at line 56
bool isSubmittedBy()

Tells if the form was submitted by this button.

Return Value

bool

at line 66
SubmitButton setValidationScope(iterable|null $scope)

Sets the validation scope. Clicking the button validates only the controls within the specified scope.

Parameters

iterable|null $scope

Return Value

SubmitButton

at line 92
array|null getValidationScope()

Returns the validation scope, or null if the entire form is validated.

Return Value

array|null

at line 101
void click()

Invokes the onClick handlers.

Return Value

void

at line 107
Html|string getControl(string|Stringable|null $caption = null)

Generates control's HTML element.

Parameters

string|Stringable|null $caption

Return Value

Html|string