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.

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.

Returns an HTML FORM element.

Options:

• type Form method defaults to POST
• action The Action the form submits to. Can be a string or array,
• url The url the form submits to. Can be a string or a url array,
• default Allows for the creation of Ajax forms.
• 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')

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.

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.

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"

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

will get used as html attributes for error container

Extracts a single option from an options array.

Creates file input widget.

Creates a hidden input field.

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.

Sets field defaults and adds field to form security input hash

Options

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

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

• 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.

Generate a label for an input() call.

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')
    ));

Introspects model information and extracts information related to validation, field length and field type. Appends information into $this->fieldset.

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

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

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

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.

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.

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.

Gets the input field name for the current tag

Creates a password input widget.

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

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

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.

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.

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.

Creates a text input widget.

Creates a textarea widget.

Options:

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

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'