\Cake\View\FormNullContext

Provides a context provider that does nothing.

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

Summary

Methods

Properties

Constants

__construct()
primaryKey()
isPrimaryKey()
isCreate()
val()
isRequired()
getRequiredMessage()
getMaxLength()
fieldNames()
type()
attributes()
hasError()
error()

No public properties found

No constants found

No protected methods found

$_request

N/A

No private methods found

No private properties found

N/A

File: vendor/cakephp/cakephp/src/View/Form/NullContext.php
Package: Default
Class hierarchy: \Cake\View\Form\NullContext
Implements: \Cake\View\Form\ContextInterface

Properties

$_request

$_request : \Cake\Http\ServerRequest

The request object.

Type

\Cake\Http\ServerRequest

Methods

__construct()

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

Constructor.

Parameters

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

primaryKey()

primaryKey() : array

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

Returns

array

isPrimaryKey()

isPrimaryKey(string  $field) : boolean

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

isCreate()

isCreate() : boolean

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

Returns

boolean

val()

val(string  $field) : mixed

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

isRequired()

isRequired(string  $field) : boolean

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

getRequiredMessage()

getRequiredMessage(  $field)

{@inheritDoc}

Parameters

$field

getMaxLength()

getMaxLength(  $field)

{@inheritDoc}

Parameters

$field

fieldNames()

fieldNames() : array<mixed,string>

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

Returns

array<mixed,string> —

A list of the field names in the context.

type()

type(string  $field) : null|string

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.

attributes()

attributes(string  $field) : array

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.

hasError()

hasError(string  $field) : boolean

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.

error()

error(string  $field) : array

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.