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.
- Cake\View\Form\FormContext implements Cake\View\Form\ContextInterface
Properties summary
Method Summary
-
__construct() public
Constructor. -
_schemaDefault() protected
Get default value from form schema for given field. -
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. -
getMaxLength() public
-
getRequiredMessage() public
-
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\Http\ServerRequest $request , array $context )
Constructor.
Parameters
-
Cake\Http\ServerRequest$request - The request object.
- array $context
- Context info.
_schemaDefault() protected ¶
_schemaDefault( string $field )
Get default value from form schema for given field.
Parameters
- string $field
- Field name.
Returns
attributes() 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
An array of data describing the additional attributes on a field.
Implementation of
error() public ¶
error( string $field )
Get the errors for a given field
Parameters
- string $field
- A dot separated path to check errors on.
Returns
An array of errors, an empty array will be returned when the context has no errors.
Implementation of
fieldNames() public ¶
fieldNames( )
Get the fieldnames of the top level object in this context.
Returns
A list of the field names in the context.
Implementation of
hasError() 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
Returns true if the errors for the field are not empty.
Implementation of
isCreate() public ¶
isCreate( )
Returns whether or not this form is for a create operation.
Returns
Implementation of
isPrimaryKey() 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
Implementation of
isRequired() public ¶
isRequired( string $field )
Check if a given field is 'required'.
Parameters
- string $field
- A dot separated path to check required-ness for.
Returns
Implementation of
primaryKey() public ¶
primaryKey( )
Get the fields used in the context as a primary key.
Returns
Implementation of
type() 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
An abstract data type or null.
Implementation of
Magic methods inherited from Cake\View\Form\ContextInterface
getMaxLength(),
getRequiredMessage()
|