Interface for FormHelper context implementations.
Returns true if the passed field name is part of the primary key for this context
attributes(string $field)
Get an associative array of other attributes for a field name.
string
$field A dot separated path to get additional data on.
array
An array of data describing the additional attributes on a field.
error(string $field)
Get the errors for a given field
string
$field A dot separated path to check errors on.
array
An array of errors, an empty array will be returned when the context has no errors.
fieldNames()
Get the field names of the top level object in this context.
string[]
A list of the field names in the context.
getMaxLength(string $field)
Get maximum length of a field from model validation.
string
$field Field name.
int|null
getPrimaryKey()
Get the fields used in the context as a primary key.
string[]
getRequiredMessage(string $field)
Gets the default "required" error message for a field
string
$field A dot separated path to the field name
string|null
hasError(string $field)
Check whether or not a field has an error attached to it
string
$field A dot separated path to check errors on.
bool
Returns true if the errors for the field are not empty.
isCreate()
Returns whether or not this form is for a create operation.
bool
isPrimaryKey(string $field)
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.
bool
isRequired(string $field)
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|null
type(string $field)
Get the abstract field type for a given field name.
string
$field A dot separated path to get a schema type for.
string|null
An abstract data type or null.
val(string $field, array $options)
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
$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.1/interface-Cake.View.Form.ContextInterface.html