class Form extends Container implements HtmlStringable

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

internal TRACKER_ID

internal PROTECTOR_ID

Properties

$onSuccess

Occurs when the form is submitted and successfully validated

$onError
$onSubmit
$onRender
internal $httpRequest
protected bool $crossOrigin
string $action
string $method
array read-only $errors
array read-only $ownErrors
Html read-only $elementPrototype
FormRenderer read-only $renderer

Methods

__construct(string|null $name = null)

No description

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.

setHtmlAttribute(string $name, $value = true)

Changes forms's HTML attribute.

void
allowCrossOrigin()

Disables CSRF protection using a SameSite cookie.

addProtection(string|null $errorMessage = null)

Cross-Site Request Forgery (CSRF) form protection.

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

Adds fieldset group to the form.

void
removeGroup(string|ControlGroup $name)

Removes fieldset group from form.

array
getGroups()

Returns all defined groups.

ControlGroup|null
getGroup(string|int $name)

Returns the specified group.

setTranslator(Translator|null $translator)

Sets translate adapter.

Translator|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(SubmitterControl|null $by)

Sets the submittor control.

mixed
getHttpData(int|null $type = null, string|null $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|null $controls = null)

Performs the server side validation.

void
validateMaxPostSize()

No description

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

Html
getElementPrototype()

Returns form's HTML element template.

setRenderer(FormRenderer|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

static void
initialize(bool $reinit = false)

Initialize standalone forms.

Details

at line 134
__construct(string|null $name = null)

No description

Parameters

string|null $name

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

Returns self.

Parameters

bool $throw

Return Value

Form|null

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

Sets form's action.

Parameters

string|object $url

Return Value

Form

at line 176
mixed getAction()

Returns form's action.

Return Value

mixed

at line 186
Form setMethod(string $method)

Sets form's method GET or POST.

Parameters

string $method

Return Value

Form

at line 200
string getMethod()

Returns form's method.

Return Value

string

at line 209
bool isMethod(string $method)

Checks if the request method is the given one.

Parameters

string $method

Return Value

bool

at line 219
Form setHtmlAttribute(string $name, $value = true)

Changes forms's HTML attribute.

Parameters

string $name
$value

Return Value

Form

at line 229
void allowCrossOrigin()

Disables CSRF protection using a SameSite cookie.

Return Value

void

at line 238
CsrfProtection addProtection(string|null $errorMessage = null)

Cross-Site Request Forgery (CSRF) form protection.

Parameters

string|null $errorMessage

Return Value

CsrfProtection

at line 252
ControlGroup addGroup(string|object $caption = null, bool $setAsCurrent = true)

Adds fieldset group to the form.

Parameters

string|object $caption
bool $setAsCurrent

Return Value

ControlGroup

at line 272
void removeGroup(string|ControlGroup $name)

Removes fieldset group from form.

Parameters

string|ControlGroup $name

Return Value

void

at line 297
array getGroups()

Returns all defined groups.

Return Value

array

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

Returns the specified group.

Parameters

string|int $name

Return Value

ControlGroup|null

at line 320
Form setTranslator(Translator|null $translator)

Sets translate adapter.

Parameters

Translator|null $translator

Return Value

Form

at line 330
Translator|null getTranslator()

Returns translate adapter.

Return Value

Translator|null

at line 342
bool isAnchored()

Tells if the form is anchored.

Return Value

bool

at line 352
SubmitterControl|bool isSubmitted()

Tells if the form was submitted.

Return Value

SubmitterControl|bool

submittor control

at line 365
bool isSuccess()

Tells if the form was submitted and successfully validated.

Return Value

bool

at line 376
Form setSubmittedBy(SubmitterControl|null $by)

internal  
 

Sets the submittor control.

Parameters

SubmitterControl|null $by

Return Value

Form

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

Returns submitted HTTP data.

Parameters

int|null $type
string|null $htmlName

Return Value

mixed

at line 410
void fireEvents()

Fires submit/click events.

Return Value

void

at line 475
Form reset()

Resets form.

Return Value

Form

at line 486
protected array|null receiveHttpData()

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

Return Value

array|null

at line 519
void validate(array|null $controls = null)

Performs the server side validation.

Parameters

array|null $controls

Return Value

void

at line 532
void validateMaxPostSize()

internal  
 

No description

Return Value

void

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

Adds global error message.

Parameters

string|object $message
bool $translate

Return Value

void

at line 562
array getErrors()

Returns global validation errors.

Return Value

array

at line 568
bool hasErrors()

No description

Return Value

bool

at line 574
void cleanErrors()

No description

Return Value

void

at line 583
array getOwnErrors()

Returns form's validation errors.

Return Value

array

at line 595
Html getElementPrototype()

Returns form's HTML element template.

Return Value

Html

at line 611
Form setRenderer(FormRenderer|null $renderer)

Sets form renderer.

Parameters

FormRenderer|null $renderer

Return Value

Form

at line 621
FormRenderer getRenderer()

Returns form renderer.

Return Value

FormRenderer

at line 631
protected beforeRender()

No description

at line 639
void fireRenderEvents()

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

Return Value

void

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

Renders form.

Parameters

...$args

Return Value

void

at line 663
string __toString()

Renders form to string.

Return Value

string

at line 680
array getToggles()

No description

Return Value

array

at line 697
static void initialize(bool $reinit = false)

Initialize standalone forms.

Parameters

bool $reinit

Return Value

void