Class FormContext

Provides a context provider for Cake\Form\Form instances.

This context provider simply fulfils the interface requirements that FormHelper has and allows access to the form data.

Namespace: Cake\View\Form

Properties summary

  • $_form protected
    \Cake\Form\Form

    The form object.

Method Summary

  • __construct() public

    Constructor.

  • _schemaDefault() protected

    Get default value from form schema for given field.

  • attributes() public

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

  • error() public

    Get the errors for a given field

  • fieldNames() public

    Get the field names of the top level object in this context.

  • getMaxLength() public

    Get maximum length of a field from model validation.

  • getPrimaryKey() public

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

  • getRequiredMessage() public

    Gets the default "required" error message for a field

  • hasError() public

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

  • isCreate() public

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

  • isPrimaryKey() public

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

  • isRequired() public

    Check if a given field is 'required'.

  • primaryKey() public

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

  • type() public

    Get the abstract field type for a given field name.

  • val() public

    Get the current value for a given field.

Method Detail

__construct() public 

__construct(array $context)

Constructor.

Parameters

array $context

Context info.

_schemaDefault() protected 

_schemaDefault(string $field)

Get default value from form schema for given field.

Parameters

string $field

Field name.

Returns

mixed

attributes() 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.

error() 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.

fieldNames() public 

fieldNames()

Get the field names of the top level object in this context.

Returns

string[]

A list of the field names in the context.

getMaxLength() public 

getMaxLength(string $field)

Get maximum length of a field from model validation.

Parameters

string $field

Field name.

Returns

int|null

getPrimaryKey() public 

getPrimaryKey()

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

Returns

string[]

getRequiredMessage() public 

getRequiredMessage(string $field)

Gets the default "required" error message for a field

Parameters

string $field

A dot separated path to the field name

Returns

string|null

hasError() 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

bool

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

isCreate() public 

isCreate()

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

Returns

bool

isPrimaryKey() 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

bool

isRequired() public 

isRequired(string $field)

Check if a given field is 'required'.

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

Parameters

string $field

A dot separated path to check required-ness for.

Returns

bool|null

primaryKey() public 

primaryKey()

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

Returns

string[]

type() 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

string|null

An abstract data type or null.

See Also

\Cake\Database\TypeFactory

val() public 

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.

Parameters

string $field

A dot separated path to the field a value

array $options optional

Options. is needed for.

Returns

mixed

Property Detail

$_form protected

The form object.

Type

\Cake\Form\Form

© 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/class-Cake.View.Form.FormContext.html