Class FormContext
Provides a context provider for {@link \Cake\Form\Form} instances.
This context provider simply fulfils the interface requirements that FormHelper has and allows access to the form data.
Constants
-
array<string>VALID_ATTRIBUTES ¶['length', 'precision', 'comment', 'null', 'default']
Property Summary
-
$_form protected
Cake\Form\FormThe form object.
-
$_validator protected
string|nullValidator name.
Method Summary
-
__construct() public
Constructor.
-
_schemaDefault() protected
Get default value from form schema for given field.
-
attributes() public
Get an associative array of other attributes for a field name.
-
error() public
Get the errors for a given field
-
fieldNames() public
Get the field names of the top level object in this context.
-
getMaxLength() public
Get maximum length of a field from model validation.
-
getPrimaryKey() public
Get the fields used in the context as a primary key.
-
getRequiredMessage() public
Gets the default "required" error message for a field
-
hasError() public
Check whether a field has an error attached to it
-
isCreate() public
Returns whether this form is for a create operation.
-
isPrimaryKey() public
Returns true if the passed field name is part of the primary key for this context
-
isRequired() public
Check if a given field is 'required'.
-
primaryKey() public deprecated
Get the fields used in the context as a primary key.
-
type() public
Get the abstract field type for a given field name.
-
val() public
Get the current value for a given field.
Method Detail
__construct() ¶ public
__construct(array $context)Constructor.
Parameters
-
array$context Context info.
_schemaDefault() ¶ protected
_schemaDefault(string $field): mixedGet default value from form schema for given field.
Parameters
-
string$field Field name.
Returns
mixedattributes() ¶ public
attributes(string $field): arrayGet an associative array of other attributes for a field name.
Parameters
-
string$field
Returns
arrayerror() ¶ public
error(string $field): arrayGet the errors for a given field
Parameters
-
string$field
Returns
arrayfieldNames() ¶ public
fieldNames(): array<string>Get the field names of the top level object in this context.
Returns
array<string>getMaxLength() ¶ public
getMaxLength(string $field): int|nullGet maximum length of a field from model validation.
Parameters
-
string$field
Returns
int|nullgetPrimaryKey() ¶ public
getPrimaryKey(): array<string>Get the fields used in the context as a primary key.
Returns
array<string>getRequiredMessage() ¶ public
getRequiredMessage(string $field): string|nullGets the default "required" error message for a field
Parameters
-
string$field
Returns
string|nullhasError() ¶ public
hasError(string $field): boolCheck whether a field has an error attached to it
Parameters
-
string$field
Returns
boolisCreate() ¶ public
isCreate(): boolReturns whether this form is for a create operation.
Returns
boolisPrimaryKey() ¶ public
isPrimaryKey(string $field): boolReturns true if the passed field name is part of the primary key for this context
Parameters
-
string$field
Returns
boolisRequired() ¶ public
isRequired(string $field): bool|nullCheck if a given field is 'required'.
In this context class, this is simply defined by the 'required' array.
Parameters
-
string$field
Returns
bool|nullprimaryKey() ¶ public
primaryKey(): array<string>Get the fields used in the context as a primary key.
Returns
array<string>type() ¶ public
type(string $field): string|nullGet the abstract field type for a given field name.
Parameters
-
string$field
Returns
string|nullval() ¶ public
val(string $field, array<string, mixed> $options = []): mixedGet the current value for a given field.
Classes implementing this method can optionally have a second argument
$options. Valid key for $options array are:
default: Default value to return if no value found in data or context record.schemaDefault: Boolean indicating whether default value from context's schema should be used if it's not explicitly provided.
Parameters
-
string$field -
array<string, mixed>$options optional
Returns
mixed