Interface ContextInterface
Interface for FormHelper context implementations.
Direct known implementers
Cake\View\Form\ArrayContext, Cake\View\Form\EntityContext, Cake\View\Form\FormContext, Cake\View\Form\NullContextMethod Detail
attributessource 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
array
An array of data describing the additional attributes on a field.
errorsource public
error( string $field )
Get the errors for a given field
Parameters
- string
$field
- A dot separated path to check errors on.
Returns
array
An array of errors, an empty array will be returned when the context has no errors.
fieldNamessource public
fieldNames( )
Get the fieldnames of the top level object in this context.
Returns
array
A list of the field names in the context.
hasErrorsource 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
boolean
Returns true if the errors for the field are not empty.
isCreatesource public
isCreate( )
Returns whether or not this form is for a create operation.
Returns
boolean
bool
isPrimaryKeysource 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
boolean
bool
isRequiredsource 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
boolean
bool
primaryKeysource public
primaryKey( )
Get the fields used in the context as a primary key.
Returns
array
array
typesource 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
null|string
An abstract data type or null.
See
Cake\Database\Type
valsource public
val( string $field )
Get the current value for a given field.
Parameters
- string
$field
- A dot separated path to the field a value is needed for.
Returns
mixed
mixed
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.View.Form.ContextInterface.html