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:
entityThe entity this context is operating on.tableEither 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.validatorEither 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.
Property Summary
-
$_context protected
arrayContext data for this object.
-
$_isCollection protected
boolBoolean to track whether or not the entity is a collection.
-
$_request protected
Cake\Http\ServerRequestThe request object.
-
$_rootName protected
stringThe name of the top level entity/table object.
-
$_tableLocator protected
Cake\ORM\Locator\LocatorInterfaceTable locator instance
-
$_tables protected
arrayA dictionary of tables
-
$_validator protected
Cake\Validation\Validator[]Dictionary of validators.
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 leaf entity for the given path.
-
error() public
Get the errors for a given field
-
fieldNames() public
Get the field names from the top level entity.
-
getMaxLength() public
Get field length from validation
-
getRequiredMessage() public
Gets the default "required" error message for a field
-
getTableLocator() public
Gets the table locator.
-
hasError() public
Check whether or not a field has an error attached to it
-
isCreate() public
Check whether or not 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.
-
primaryKey() public
Get the primary key data for the context.
-
setTableLocator() public
Sets the table locator.
-
tableLocator() public deprecated
Sets the table locator. If no parameters are passed, it will return the currently used 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(Cake\Http\ServerRequest $request, array $context)Constructor.
Parameters
-
Cake\Http\ServerRequest$request The request object.
-
array$context Context info.
_extractMultiple() ¶ protected
_extractMultiple(arrayTraversable $values, array $path): array|nullHelper 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
-
arrayTraversable$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|null_getProp() ¶ protected
_getProp(mixed $target, string $field): mixedRead 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(array $parts, bool $fallback = true): Cake\ORM\Table|boolGet the table instance from a property path
Parameters
-
array$parts Each one of the parts in a path for a field name
-
bool$fallback optional Whether or not to fallback to the last found table when a non-existent field/property is being encountered.
Returns
Cake\ORM\Table|bool_getValidator() ¶ protected
_getValidator(array $parts): Cake\Validation\ValidatorGet 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_prepare() ¶ protected
_prepare(): voidPrepare 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
voidThrows
RuntimeExceptionWhen a table object cannot be located/inferred.
_schemaDefault() ¶ protected
_schemaDefault(array $parts): mixedGet default value from table schema for given entity field.
Parameters
-
array$parts Each one of the parts in a path for a field name
Returns
mixedattributes() ¶ public
attributes(string $field): arrayGet an associative array of other attributes for a field name.
Parameters
-
string$field A dot separated path to get additional data on.
Returns
arrayentity() ¶ public
entity(array|null $path = null): Cake\Datasource\EntityInterfaceTraversable|array|boolFetch 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 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\EntityInterfaceTraversable|array|boolThrows
RuntimeExceptionWhen properties cannot be read.
error() ¶ public
error(string $field): arrayGet the errors for a given field
Parameters
-
string$field A dot separated path to check errors on.
Returns
arrayfieldNames() ¶ public
fieldNames(): arrayGet the field names from the top level entity.
If the context is for an array of entities, the 0th index will be used.
Returns
arraygetMaxLength() ¶ public
getMaxLength(mixed $field): int|nullGet field length from validation
Parameters
-
$field The dot separated path to the field you want to check.
Returns
int|nullgetRequiredMessage() ¶ public
getRequiredMessage(mixed $field): string|nullGets the default "required" error message for a field
Parameters
-
$field
Returns
string|nullgetTableLocator() ¶ public
getTableLocator(): Cake\ORM\Locator\LocatorInterfaceGets the table locator.
Returns
Cake\ORM\Locator\LocatorInterfacehasError() ¶ public
hasError(string $field): boolCheck whether or not a field has an error attached to it
Parameters
-
string$field A dot separated path to check errors on.
Returns
boolisCreate() ¶ public
isCreate(): boolCheck 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
boolisPrimaryKey() ¶ public
isPrimaryKey(string $field): boolReturns true if the passed field name is part of the primary key for this context
Parameters
-
string$field
Returns
boolisRequired() ¶ public
isRequired(string $field): boolCheck 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
boolprimaryKey() ¶ public
primaryKey(): arrayGet the primary key data for the context.
Gets the primary key columns from the root entity's schema.
Returns
arraysetTableLocator() ¶ public
setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $thisSets the table locator.
Parameters
-
Cake\ORM\Locator\LocatorInterface$tableLocator LocatorInterface instance.
Returns
$thistableLocator() ¶ public
tableLocator(Cake\ORM\Locator\LocatorInterface|null $tableLocator = null): Cake\ORM\Locator\LocatorInterfaceSets the table locator. If no parameters are passed, it will return the currently used locator.
Parameters
-
Cake\ORM\Locator\LocatorInterface|null$tableLocator optional LocatorInterface instance.
Returns
Cake\ORM\Locator\LocatorInterfacetype() ¶ public
type(string $field): null|stringGet the abstract field type for a given field name.
Parameters
-
string$field A dot separated path to get a schema type for.
Returns
null|stringSee Also
val() ¶ public
val(string $field, array $options = []): mixedGet 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$options optional Options:
default: Default value to return if no value found in request data or entity.schemaDefault: Boolean indicating whether default value from table schema should be used if it's not explicitly provided.
Returns
mixed