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.
array<string>
['length', 'precision', 'comment', 'null', 'default']
Cake\Form\Form
The form object.
string|null
Validator name.
Constructor.
Get default value from form schema for given field.
Get an associative array of other attributes for a field name.
Get the errors for a given field
Get the field names of the top level object in this context.
Get maximum length of a field from model validation.
Get the fields used in the context as a primary key.
Gets the default "required" error message for a field
Check whether a field has an error attached to it
Returns whether this form is for a create operation.
Returns true if the passed field name is part of the primary key for this context
Check if a given field is 'required'.
Get the fields used in the context as a primary key.
Get the abstract field type for a given field name.
Get the current value for a given field.
__construct(array $context)
Constructor.
array
$context Context info.
_schemaDefault(string $field): mixed
Get default value from form schema for given field.
string
$field Field name.
mixed
attributes(string $field): array
Get an associative array of other attributes for a field name.
string
$field array
error(string $field): array
Get the errors for a given field
string
$field array
fieldNames(): array<string>
Get the field names of the top level object in this context.
array<string>
getMaxLength(string $field): int|null
Get maximum length of a field from model validation.
string
$field int|null
getPrimaryKey(): array<string>
Get the fields used in the context as a primary key.
array<string>
getRequiredMessage(string $field): string|null
Gets the default "required" error message for a field
string
$field string|null
hasError(string $field): bool
Check whether a field has an error attached to it
string
$field bool
isCreate(): bool
Returns whether this form is for a create operation.
bool
isPrimaryKey(string $field): bool
Returns true if the passed field name is part of the primary key for this context
string
$field bool
isRequired(string $field): bool|null
Check if a given field is 'required'.
In this context class, this is simply defined by the 'required' array.
string
$field bool|null
primaryKey(): array<string>
Get the fields used in the context as a primary key.
array<string>
type(string $field): string|null
Get the abstract field type for a given field name.
string
$field string|null
val(string $field, array<string, mixed> $options = []): mixed
Get 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.string
$field array<string, mixed>
$options optional mixed
The form object.
Cake\Form\Form
Validator name.
string|null
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.View.Form.FormContext.html