Class NullContext
Provides a context provider that does nothing.
This context provider simply fulfils the interface requirements that FormHelper has and allows access to the request data.
Property Summary
-
$_request protected
Cake\Http\ServerRequest
The 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\Http\ServerRequest $request, array $context)
Constructor.
Parameters
-
Cake\Http\ServerRequest
$request The request object.
-
array
$context Context info.
attributes() ¶ public
attributes(string $field): array
Get an associative array of other attributes for a field name.
Parameters
-
string
$field
Returns
array
error() ¶ public
error(string $field): array
Get the errors for a given field
Parameters
-
string
$field
Returns
array
fieldNames() ¶ public
fieldNames(): array
Get the fieldnames of the top level object in this context.
Returns
array
hasError() ¶ public
hasError(string $field): bool
Check whether or not a field has an error attached to it
Parameters
-
string
$field
Returns
bool
isCreate() ¶ public
isCreate(): bool
Returns whether or not this form is for a create operation.
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
Check if a given field is 'required'.
In this context class, this is simply defined by the 'required' array.
Parameters
-
string
$field
Returns
bool
primaryKey() ¶ public
primaryKey(): array
Get the fields used in the context as a primary key.
Returns
array
type() ¶ public
type(string $field): null|string
Get the abstract field type for a given field name.
Parameters
-
string
$field
Returns
null|string
val() ¶ public
val(string $field): mixed
Get the current value for a given field.
Classes implementing this method can optionally have a second argument
$options
. Valid key for $options
array are:
default
: Default value to return if no value found in request data or context record.schemaDefault
: Boolean indicating whether default value from context's schema should be used if it's not explicitly provided.
Parameters
-
string
$field
Returns
mixed