Class EntityContext

__constructsource public

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

Constructor.

Parameters

Cake\Network\Request $request

The request object.

array $context

Context info.

_extractMultiplesource protected

_extractMultiple( array|Traversable $values , array $path )

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

array|Traversable $values

The list from which to extract primary keys from

array $path

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

Returns

array
array

_getPropsource protected

_getProp( mixed $target , string $field )

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
mixed

_getTablesource protected

_getTable( array $parts , boolean $rootFallback true )

Get the table instance from a property path

Parameters

array $parts

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

boolean $rootFallback optional true

Whether or not to fallback to the root entity.

Returns

Cake\ORM\Table|boolean
Table instance or false

_getValidatorsource protected

_getValidator( array $parts )

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
\Cake\Validation\Validator

_preparesource protected

_prepare( )

Prepare some additional data from the context.

If the table option was provided to the constructor and it was a string, ORM\TableRegistry 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.

Throws

RuntimeException
When a table object cannot be located/inferred.

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

entitysource public

entity( array|null $path null )

Fetch the leaf entity for the given path.

This method will traverse the given path and find the leaf entity. If the path does not contain a leaf entity false will be returned.

Parameters

array|null $path optional null

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

Returns

Cake\Datasource\EntityInterface|Traversable|array|boolean
\Cake\Datasource\EntityInterface|\Traversable|array|bool

Throws

RuntimeException
When properties cannot be read.

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.

Implementation of

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

fieldNamessource public

fieldNames( )

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
Array of fieldnames in the table/entity.

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

Check whether or not 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

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 field should be marked as required.

Parameters

string $field

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

Returns

boolean
bool

Implementation of

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

primaryKeysource public

primaryKey( )

Get the primary key data for the context.

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

Returns

boolean
bool

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.

See

Cake\Database\Type

Implementation of

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

valsource public

val( string $field )

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.

Returns

mixed
The value of the field or null on a miss.

Implementation of

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

false

[]