Docs4dev
Docs
cakephp / 4.4 / interface-cake.view.form.contextinterface.html

Interface ContextInterface

Interface for FormHelper context implementations.

Namespace: Cake\View\Form

Constants

  • array<string>
    VALID_ATTRIBUTES 
    ['length', 'precision', 'comment', 'null', 'default']

Method Summary

  • 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 a field has an error attached to it

  • isCreate() public

    Returns whether 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'.

  • type() public

    Get the abstract field type for a given field name.

  • val() public

    Get the current value for a given field.

Method Detail

attributes() public

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

error() public

error(string $field): array

Get the errors for a given field

Parameters

string $field

A dot separated path to check errors on.

Returns

array

fieldNames() public

fieldNames(): array<string>

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

Returns

array<string>

getMaxLength() public

getMaxLength(string $field): int|null

Get maximum length of a field from model validation.

Parameters

string $field

Field name.

Returns

int|null

getPrimaryKey() public

getPrimaryKey(): array<string>

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

Returns

array<string>

getRequiredMessage() public

getRequiredMessage(string $field): string|null

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): bool

Check whether a field has an error attached to it

Parameters

string $field

A dot separated path to check errors on.

Returns

bool

isCreate() public

isCreate(): bool

Returns whether this form is for a create operation.

Returns

bool

isPrimaryKey() public

isPrimaryKey(string $field): bool

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): bool|null

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

type() public

type(string $field): string|null

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

See Also

\Cake\Database\TypeFactory

val() public

val(string $field, array<string, mixed> $options = []): 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 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<string, mixed> $options optional

Options. is needed for.

Returns

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.4/interface-Cake.View.Form.ContextInterface.html