Class FormContext
Provides a context provider for Cake\Form\Form instances.
This context provider simply fulfils the interface requirements that FormHelper has and allows access to the request data.
Property Summary
-
$_request protected
Cake\Network\RequestThe request object.
Method Summary
-
__construct() public
Constructor.
-
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 fieldnames of the top level object in this context.
-
hasError() public
Check whether or not a field has an error attached to it
-
isCreate() public
Returns whether or not 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'.
-
primaryKey() public
Get the fields used in the context as a primary key.
-
type() public
Get the abstract field type for a given field name.
-
val() public
Get the current value for a given field.
Method Detail
__construct() ¶ public
__construct(Cake\Network\Request $request, array $context)Constructor.
Parameters
-
Cake\Network\Request$request The request object.
-
array$context Context info.
attributes() ¶ public
attributes(string $field): arrayGet an associative array of other attributes for a field name.
Parameters
-
string$field
Returns
arrayerror() ¶ public
error(string $field): arrayGet the errors for a given field
Parameters
-
string$field
Returns
arrayfieldNames() ¶ public
fieldNames(): arrayGet the fieldnames of the top level object in this context.
Returns
arrayhasError() ¶ public
hasError(string $field): boolCheck whether or not a field has an error attached to it
Parameters
-
string$field
Returns
boolisCreate() ¶ public
isCreate(): boolReturns whether or not this form is for a create operation.
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 given field is 'required'.
In this context class, this is simply defined by the 'required' array.
Parameters
-
string$field
Returns
boolprimaryKey() ¶ public
primaryKey(): arrayGet the fields used in the context as a primary key.
Returns
arraytype() ¶ public
type(string $field): null|stringGet the abstract field type for a given field name.
Parameters
-
string$field
Returns
null|stringval() ¶ public
val(string $field): mixedGet the current value for a given field.
Parameters
-
string$field
Returns
mixed