Interface for FormHelper context implementations.
array<string> ['length', 'precision', 'comment', 'null', 'default']
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 abstract field type for a given field name.
Get the current value for a given field.
attributes(string $field): array
Get an associative array of other attributes for a field name.
string $field A dot separated path to get additional data on.
arrayerror(string $field): array
Get the errors for a given field
string $field A dot separated path to check errors on.
arrayfieldNames(): 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 Field name.
int|nullgetPrimaryKey(): 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 A dot separated path to the field name
string|nullhasError(string $field): bool
Check whether a field has an error attached to it
string $field A dot separated path to check errors on.
boolisCreate(): bool
Returns whether this form is for a create operation.
boolisPrimaryKey(string $field): bool
Returns true if the passed field name is part of the primary key for this context
string $field A dot separated path to the field a value is needed for.
boolisRequired(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 A dot separated path to check required-ness for.
bool|nulltype(string $field): string|null
Get the abstract field type for a given field name.
string $field A dot separated path to get a schema type for.
string|nullval(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 A dot separated path to the field a value
array<string, mixed> $options optional Options. is needed for.
mixed
© 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/interface-Cake.View.Form.ContextInterface.html