Class FormContext

__constructsource public

__construct( Cake\Network\Request $request , array $context )

Constructor.

Parameters

Cake\Network\Request $request

The request object.

array $context

Context info.

attributessource public

attributes( string $field )

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

Parameters

string $field

A dot separated path to get additional data on.

Returns

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

Implementation of

Cake\View\Form\ContextInterface::attributes()

errorsource public

error( string $field )

Get the errors for a given field

Parameters

string $field

A dot separated path to check errors on.

Returns

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

Implementation of

Cake\View\Form\ContextInterface::error()

fieldNamessource public

fieldNames( )

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

Returns

array
A list of the field names in the context.

Implementation of

Cake\View\Form\ContextInterface::fieldNames()

hasErrorsource public

hasError( string $field )

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

Parameters

string $field

A dot separated path to check errors on.

Returns

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

Implementation of

Cake\View\Form\ContextInterface::hasError()

isCreatesource public

isCreate( )

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

Returns

boolean
bool

Implementation of

Cake\View\Form\ContextInterface::isCreate()

isPrimaryKeysource public

isPrimaryKey( string $field )

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

Parameters

string $field

A dot separated path to the field a value is needed for.

Returns

boolean
bool

Implementation of

Cake\View\Form\ContextInterface::isPrimaryKey()

isRequiredsource public

isRequired( string $field )

Check if a given field is 'required'.

Parameters

string $field

A dot separated path to check required-ness for.

Returns

boolean
bool

Implementation of

Cake\View\Form\ContextInterface::isRequired()

primaryKeysource public

primaryKey( )

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

Returns

array
array

Implementation of

Cake\View\Form\ContextInterface::primaryKey()

typesource public

type( string $field )

Get the abstract field type for a given field name.

Parameters

string $field

A dot separated path to get a schema type for.

Returns

null|string
An abstract data type or null.

Implementation of

Cake\View\Form\ContextInterface::type()

valsource public

val( string $field )

Get the current value for a given field.

Parameters

string $field

A dot separated path to the field a value is needed for.

Returns

mixed
mixed

Implementation of

Cake\View\Form\ContextInterface::val()