Interface ContextInterface
Interface for FormHelper context implementations.
Direct Implementers
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. -
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 )
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.
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.
fieldNames() public ¶
fieldNames( )
Get the fieldnames of the top level object in this context.
Returns
A list of the field names in the context.
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.
isCreate() public ¶
isCreate( )
Returns whether or not this form is for a create operation.
Returns
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
isRequired() public ¶
isRequired( string $field )
Check 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
primaryKey() public ¶
primaryKey( )
Get the fields used in the context as a primary key.
Returns
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.
See
val() public ¶
val( string $field )
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
A dot separated path to the field a value is needed for.
Returns
Magic methods summary
getMaxLength() public ¶
getMaxLength( $field )
Get maximum length of a field from model validation
Parameters
- $field
Returns
getRequiredMessage() public ¶
getRequiredMessage( $field )
Gets the default "required" error message for a field
Parameters
- $field