\Cake\View\FormArrayContext

Provides a basic array based context provider for FormHelper.

This adapter is useful in testing or when you have forms backed by simple array data structures.

Important keys:

  • defaults The default values for fields. These values will be used when there is no request data set. Data should be nested following the dot separated paths you access your fields with.
  • required A nested array of fields, relationships and boolean flags to indicate a field is required. The value can also be a string to be used as the required error message
  • schema An array of data that emulate the column structures that Cake\Database\Schema\Schema uses. This array allows you to control the inferred type for fields and allows auto generation of attributes like maxlength, step and other HTML attributes. If you want primary key/id detection to work. Make sure you have provided a _constraints array that contains primary. See below for an example.
  • errors An array of validation errors. Errors should be nested following the dot separated paths you access your fields with.

    Example

    $data = [
    'schema' => [
     'id' => ['type' => 'integer'],
     'title' => ['type' => 'string', 'length' => 255],
     '_constraints' => [
       'primary' => ['type' => 'primary', 'columns' => ['id']]
     ]
    ],
    'defaults' => [
     'id' => 1,
     'title' => 'First post!',
    ],
    'required' => [
     'id' => true, // will use default required message
     'title' => 'Please enter a title',
     'body' => false,
    ],
    ];

Summary

Methods
Properties
Constants
__construct()
primaryKey()
isPrimaryKey()
isCreate()
val()
isRequired()
getRequiredMessage()
getMaxLength()
fieldNames()
type()
attributes()
hasError()
error()
No public properties found
No constants found
stripNesting()
$_request
$_context
N/A
No private methods found
No private properties found
N/A

Properties

$_context

$_context : array

Context data for this object.

Type

array

Methods

__construct()

__construct(\Cake\Http\ServerRequest  $request, array  $context) 

Constructor.

Parameters

\Cake\Http\ServerRequest $request

The request object.

array $context

Context info.

primaryKey()

primaryKey() : array

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

Returns

array

isPrimaryKey()

isPrimaryKey(string  $field) : boolean

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

isCreate()

isCreate() : boolean

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

For this method to return true, both the primary key constraint must be defined in the 'schema' data, and the 'defaults' data must contain a value for all fields in the key.

Returns

boolean

val()

val(string  $field, array  $options = array()) : mixed

Get the current value for a given field.

This method will coalesce the current request data and the 'defaults' array.

Parameters

string $field

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

array $options

Options:

  • 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.

Returns

mixed

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

string $field

A dot separated path to check required-ness for.

Returns

boolean

getRequiredMessage()

getRequiredMessage(  $field) 

{@inheritDoc}

Parameters

$field

getMaxLength()

getMaxLength(string  $field) : integer|null

Get field length from validation

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

Parameters

string $field

A dot separated path to check required-ness for.

Returns

integer|null

fieldNames()

fieldNames() : array<mixed,string>

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

Returns

array<mixed,string> —

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

string $field

A dot separated path to get a schema type for.

Returns

null|string —

An abstract data type or null.

attributes()

attributes(string  $field) : array

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.

hasError()

hasError(string  $field) : boolean

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.

error()

error(string  $field) : array

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.

stripNesting()

stripNesting(string  $field) : string

Strips out any numeric nesting

For example users.0.age will output as users.age

Parameters

string $field

A dot separated path

Returns

string —

A string with stripped numeric nesting