class Form extends Container implements IHtmlString

Creates, validates and renders HTML forms.

Constants

EQUAL

validator

IS_IN

validator

NOT_EQUAL

validator

IS_NOT_IN

validator

FILLED

validator

BLANK

validator

REQUIRED

validator

VALID

validator

SUBMITTED

validator

MIN_LENGTH

validator

MAX_LENGTH

validator

LENGTH

validator

EMAIL

validator

URL

validator

PATTERN

validator

PATTERN_ICASE

validator

INTEGER

validator

NUMERIC

validator

FLOAT

validator

MIN

validator

MAX

validator

RANGE

validator

COUNT

validator

MAX_FILE_SIZE

validator

MIME_TYPE

validator

IMAGE

validator

MAX_POST_SIZE

validator

GET

method

POST

method

DATA_TEXT

submitted data types

DATA_LINE

submitted data types

DATA_FILE

submitted data types

DATA_KEYS

submitted data types

TRACKER_ID

PROTECTOR_ID

Properties

callable[] $onSuccess
callable[] $onError
callable[] $onSubmit
callable[] $onRender
IRequest $httpRequest
string $action
string $method

Methods

__construct(string $name = null)

Form constructor.

Form|null
getForm(bool $throw = true)

Returns self.

setAction(string|object $url)

Sets form's action.

mixed
getAction()

Returns form's action.

setMethod(string $method)

Sets form's method GET or POST.

string
getMethod()

Returns form's method.

bool
isMethod(string $method)

Checks if the request method is the given one.

addProtection(string $errorMessage = null)

Cross-Site Request Forgery (CSRF) form protection.

addGroup(string $caption = null, bool $setAsCurrent = true)

Adds fieldset group to the form.

void
removeGroup(string|int|ControlGroup $name)

Removes fieldset group from form.

array
getGroups()

Returns all defined groups.

ControlGroup|null
getGroup(string|int $name)

Returns the specified group.

setTranslator(ITranslator|null $translator)

Sets translate adapter.

ITranslator|null
getTranslator()

Returns translate adapter.

bool
isAnchored()

Tells if the form is anchored.

isSubmitted()

Tells if the form was submitted.

bool
isSuccess()

Tells if the form was submitted and successfully validated.

setSubmittedBy(ISubmitterControl|null $by)

Sets the submittor control.

mixed
getHttpData(int $type = null, string $htmlName = null)

Returns submitted HTTP data.

void
fireEvents()

Fires submit/click events.

reset()

Resets form.

array|null
receiveHttpData()

Internal: returns submitted HTTP data or null when form was not submitted.

void
validate(array $controls = null)

Performs the server side validation.

void
validateMaxPostSize()

No description

void
addError($message, bool $translate = true)

Adds global error message.

array
getErrors()

Returns global validation errors.

bool
hasErrors()

No description

void
cleanErrors()

No description

array
getOwnErrors()

Returns form's validation errors.

getElementPrototype()

Returns form's HTML element template.

setRenderer(IFormRenderer|null $renderer)

Sets form renderer.

getRenderer()

Returns form renderer.

beforeRender()

No description

void
fireRenderEvents()

Must be called before form is rendered and render() is not used.

void
render(...$args)

Renders form.

string
__toString()

Renders form to string.

array
getToggles()

No description

Details

at line 127
__construct(string $name = null)

Form constructor.

Parameters

string $name

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

Returns self.

Parameters

bool $throw

Return Value

Form|null

at line 157
Form setAction(string|object $url)

Sets form's action.

Parameters

string|object $url

Return Value

Form

at line 168
mixed getAction()

Returns form's action.

Return Value

mixed

at line 178
Form setMethod(string $method)

Sets form's method GET or POST.

Parameters

string $method

Return Value

Form

at line 191
string getMethod()

Returns form's method.

Return Value

string

at line 200
bool isMethod(string $method)

Checks if the request method is the given one.

Parameters

string $method

Return Value

bool

at line 209
CsrfProtection addProtection(string $errorMessage = null)

Cross-Site Request Forgery (CSRF) form protection.

Parameters

string $errorMessage

Return Value

CsrfProtection

at line 220
ControlGroup addGroup(string $caption = null, bool $setAsCurrent = true)

Adds fieldset group to the form.

Parameters

string $caption
bool $setAsCurrent

Return Value

ControlGroup

at line 242
void removeGroup(string|int|ControlGroup $name)

Removes fieldset group from form.

Parameters

string|int|ControlGroup $name

Return Value

void

at line 267
array getGroups()

Returns all defined groups.

Return Value

array

at line 277
ControlGroup|null getGroup(string|int $name)

Returns the specified group.

Parameters

string|int $name

Return Value

ControlGroup|null

at line 290
Form setTranslator(ITranslator|null $translator)

Sets translate adapter.

Parameters

ITranslator|null $translator

Return Value

Form

at line 300
ITranslator|null getTranslator()

Returns translate adapter.

Return Value

ITranslator|null

at line 312
bool isAnchored()

Tells if the form is anchored.

Return Value

bool

at line 322
ISubmitterControl|bool isSubmitted()

Tells if the form was submitted.

Return Value

ISubmitterControl|bool submittor control

at line 334
bool isSuccess()

Tells if the form was submitted and successfully validated.

Return Value

bool

at line 345
Form setSubmittedBy(ISubmitterControl|null $by)

Sets the submittor control.

Parameters

ISubmitterControl|null $by

Return Value

Form

at line 356
mixed getHttpData(int $type = null, string $htmlName = null)

Returns submitted HTTP data.

Parameters

int $type
string $htmlName

Return Value

mixed

at line 376
void fireEvents()

Fires submit/click events.

Return Value

void

at line 432
Form reset()

Resets form.

Return Value

Form

at line 443
protected array|null receiveHttpData()

Internal: returns submitted HTTP data or null when form was not submitted.

Return Value

array|null

at line 472
void validate(array $controls = null)

Performs the server side validation.

Parameters

array $controls

Return Value

void

at line 484
void validateMaxPostSize()

Return Value

void

at line 504
void addError($message, bool $translate = true)

Adds global error message.

Parameters

$message
bool $translate

Return Value

void

at line 516
array getErrors()

Returns global validation errors.

Return Value

array

at line 522
bool hasErrors()

Return Value

bool

at line 528
void cleanErrors()

Return Value

void

at line 537
array getOwnErrors()

Returns form's validation errors.

Return Value

array

at line 549
Html getElementPrototype()

Returns form's HTML element template.

Return Value

Html

at line 564
Form setRenderer(IFormRenderer|null $renderer)

Sets form renderer.

Parameters

IFormRenderer|null $renderer

Return Value

Form

at line 574
IFormRenderer getRenderer()

Returns form renderer.

Return Value

IFormRenderer

at line 583
protected beforeRender()

at line 591
void fireRenderEvents()

Must be called before form is rendered and render() is not used.

Return Value

void

at line 604
void render(...$args)

Renders form.

Parameters

...$args

Return Value

void

at line 615
string __toString()

Renders form to string.

Return Value

string

at line 643
array getToggles()

Return Value

array