Interface ContextInterface
Interface for FormHelper context implementations.
Method Summary
-
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 @method
Get maximum length of a field from model validation
-
getRequiredMessage() public @method
Gets the default "required" error message for a field
-
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
attributes() ¶ 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
arrayerror() ¶ 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(): string[]Get the fieldnames of the top level object in this context.
Returns
string[]getMaxLength() ¶ public @method
getMaxLength(mixed $field): int|nullGet maximum length of a field from model validation
Parameters
-
$field
Returns
int|nullgetRequiredMessage() ¶ public @method
getRequiredMessage(mixed $field): string|nullGets the default "required" error message for a field
Parameters
-
$field
Returns
string|nullhasError() ¶ 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(): 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 A dot separated path to the field a value is needed for.
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 A dot separated path to check required-ness for.
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 A dot separated path to get a schema type for.
Returns
null|stringSee Also
val() ¶ public
val(string $field): mixedGet 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 A dot separated path to the field a value is needed for.
Returns
mixed