\Cake\View\FormContextInterface

primaryKey()

primaryKey() : array

Get the fields used in the context as a primary key.

Returns

isPrimaryKey()

isPrimaryKey(string  $field) : boolean

Returns true if the passed field name is part of the primary key for this context

Parameters

Returns

isCreate()

isCreate() : boolean

Returns whether or not this form is for a create operation.

Returns

val()

val(string  $field) : 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 request data or context record.
• schemaDefault: Boolean indicating whether default value from context's schema should be used if it's not explicitly provided.

Parameters

Returns

isRequired()

isRequired(string  $field) : boolean

Check if a given field is 'required'.

In this context class, this is simply defined by the 'required' array.

Parameters

Returns

fieldNames()

fieldNames() : array<mixed,string>

Get the fieldnames of the top level object in this context.

Returns

A list of the field names in the context.

type()

type(string  $field) : null|string

Get the abstract field type for a given field name.

Parameters

Returns

An abstract data type or null.

attributes()

attributes(string  $field) : array

Get an associative array of other attributes for a field name.

Parameters

Returns

An array of data describing the additional attributes on a field.

hasError()

hasError(string  $field) : boolean

Check whether or not a field has an error attached to it

Parameters

Returns

Returns true if the errors for the field are not empty.

error()

error(string  $field) : array

Get the errors for a given field

Parameters

Returns

An array of errors, an empty array will be returned when the context has no errors.