Docs4dev
Docs
cakephp / 4.4 / class-cake.view.form.entitycontext.html

Class EntityContext

Provides a form context around a single entity and its relations. It also can be used as context around an array or iterator of entities.

This class lets FormHelper interface with entities or collections of entities.

Important Keys:

  • entity The entity this context is operating on.
  • table Either the ORM\Table instance to fetch schema/validators from, an array of table instances in the case of a form spanning multiple entities, or the name(s) of the table. If this is null the table name(s) will be determined using naming conventions.
  • validator Either the Validation\Validator to use, or the name of the validation method to call on the table object. For example 'default'. Defaults to 'default'. Can be an array of table alias=>validators when dealing with associated forms.
Namespace: Cake\View\Form

Constants

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

Property Summary

  • $_context protected
    array<string, mixed>

    Context data for this object.

  • $_isCollection protected
    bool

    Boolean to track whether the entity is a collection.

  • $_rootName protected
    string

    The name of the top level entity/table object.

  • $_tableLocator protected
    Cake\ORM\Locator\LocatorInterface|null

    Table locator instance

  • $_tables protected
    arrayCake\ORM\Table>

    A dictionary of tables

  • $_validator protected
    arrayCake\Validation\Validator>

    Dictionary of validators.

  • $defaultTable protected
    string|null

    This object's default table alias.

Method Summary

  • __construct() public

    Constructor.

  • _extractMultiple() protected

    Helper method used to extract all the primary key values out of an array, The primary key column is guessed out of the provided $path array

  • _getProp() protected

    Read property values or traverse arrays/iterators.

  • _getTable() protected

    Get the table instance from a property path

  • _getValidator() protected

    Get the validator associated to an entity based on naming conventions.

  • _prepare() protected

    Prepare some additional data from the context.

  • _schemaDefault() protected

    Get default value from table schema for given entity field.

  • attributes() public

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

  • entity() public

    Fetch the entity or data value for a given path

  • error() public

    Get the errors for a given field

  • fetchTable() public

    Convenience method to get a table instance.

  • fieldNames() public

    Get the field names from the top level entity.

  • getMaxLength() public

    Get field length from validation

  • getPrimaryKey() public

    Get the primary key data for the context.

  • getRequiredMessage() public

    Gets the default "required" error message for a field

  • getTableLocator() public

    Gets the table locator.

  • hasError() public

    Check whether a field has an error attached to it

  • isCreate() public

    Check whether this form is a create or update.

  • isPrimaryKey() public

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

  • isRequired() public

    Check if a field should be marked as required.

  • leafEntity() protected

    Fetch the terminal or leaf entity for the given path.

  • primaryKey() public deprecated

    Get the primary key data for the context.

  • setTableLocator() public

    Sets the table locator.

  • type() public

    Get the abstract field type for a given field name.

  • val() public

    Get the value for a given path.

Method Detail

__construct() public

__construct(array<string, mixed> $context)

Constructor.

Parameters

array<string, mixed> $context

Context info.

_extractMultiple() protected

_extractMultiple(mixed $values, array<string> $path): array|null

Helper method used to extract all the primary key values out of an array, The primary key column is guessed out of the provided $path array

Parameters

mixed $values

The list from which to extract primary keys from

array<string> $path

Each one of the parts in a path for a field name

Returns

array|null

_getProp() protected

_getProp(mixed $target, string $field): mixed

Read property values or traverse arrays/iterators.

Parameters

mixed $target

The entity/array/collection to fetch $field from.

string $field

The next field to fetch.

Returns

mixed

_getTable() protected

_getTable(Cake\Datasource\EntityInterface|array<string>|string $parts, bool $fallback = true): Cake\ORM\Table|null

Get the table instance from a property path

Parameters

Cake\Datasource\EntityInterface|array<string>|string $parts

Each one of the parts in a path for a field name

bool $fallback optional

Whether to fallback to the last found table when a nonexistent field/property is being encountered.

Returns

Cake\ORM\Table|null

_getValidator() protected

_getValidator(array $parts): Cake\Validation\Validator

Get the validator associated to an entity based on naming conventions.

Parameters

array $parts

Each one of the parts in a path for a field name

Returns

Cake\Validation\Validator

Throws

RuntimeException
If validator cannot be retrieved based on the parts.

_prepare() protected

_prepare(): void

Prepare some additional data from the context.

If the table option was provided to the constructor and it was a string, TableLocator will be used to get the correct table instance.

If an object is provided as the table option, it will be used as is.

If no table option is provided, the table name will be derived based on naming conventions. This inference will work with a number of common objects like arrays, Collection objects and ResultSets.

Returns

void

Throws

RuntimeException
When a table object cannot be located/inferred.

_schemaDefault() protected

_schemaDefault(array<string> $parts): mixed

Get default value from table schema for given entity field.

Parameters

array<string> $parts

Each one of the parts in a path for a field name

Returns

mixed

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

entity() public

entity(array|null $path = null): Cake\Datasource\EntityInterface|iterable|null

Fetch the entity or data value for a given path

This method will traverse the given path and find the entity or array value for a given path.

If you only want the terminal Entity for a path use leafEntity instead.

Parameters

array|null $path optional

Each one of the parts in a path for a field name or null to get the entity passed in constructor context.

Returns

Cake\Datasource\EntityInterface|iterable|null

Throws

RuntimeException
When properties cannot be read.

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

fetchTable() public

fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table

Convenience method to get a table instance.

Parameters

string|null $alias optional

The alias name you want to get. Should be in CamelCase format. If null then the value of $defaultTable property is used.

array<string, mixed> $options optional

The options you want to build the table with. If a table has already been loaded the registry options will be ignored.

Returns

Cake\ORM\Table

Throws

Cake\Core\Exception\CakeException
If `$alias` argument and `$defaultTable` property both are `null`.

See Also

\Cake\ORM\TableLocator::get()

fieldNames() public

fieldNames(): array<string>

Get the field names from the top level entity.

If the context is for an array of entities, the 0th index will be used.

Returns

array<string>

getMaxLength() public

getMaxLength(string $field): int|null

Get field length from validation

Parameters

string $field

The dot separated path to the field you want to check.

Returns

int|null

getPrimaryKey() public

getPrimaryKey(): array<string>

Get the primary key data for the context.

Gets the primary key columns from the root entity's schema.

Returns

array<string>

getRequiredMessage() public

getRequiredMessage(string $field): string|null

Gets the default "required" error message for a field

Parameters

string $field

Returns

string|null

getTableLocator() public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Gets the table locator.

Returns

Cake\ORM\Locator\LocatorInterface

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

Check whether this form is a create or update.

If the context is for a single entity, the entity's isNew() method will be used. If isNew() returns null, a create operation will be assumed.

If the context is for a collection or array the first object in the collection will be used.

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

Returns

bool

isRequired() public

isRequired(string $field): bool|null

Check if a field should be marked as required.

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

Parameters

string $field

The dot separated path to the field you want to check.

Returns

bool|null

leafEntity() protected

leafEntity(array|null $path = null): array

Fetch the terminal or leaf entity for the given path.

Traverse the path until an entity cannot be found. Lists containing entities will be traversed if the first element contains an entity. Otherwise, the containing Entity will be assumed to be the terminal one.

Parameters

array|null $path optional

Each one of the parts in a path for a field name or null to get the entity passed in constructor context.

Returns

array

Throws

RuntimeException
When properties cannot be read.

primaryKey() public

primaryKey(): array<string>

Get the primary key data for the context.

Gets the primary key columns from the root entity's schema.

Returns

array<string>

setTableLocator() public

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Sets the table locator.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator

LocatorInterface instance.

Returns

$this

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 value for a given path.

Traverses the entity data and finds the value for $path.

Parameters

string $field

The dot separated path to the value.

array<string, mixed> $options optional

Options:

Returns

mixed

Property Detail

$_context protected

Context data for this object.

Type

array<string, mixed>

$_isCollection protected

Boolean to track whether the entity is a collection.

Type

bool

$_rootName protected

The name of the top level entity/table object.

Type

string

$_tableLocator protected

Table locator instance

Type

Cake\ORM\Locator\LocatorInterface|null

$_tables protected

A dictionary of tables

Type

arrayCake\ORM\Table>

$_validator protected

Dictionary of validators.

Type

arrayCake\Validation\Validator>

$defaultTable protected

This object's default table alias.

Type

string|null

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