On this page
Interface ContextInterface
Interface for FormHelper context implementations.
Direct Implementers
- Cake\View\Form\ArrayContext
 - Cake\View\Form\EntityContext
 - Cake\View\Form\FormContext
 - Cake\View\Form\NullContext
 
Method Summary
- 
    attributes() publicGet an associative array of other attributes for a field name.
 - 
    error() publicGet the errors for a given field
 - 
    fieldNames() publicGet the fieldnames of the top level object in this context.
 - 
    hasError() publicCheck whether or not a field has an error attached to it
 - 
    isCreate() publicReturns whether or not this form is for a create operation.
 - 
    isPrimaryKey() publicReturns true if the passed field name is part of the primary key for this context
 - 
    isRequired() publicCheck if a given field is 'required'.
 - 
    primaryKey() publicGet the fields used in the context as a primary key.
 - 
    type() publicGet the abstract field type for a given field name.
 - 
    val() publicGet the current value for a given field.
 
Method Detail
attributes()source 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
arrayAn array of data describing the additional attributes on a field.
error()source public
error( string $field )
   Get the errors for a given field
Parameters
- 
     string 
$field - A dot separated path to check errors on.
 
Returns
arrayAn array of errors, an empty array will be returned when the context has no errors.
fieldNames()source public
fieldNames( )
   Get the fieldnames of the top level object in this context.
Returns
arrayA list of the field names in the context.
hasError()source 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
booleanReturns true if the errors for the field are not empty.
isCreate()source public
isCreate( )
   Returns whether or not this form is for a create operation.
Returns
booleanisPrimaryKey()source 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
booleanisRequired()source 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
booleanprimaryKey()source public
primaryKey( )
   Get the fields used in the context as a primary key.
Returns
arraytype()source 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|stringAn abstract data type or null.
See
Cake\Database\Typeval()source 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
mixed© 2005–2017 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.
 https://api.cakephp.org/3.3/class-Cake.View.Form.ContextInterface.html