W3cubDocs

/CakePHP 3.8

Class FormContext

Provides a context provider for Cake\Form\Form instances.

This context provider simply fulfils the interface requirements that FormHelper has and allows access to the request data.

Cake\View\Form\FormContext implements Cake\View\Form\ContextInterface
Namespace: Cake\View\Form
Location: View/Form/FormContext.php

Properties summary

Method Summary

  • __construct() public
    Constructor.
  • _schemaDefault() protected
    Get default value from form schema for given field.
  • 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.
  • 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()source public 

__construct( Cake\Http\ServerRequest $request , array $context )

Constructor.

Parameters

Cake\Http\ServerRequest $request
The request object.
array $context
Context info.

_schemaDefault()source protected 

_schemaDefault( string $field )

Get default value from form schema for given field.

Parameters

string $field
Field name.

Returns

mixed

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

array
An array of data describing the additional attributes on a field.

Implementation of

Cake\View\Form\ContextInterface::attributes()

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

array

An array of errors, an empty array will be returned when the context has no errors.


Implementation of

Cake\View\Form\ContextInterface::error()

fieldNames()source public 

fieldNames( )

Get the fieldnames of the top level object in this context.

Returns

string[]
A list of the field names in the context.

Implementation of

Cake\View\Form\ContextInterface::fieldNames()

getMaxLength()source public 

getMaxLength( $field )

getRequiredMessage()source public 

getRequiredMessage( $field )

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

boolean
Returns true if the errors for the field are not empty.

Implementation of

Cake\View\Form\ContextInterface::hasError()

isCreate()source public 

isCreate( )

Returns whether or not this form is for a create operation.

Returns

boolean

Implementation of

Cake\View\Form\ContextInterface::isCreate()

isPrimaryKey()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

boolean

Implementation of

Cake\View\Form\ContextInterface::isPrimaryKey()

isRequired()source public 

isRequired( string $field )

Check if a given field is 'required'.

Parameters

string $field
A dot separated path to check required-ness for.

Returns

boolean

Implementation of

Cake\View\Form\ContextInterface::isRequired()

primaryKey()source public 

primaryKey( )

Get the fields used in the context as a primary key.

Returns

array

Implementation of

Cake\View\Form\ContextInterface::primaryKey()

type()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|string
An abstract data type or null.

Implementation of

Cake\View\Form\ContextInterface::type()

val()source public 

val( string $field , $options = [] )

Get the current value for a given field.

Parameters

string $field

A dot separated path to the field a value is needed for.

$options optional []

Returns

mixed

Implementation of

Cake\View\Form\ContextInterface::val()

Magic methods inherited from Cake\View\Form\ContextInterface

getMaxLength(), getRequiredMessage()

Properties detail

$_formsource

protected Cake\Form\Form

The form object.

$_requestsource

protected Cake\Http\ServerRequest

The request object.

© 2005–present 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.8/class-Cake.View.Form.FormContext.html