Class FormHelper

Form helper library.

Automatic generation of HTML FORMs from given data.

Object

Helper

AppHelper

FormHelper

Package: Cake\View\Helper
Link: http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html
Copyright: Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/View/Helper/FormHelper.php

Constants summary

string

SECURE_SKIP ¶

'skip'

Properties summary

$_inputDefaults protected

array

Persistent default options used by input(). Set by FormHelper::create().
$_models protected

array

Holds the model references already loaded by this helper product of trying to inspect them out of field names
$_options protected

array

Options used by DateTime fields
$_unlockedFields protected

array

An array of field names that have been excluded from the Token hash used by SecurityComponent's validatePost method
$defaultModel public

string

The default model being used for the current form.
$fields public

array

List of fields created, used with secure forms.
$helpers public

array

Other helpers used by FormHelper
$requestType public

string

Defines the type of form being created. Set by FormHelper::create().
$validationErrors public

array

Holds all the validation errors for models loaded and inspected it can also be set manually to be able to display custom error messages in the any of the input fields generated by this helper

Magic properties summary

$Html public

HtmlHelper

Inherited Properties

_View, _association, _cleaned, _entityPath, _fieldSuffixes, _helperMap, _modelScope, _tainted, fieldset, plugin, request, tags, theme

Method Summary

__call() public

Missing method handler - implements various simple input types. Is used to create inputs of various types. e.g. $this->Form->text(); will create <input type="text" /> while $this->Form->range(); will create <input type="range" />
__construct() public

Copies the validationErrors variable from the View object into this instance
_csrfField() protected

Return a CSRF input if the _Token is present. Used to secure forms in conjunction with SecurityComponent
_dateTimeSelected() protected

Selects values for dateTime selects.
_extractOption() protected

Extracts a single option from an options array.
_generateOptions() protected

Generates option lists for common menus

Parameters

string $name

array $options optional array()

Returns

array

_getModel() protected ¶

_getModel( string $model )

Guess the location for a model based on its name and tries to create a new instance or get an already created instance of the model

Parameters

string $model

Returns

Model
model instance

_initInputField() protected ¶

_initInputField( string $field , array $options = array() )

Sets field defaults and adds field to form security input hash

Options

secure - boolean whether or not the field should be added to the security fields.

Parameters

string $field: Name of the field to initialize options for.
array $options optional array(): Array of options to append options into.

Returns

array
Array of options for the input.

Overrides

Helper::_initInputField()

_inputLabel() protected ¶

_inputLabel( string $fieldName , string $label , array $options )

Generate a label for an input() call.

Parameters

string $fieldName
string $label
array $options: Options for the label element.

Returns

string
Generated label element

_introspectModel() protected ¶

_introspectModel( string $model , string $key , string $field = null )

Inspects the model properties to extract information from them. Currently it can extract information from the the fields, the primary key and required fields

The $key parameter accepts the following list of values:

key: Returns the name of the primary key for the model
fields: Returns the model schema
- validates: returns the list of fields that are required
errors: returns the list of validation errors

If the $field parameter is passed if will return the information for that sole field.

$this->_introspectModel('Post', 'fields', 'title'); will return the schema information for title column

Parameters

string $model: name of the model to extract information from
string $key: name of the special information key to obtain (key, fields, validates, errors)
string $field optional null: name of the model field to get information from

Returns

mixed
information extracted for the special key and field in a model

_isRequiredField() protected ¶

_isRequiredField( array $validateProperties )

Returns if a field is required to be filled based on validation properties from the validating object.

Parameters

array $validateProperties

Returns

boolean
true if field is required to be filled, false otherwise

_name() protected ¶

_name( array $options = array() , string $field = null , string $key = 'name' )

Gets the input field name for the current tag

Parameters

array $options optional array()
string $field optional null
string $key optional 'name'

Returns

array

Overrides

Helper::_name()

_secure() protected ¶

_secure( boolean $lock , mixed $field = null , mixed $value = null )

Determine which fields of a form should be used for hash. Populates $this->fields

Parameters

boolean $lock: Whether this field should be part of the validation or excluded as part of the unlockedFields.
mixed $field optional null: Reference to field to be secured. Should be dot separated to indicate nesting.
mixed $value optional null: Field value, if value should not be tampered with.

_selectOptions() protected ¶

_selectOptions( array $elements = array() , array $parents = array() , boolean $showParents = null , array $attributes = array() )

Returns an array of formatted OPTION/OPTGROUP elements

Parameters

array $elements optional array()
array $parents optional array()
boolean $showParents optional null
array $attributes optional array()

Returns

array

button() public ¶

button( string $title , array $options = array() )

Creates a <button> tag. The type attribute defaults to type="submit" You can change it to a different value by using $options['type'].

Options:

escape - HTML entity encode the $title of the button. Defaults to false.

Parameters

string $title: The button's caption. Not automatically HTML encoded
array $options optional array(): Array of options and HTML attributes.

Returns

string
A HTML button tag.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::button

checkbox() public ¶

checkbox( string $fieldName , array $options = array() )

Creates a checkbox input widget.

Options:

value - the value of the checkbox
checked - boolean indicate that this checkbox is checked.
hiddenField - boolean to indicate if you want the results of checkbox() to include a hidden input with a value of ''.
disabled - create a disabled input.
default - Set the default value for the checkbox. This allows you to start checkboxes as checked, without having to check the POST data. A matching POST data value, will overwrite the default value.

Parameters

string $fieldName: Name of a field, like this "Modelname.fieldname"
array $options optional array(): Array of HTML attributes.

Returns

string
An HTML text input element.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs

create() public ¶

create( string $model = null , array $options = array() )

Returns an HTML FORM element.

Options:

type Form method defaults to POST
action The controller action the form submits to, (optional).
url The url the form submits to. Can be a string or a url array. If you use 'url' you should leave 'action' undefined.
default Allows for the creation of Ajax forms. Set this to false to prevent the default event handler. Will create an onsubmit attribute if it doesn't not exist. If it does, default action suppression will be appended.
onsubmit Used in conjunction with 'default' to create ajax forms.
inputDefaults set the default $options for FormHelper::input(). Any options that would be set when using FormHelper::input() can be set here. Options set with inputDefaults can be overridden when calling input()
encoding Set the accept-charset encoding for the form. Defaults to Configure::read('App.encoding')

Parameters

string $model optional null: The model object which the form is being defined for. Should include the plugin name for plugin forms. e.g. ContactManager.Contact.
array $options optional array(): An array of html attributes and options.

Returns

string
An formatted opening FORM tag.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-create

dateTime() public ¶

dateTime( string $fieldName , string $dateFormat = 'DMY' , string $timeFormat = '12' , string $attributes = array() )

Returns a set of SELECT elements for a full datetime setup: day, month and year, and then time.

Attributes:

monthNames If false, 2 digit numbers will be used instead of text. If a array, the given array will be used.
minYear The lowest year to use in the year select
maxYear The maximum year to use in the year select
interval The interval for the minutes select. Defaults to 1
separator The contents of the string between select elements. Defaults to '-'
empty - If true, the empty select option is shown. If a string, that string is displayed as the empty element.
value | default The default value to be used by the input. A value in $this->data matching the field name will override this value. If no default is provided time() will be used.

Parameters

string $fieldName: Prefix name for the SELECT element
string $dateFormat optional 'DMY': DMY, MDY, YMD.
string $timeFormat optional '12': 12, 24.
string $attributes optional array(): array of Attributes

Returns

string
Generated set of select boxes for the date and time formats chosen.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::dateTime

day() public ¶

day( string $fieldName = null , array $attributes = array() )

Returns a SELECT element for days.

Attributes:

empty - If true, the empty select option is shown. If a string, that string is displayed as the empty element.
value The selected value of the input.

Parameters

string $fieldName optional null: Prefix name for the SELECT element
array $attributes optional array(): HTML attributes for the select element

Returns

string
A generated day select box.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::day

end() public ¶

end( mixed $options = null )

Closes an HTML form, cleans up values set by FormHelper::create(), and writes hidden input fields where appropriate.

If $options is set a form submit button will be created. Options can be either a string or an array.

{{{ array usage:

array('label' => 'save'); value="save" array('label' => 'save', 'name' => 'Whatever'); value="save" name="Whatever" array('name' => 'Whatever'); value="Submit" name="Whatever" array('label' => 'save', 'name' => 'Whatever', 'div' => 'good')

div class="good"> value="save" name="Whatever" array('label' => 'save', 'name' => 'Whatever', 'div' => array('class' => 'good'));

div class="good"> value="save" name="Whatever" }}}

Parameters

mixed $options optional null: as a string will use $options as the value of button,

Returns

string
a closing FORM tag optional submit button.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#closing-the-form

error() public ¶

error( string $field , mixed $text = null , array $options = array() )

Returns a formatted error message for given FORM field, NULL if no errors.

Options:

escape bool Whether or not to html escape the contents of the error.
wrap mixed Whether or not the error message should be wrapped in a div. If a string, will be used as the HTML tag to use.
class string The classname for the error message

Parameters

string $field: A field name, like "Modelname.fieldname"
mixed $text optional null: Error message as string or array of messages. If array contains attributes key it will be used as options for error container
array $options optional array(): Rendering options for

wrapper tag

Returns

string
If there are errors this method returns an error message, otherwise null.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::error

file() public ¶

file( string $fieldName , array $options = array() )

Creates file input widget.

Parameters

string $fieldName: Name of a field, in the form "Modelname.fieldname"
array $options optional array(): Array of HTML attributes.

Returns

string
A generated file input.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::file

hidden() public ¶

hidden( string $fieldName , array $options = array() )

Creates a hidden input field.

Parameters

string $fieldName: Name of a field, in the form of "Modelname.fieldname"
array $options optional array(): Array of HTML attributes.

Returns

string
A generated hidden input

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::hidden

hour() public ¶

hour( string $fieldName , boolean $format24Hours = false , array $attributes = array() )

Returns a SELECT element for hours.

Attributes:

empty - If true, the empty select option is shown. If a string, that string is displayed as the empty element.
value The selected value of the input.

Parameters

string $fieldName: Prefix name for the SELECT element
boolean $format24Hours optional false: True for 24 hours format
array $attributes optional array(): List of HTML attributes

Returns

string
Completed hour select input

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::hour

input() public ¶

input( string $fieldName , array $options = array() )

Generates a form input element complete with label and wrapper div

Options

See each field type method for more information. Any options that are part of $attributes or $options for the different type methods can be included in $options for input().i Additionally, any unknown keys that are not in the list below, or part of the selected type's options will be treated as a regular html attribute for the generated input.

type - Force the type of widget you want. e.g. type => 'select'
label - Either a string label, or an array of options for the label. See FormHelper::label()
div - Either false to disable the div, or an array of options for the div. See HtmlHelper::div() for more options.
options - for widgets that take options e.g. radio, select
error - control the error message that is produced
empty - String or boolean to enable empty select box options.
before - Content to place before the label + input.
after - Content to place after the label + input.
between - Content to place between the label + input.
format - format template for element order. Any element that is not in the array, will not be in the output.
Default input format order: array('before', 'label', 'between', 'input', 'after', 'error')
Default checkbox format order: array('before', 'input', 'between', 'label', 'after', 'error')
Hidden input will not be formatted
Radio buttons cannot have the order of input and label elements controlled with these settings.

Parameters

string $fieldName: This should be "Modelname.fieldname"
array $options optional array(): Each type of input takes different options.

Returns

string
Completed form widget.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#creating-form-elements

inputs() public ¶

inputs( mixed $fields = null , array $blacklist = null )

Generate a set of inputs for $fields. If $fields is null the current model will be used.

In addition to controller fields output, $fields can be used to control legend and fieldset rendering with the fieldset and legend keys. $form->inputs(array('legend' => 'My legend')); Would generate an input set with a custom legend. You can customize individual inputs through $fields as well.

{{{ $form->inputs(array( 'name' => array('label' => 'custom label') )); }}}

In addition to fields control, inputs() allows you to use a few additional options.

fieldset Set to false to disable the fieldset. If a string is supplied it will be used as the classname for the fieldset element.
legend Set to false to disable the legend for the generated input set. Or supply a string to customize the legend text.

Parameters

mixed $fields optional null: An array of fields to generate inputs for, or null.
array $blacklist optional null: a simple array of fields to not create inputs for.

Returns

string
Completed form inputs.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::inputs

isFieldError() public ¶

isFieldError( string $field )

Returns true if there is an error for the given field, otherwise false

Parameters

string $field: This should be "Modelname.fieldname"

Returns

boolean
If there are errors this method returns true, else false.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::isFieldError

label() public ¶

label( string $fieldName = null , string $text = null , mixed $options = array() )

Returns a formatted LABEL element for HTML FORMs. Will automatically generate a for attribute if one is not provided.

Options

for - Set the for attribute, if its not defined the for attribute will be generated from the $fieldName parameter using FormHelper::domId().

Examples:

The text and for attribute are generated off of the fieldname

{{{ echo $this->Form->label('Post.published'); Published }}}

Custom text:

{{{ echo $this->Form->label('Post.published', 'Publish'); Publish }}}

Custom class name:

{{{ echo $this->Form->label('Post.published', 'Publish', 'required'); Publish }}}

Custom attributes:

{{{ echo $this->Form->label('Post.published', 'Publish', array( 'for' => 'post-publish' )); Publish }}}

Parameters

string $fieldName optional null: This should be "Modelname.fieldname"
string $text optional null: Text that will appear in the label field. If $text is left undefined the text will be inflected from the fieldName.
mixed $options optional array(): An array of HTML attributes, or a string, to be used as a class name.

Returns

string
The formatted LABEL element

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::label

meridian() public ¶

meridian( string $fieldName , string $attributes = array() )

Returns a SELECT element for AM or PM.

Attributes:

empty - If true, the empty select option is shown. If a string, that string is displayed as the empty element.
value The selected value of the input.

Parameters

string $fieldName: Prefix name for the SELECT element
string $attributes optional array(): Array of Attributes

Returns

string
Completed meridian select input

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::meridian

minute() public ¶

minute( string $fieldName , string $attributes = array() )

Returns a SELECT element for minutes.

Attributes:

empty - If true, the empty select option is shown. If a string, that string is displayed as the empty element.
value The selected value of the input.

Parameters

string $fieldName: Prefix name for the SELECT element
string $attributes optional array(): Array of Attributes

Returns

string
Completed minute select input.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::minute

month() public ¶

month( string $fieldName , array $attributes = array() )

Returns a SELECT element for months.

Attributes:

monthNames - If false, 2 digit numbers will be used instead of text. If a array, the given array will be used.
empty - If true, the empty select option is shown. If a string, that string is displayed as the empty element.
value The selected value of the input.

Parameters

string $fieldName: Prefix name for the SELECT element
array $attributes optional array(): Attributes for the select element

Returns

string
A generated month select dropdown.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::month

postButton() public ¶

postButton( string $title , mixed $url , array $options = array() )

Create a <button> tag with a surrounding <form> that submits via POST.

This method creates a <form> element. So do not use this method in some opened form. Instead use FormHelper::submit() or FormHelper::button() to create buttons inside opened forms.

Options:

data - Array with key/value to pass in input hidden
Other options is the same of button method.

Parameters

string $title: The button's caption. Not automatically HTML encoded
mixed $url: URL as string or array
array $options optional array(): Array of options and HTML attributes.

Returns

string
A HTML button tag.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::postButton

postLink() public ¶

postLink( string $title , mixed $url = null , array $options = array() , string $confirmMessage = false )

Creates an HTML link, but access the url using method POST. Requires javascript to be enabled in browser.

This method creates a <form> element. So do not use this method inside an existing form. Instead you should add a submit button using FormHelper::submit()

Options:

data - Array with key/value to pass in input hidden
confirm - Can be used instead of $confirmMessage.
Other options is the same of HtmlHelper::link() method.
The option onclick will be replaced.

radio() public ¶

radio( string $fieldName , array $options = array() , array $attributes = array() )

Creates a set of radio widgets. Will create a legend and fieldset by default. Use $options to control this

Attributes:

separator - define the string in between the radio buttons
legend - control whether or not the widget set has a fieldset & legend
value - indicate a value that is should be checked
label - boolean to indicate whether or not labels for widgets show be displayed
hiddenField - boolean to indicate if you want the results of radio() to include a hidden input with a value of ''. This is useful for creating radio sets that non-continuous

Parameters

string $fieldName: Name of a field, like this "Modelname.fieldname"
array $options optional array(): Radio button options array.
array $attributes optional array(): Array of HTML attributes, and special attributes above.

Returns

string
Completed radio widget set.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs

secure() public ¶

secure( array $fields = array() )

Generates a hidden field with a security hash based on the fields used in the form.

Parameters

array $fields optional array(): The list of fields to use when generating the hash

Returns

string
A hidden input field with a security hash

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::secure

select() public ¶

select( string $fieldName , array $options = array() , array $attributes = array() )

Returns a formatted SELECT element.

Attributes:

showParents - If included in the array and set to true, an additional option element will be added for the parent of each option group. You can set an option with the same name and it's key will be used for the value of the option.
multiple - show a multiple select box. If set to 'checkbox' multiple checkboxes will be created instead.
empty - If true, the empty select option is shown. If a string, that string is displayed as the empty element.
escape - If true contents of options will be HTML entity encoded. Defaults to true.
value The selected value of the input.
class - When using multiple = checkbox the classname to apply to the divs. Defaults to 'checkbox'.

Using options

A simple array will create normal options:

{{{ $options = array(1 => 'one', 2 => 'two); $this->Form->select('Model.field', $options)); }}}

While a nested options array will create optgroups with options inside them. {{{ $options = array( 1 => 'bill', 'fred' => array( 2 => 'fred', 3 => 'fred jr.' ) ); $this->Form->select('Model.field', $options); }}}

In the above 2 => 'fred' will not generate an option element. You should enable the showParents attribute to show the fred option.

If you have multiple options that need to have the same value attribute, you can use an array of arrays to express this:

{{{ $options = array( array('name' => 'United states', 'value' => 'USA'), array('name' => 'USA', 'value' => 'USA'), ); }}}

Parameters

string $fieldName: Name attribute of the SELECT
array $options optional array(): Array of the OPTION elements (as 'value'=>'Text' pairs) to be used in the SELECT element
array $attributes optional array(): The HTML attributes of the select element.

Returns

string
Formatted SELECT element

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs

submit() public ¶

submit( string $caption = null , array $options = array() )

Creates a submit button element. This method will generate <input /> elements that can be used to submit, and reset forms by using $options. image submits can be created by supplying an image path for $caption.

Options

div - Include a wrapping div? Defaults to true. Accepts sub options similar to FormHelper::input().
before - Content to include before the input.
after - Content to include after the input.
type - Set to 'reset' for reset inputs. Defaults to 'submit'
Other attributes will be assigned to the input element.

Options

div - Include a wrapping div? Defaults to true. Accepts sub options similar to FormHelper::input().
Other attributes will be assigned to the input element.

Parameters

string $caption optional null: The label appearing on the button OR if string contains :// or the extension .jpg, .jpe, .jpeg, .gif, .png use an image if the extension exists, AND the first character is /, image is relative to webroot, OR if the first character is not /, image is relative to webroot/img.
array $options optional array(): Array of options. See above.

Returns

string
A HTML submit button

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::submit

tagIsInvalid() public ¶

tagIsInvalid( )

Returns false if given form field described by the current entity has no errors. Otherwise it returns the validation message

Returns

mixed

Either false when there or no errors, or the error string. The error string could be ''.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::tagIsInvalid

textarea() public ¶

textarea( string $fieldName , array $options = array() )

Creates a textarea widget.

Options:

escape - Whether or not the contents of the textarea should be escaped. Defaults to true.

Parameters

string $fieldName: Name of a field, in the form "Modelname.fieldname"
array $options optional array(): Array of HTML attributes, and special options above.

Returns

string
A generated HTML text input element

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::textarea

unlockField() public ¶

unlockField( string $name = null )

Add to or get the list of fields that are currently unlocked. Unlocked fields are not included in the field hash used by SecurityComponent unlocking a field once its been added to the list of secured fields will remove it from the list of fields.

Parameters

string $name optional null: The dot separated name for the field.

Returns

mixed
Either null, or the list of fields.

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::unlockField

year() public ¶

year( string $fieldName , integer $minYear = null , integer $maxYear = null , array $attributes = array() )

Returns a SELECT element for years

Attributes:

empty - If true, the empty select option is shown. If a string, that string is displayed as the empty element.
orderYear - Ordering of year values in select options. Possible values 'asc', 'desc'. Default 'desc'
value The selected value of the input.

Parameters

string $fieldName: Prefix name for the SELECT element
integer $minYear optional null: First year in sequence
integer $maxYear optional null: Last year in sequence
array $attributes optional array(): Attribute array for the select elements.

Returns

string
Completed year select input

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::year

Packages

Classes

Class FormHelper

Constants summary

Properties summary

Magic properties summary

Inherited Properties

Method Summary

__call() public

__construct() public

_csrfField() protected

_dateTimeSelected() protected

_extractOption() protected

_generateOptions() protected

Parameters

Returns

_getModel() protected ¶

Parameters

Returns

_initInputField() protected ¶

Options

Parameters

Returns

Overrides

_inputLabel() protected ¶

Parameters

Returns

_introspectModel() protected ¶

Parameters

Returns

_isRequiredField() protected ¶

Parameters

Returns

_name() protected ¶

Parameters

Returns

Overrides

_secure() protected ¶

Parameters

_selectOptions() protected ¶

Parameters

Returns

button() public ¶

Options:

Parameters

Returns

Link

checkbox() public ¶

Options:

Parameters

Returns

Link

create() public ¶

Options:

Parameters

Returns

Link

dateTime() public ¶

Attributes:

Parameters

Returns

Link

day() public ¶

Attributes:

Parameters

Returns

Link

end() public ¶

Parameters

Returns

Link

error() public ¶

Options:

Parameters

Returns

Link

file() public ¶

Parameters

Returns

Link