CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 1.3 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 1.3
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Classes

  • AclBase
  • AclBehavior
  • AclComponent
  • AclNode
  • AclShell
  • Aco
  • AcoAction
  • AjaxHelper
  • ApcEngine
  • ApiShell
  • App
  • AppController
  • AppHelper
  • AppModel
  • Aro
  • AuthComponent
  • BakeShell
  • BakeTask
  • BehaviorCollection
  • Cache
  • CacheEngine
  • CacheHelper
  • CakeErrorController
  • CakeLog
  • CakeRoute
  • CakeSchema
  • CakeSession
  • CakeSocket
  • ClassRegistry
  • Component
  • Configure
  • ConnectionManager
  • ConsoleShell
  • ContainableBehavior
  • Controller
  • ControllerTask
  • CookieComponent
  • DataSource
  • DbAcl
  • DbConfigTask
  • DboMssql
  • DboMysql
  • DboMysqlBase
  • DboMysqli
  • DboOracle
  • DboPostgres
  • DboSource
  • DboSqlite
  • Debugger
  • EmailComponent
  • ErrorHandler
  • ExtractTask
  • File
  • FileEngine
  • FileLog
  • FixtureTask
  • Folder
  • FormHelper
  • Helper
  • HtmlHelper
  • HttpSocket
  • I18n
  • I18nModel
  • I18nShell
  • Inflector
  • IniAcl
  • JavascriptHelper
  • JqueryEngineHelper
  • JsBaseEngineHelper
  • JsHelper
  • L10n
  • MagicDb
  • MagicFileResource
  • MediaView
  • MemcacheEngine
  • Model
  • ModelBehavior
  • ModelTask
  • MootoolsEngineHelper
  • Multibyte
  • NumberHelper
  • Object
  • Overloadable
  • Overloadable2
  • PagesController
  • PaginatorHelper
  • Permission
  • PluginShortRoute
  • PluginTask
  • ProjectTask
  • PrototypeEngineHelper
  • RequestHandlerComponent
  • Router
  • RssHelper
  • Sanitize
  • Scaffold
  • ScaffoldView
  • SchemaShell
  • Security
  • SecurityComponent
  • SessionComponent
  • SessionHelper
  • Set
  • Shell
  • String
  • TemplateTask
  • TestSuiteShell
  • TestTask
  • TextHelper
  • ThemeView
  • TimeHelper
  • TranslateBehavior
  • TreeBehavior
  • Validation
  • View
  • ViewTask
  • XcacheEngine
  • Xml
  • XmlElement
  • XmlHelper
  • XmlManager
  • XmlNode
  • XmlTextNode

Functions

  • mb_encode_mimeheader
  • mb_stripos
  • mb_stristr
  • mb_strlen
  • mb_strpos
  • mb_strrchr
  • mb_strrichr
  • mb_strripos
  • mb_strrpos
  • mb_strstr
  • mb_strtolower
  • mb_strtoupper
  • mb_substr
  • mb_substr_count

Class FormHelper

Form helper library.

Automatic generation of HTML FORMs from given data.

Object
Extended by Overloadable
Extended by Helper
Extended by AppHelper
Extended by FormHelper
Package: cake\cake\libs\view\helpers
Link: http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#Form
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: view/helpers/form.php

Properties summary

  • $__options public
    array
    Options used by DateTime fields
  • $_inputDefaults public
    array
    Persistent default options used by input(). Set by FormHelper::create().
  • $_lastAction public
    string

    The action attribute value of the last created form. Used to make form/request specific hashes for SecurityComponent.

  • $defaultModel public
    string
    The default model being used for the current form.
  • $fields public
    array
    List of fields created, used with secure forms.
  • $fieldset public
    array

    Holds the fields array('field_name' => array('type'=> 'string', 'length'=> 100), primaryKey and validates array('field_name')

  • $helpers public
    array
    Other helpers used by FormHelper
  • $requestType public
    string
    Defines the type of form being created. Set by FormHelper::create().

Inherited Properties

  • __cleaned, __tainted, action, argSeparator, base, data, here, namedArgs, params, plugin, tags, theme, validationErrors, webroot

Method Summary

  • __dateTimeSelected() public
    Selects values for dateTime selects.
  • __generateOptions() public
    Generates option lists for common menus

__secure() public ¶

__secure( mixed $field = null , mixed $value = null )

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

Parameters
mixed $field optional null
Reference to field to be secured
mixed $value optional null
Field value, if value should not be tampered with.

__selectOptions() public ¶

__selectOptions( $elements = array() , $selected = null , $parents = array() , $showParents = null , $attributes = array() )

Returns an array of formatted OPTION/OPTGROUP elements

Returns
array

_extractOption() public ¶

_extractOption( string $name , array $options , mixed $default = null )

Extracts a single option from an options array.

Parameters
string $name
The name of the option to pull out.
array $options
The array of options you want to extract.
mixed $default optional null
The default option value
Returns
the
contents of the option or default

_initInputField() public ¶

_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() public ¶

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

Generate a label for an input() call.

Parameters
array $fieldName
$options Options for the label element.
$label
$options
Returns
string
Generated label element

_introspectModel() public ¶

_introspectModel( $model )

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

Returns
Model
Returns a model instance

_isRequiredField() public ¶

_isRequiredField( $validateProperties )

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

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

_lastAction() public ¶

_lastAction( string|array $url )

Sets the last created form action.

Parameters
string|array $url
URL.

_name() public ¶

_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
$key
string $key optional 'name'
The name of the attribute to be set, defaults to 'name'
Returns
array
Overrides
Helper::_name()

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/1.3/en/The-Manual/Core-Helpers/Form.html#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.
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/1.3/en/The-Manual/Core-Helpers/Form.html#checkbox

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
array $options optional array()
An array of html attributes and options.
Returns
string
An formatted opening FORM tag.
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#Creating-Forms

dateTime() public ¶

dateTime( string $fieldName , string $dateFormat = 'DMY' , string $timeFormat = '12' , string $selected = null , 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 $selected optional null
Option which is selected.
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/1.3/en/The-Manual/Core-Helpers/Form.html#dateTime

day() public ¶

day( string $fieldName , string $selected = 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.
Parameters
string $fieldName
Prefix name for the SELECT element
string $selected optional null
Option which is selected.
array $attributes optional array()
HTML attributes for the select element
Returns
string
A generated day select box.
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#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/1.3/en/The-Manual/Core-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 or array of $options. If array, attributes key will get used as html attributes 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/1.3/en/The-Manual/Core-Helpers/Form.html#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/1.3/en/The-Manual/Core-Helpers/Form.html#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/1.3/en/The-Manual/Core-Helpers/Form.html#hidden

hour() public ¶

hour( string $fieldName , boolean $format24Hours = false , string $selected = null , 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.
Parameters
string $fieldName
Prefix name for the SELECT element
boolean $format24Hours optional false
True for 24 hours format
string $selected optional null
Option which is selected.
array $attributes optional array()
List of HTML attributes
Returns
string
Completed hour select input
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#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/1.3/en/The-Manual/Core-Helpers/Form.html#Automagic-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.

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/1.3/en/The-Manual/Core-Helpers/Form.html#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.

Parameters
string $fieldName optional null
This should be "Modelname.fieldname"
string $text optional null
Text that will appear in the label field.
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/1.3/en/The-Manual/Core-Helpers/Form.html#label

meridian() public ¶

meridian( string $fieldName , string $selected = null , string $attributes = array() , boolean $showEmpty ,… )

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.
Parameters
string $fieldName
Prefix name for the SELECT element
string $selected optional null
Option which is selected.
string $attributes optional array()
Array of Attributes
boolean $showEmpty ,…
Show/Hide an empty option
Returns
string
Completed meridian select input
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#meridian

minute() public ¶

minute( string $fieldName , string $selected = null , 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.
Parameters
string $fieldName
Prefix name for the SELECT element
string $selected optional null
Option which is selected.
string $attributes optional array()
Array of Attributes
Returns
string
Completed minute select input.
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#minute

month() public ¶

month( string $fieldName , string $selected = null , 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.
Parameters
string $fieldName
Prefix name for the SELECT element
string $selected optional null
Option which is selected.
array $attributes optional array()
Attributes for the select element
Returns
string
A generated month select dropdown.
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#month

password() public ¶

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

Creates a password input widget.

Parameters
string $fieldName
Name of a field, like in the form "Modelname.fieldname"
array $options optional array()
Array of HTML attributes.
Returns
string
A generated password input.
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#password

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/1.3/en/The-Manual/Core-Helpers/Form.html#radio

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

select() public ¶

select( string $fieldName , array $options = array() , mixed $selected = null , 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.
  • 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.

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

mixed $selected optional null

The option selected by default. If null, the default value from POST data will be used when available.

array $attributes optional array()
The HTML attributes of the select element.
Returns
string
Formatted SELECT element
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#select

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/1.3/en/The-Manual/Core-Helpers/Form.html#submit

text() public ¶

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

Creates a text 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 HTML text input element
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#text

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/1.3/en/The-Manual/Core-Helpers/Form.html#textarea

year() public ¶

year( string $fieldName , integer $minYear = null , integer $maxYear = null , string $selected = 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'
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
string $selected optional null
Option which is selected.
array $attributes optional array()
Attribute array for the select elements.
Returns
string
Completed year select input
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Form.html#year

Methods inherited from Helper

__clean() public ¶

__clean( )

Removes harmful content from output

__formatAttribute() public ¶

__formatAttribute( string $key , string $value , $escape = true )

Formats an individual attribute, and returns the string value of the composed attribute. Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'

Parameters
string $key
The name of the attribute to create
string $value
The value of the attribute to create.
$escape optional true
Returns
string
The composed attribute.

__reset() public ¶

__reset( )

Resets the vars used by Helper::clean() to null

__selectedArray() public ¶

__selectedArray( mixed $data , string $key = 'id' )

Transforms a recordset from a hasAndBelongsToMany association to a list of selected options for a multiple select element

Parameters
mixed $data
string $key optional 'id'
Returns
array

_parseAttributes() public ¶

_parseAttributes( array $options , array $exclude = null , string $insertBefore = ' ' , string $insertAfter = null )

Returns a space-delimited string with items of the $options array. If a key of $options array happens to be one of:

  • 'compact'
  • 'checked'
  • 'declare'
  • 'readonly'
  • 'disabled'
  • 'selected'
  • 'defer'
  • 'ismap'
  • 'nohref'
  • 'noshade'
  • 'nowrap'
  • 'multiple'
  • 'noresize'

And its value is one of:

  • '1' (string)
  • 1 (integer)
  • true (boolean)
  • 'true' (string)

Then the value will be reset to be identical with key's name. If the value is not one of these 3, the parameter is not output.

'escape' is a special option in that it controls the conversion of attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.

If value for any option key is set to null or false, that option will be excluded from output.

Parameters
array $options
Array of options.
array $exclude optional null
Array of options to be excluded, the options here will not be part of the return.
string $insertBefore optional ' '
String to be inserted before options.
string $insertAfter optional null
String to be inserted after options.
Returns
string
Composed attributes.

addClass() public ¶

addClass( array $options = array() , string $class = null , string $key = 'class' )

Adds the given class to the element options

Parameters
array $options optional array()
Array options/attributes to add a class to
string $class optional null
The classname being added.
string $key optional 'class'
the key to use for class.
Returns
array
Array of options with $key set.

afterLayout() public ¶

afterLayout( )

After layout callback. afterLayout is called after the layout has rendered.

Overridden in subclasses.

afterRender() public ¶

afterRender( )

After render callback. afterRender is called after the view file is rendered but before the layout has been rendered.

Overridden in subclasses.

assetTimestamp() public ¶

assetTimestamp( string $path )

Adds a timestamp to a file based resource based on the value of Asset.timestamp in Configure. If Asset.timestamp is true and debug > 0, or Asset.timestamp == 'force' a timestamp will be added.

Parameters
string $path
The file path to timestamp, the path must be inside WWW_ROOT
Returns
string
Path with a timestamp added, or not.

beforeLayout() public ¶

beforeLayout( )

Before layout callback. beforeLayout is called before the layout is rendered.

Overridden in subclasses.

beforeRender() public ¶

beforeRender( )

Before render callback. beforeRender is called before the view file is rendered.

Overridden in subclasses.

call__() public ¶

call__( $method , $params )

clean() public ¶

clean( mixed $output )

Used to remove harmful tags from content. Removes a number of well known XSS attacks from content. However, is not guaranteed to remove all possiblities. Escaping content is the best way to prevent all possible attacks.

Parameters
mixed $output
Either an array of strings to clean or a single string to clean.
Returns
cleaned
content for output

domId() public ¶

domId( mixed $options = null , string $id = 'id' )

Generates a DOM ID for the selected element, if one is not set. Uses the current View::entity() settings to generate a CamelCased id attribute.

Parameters
mixed $options optional null

Either an array of html attributes to add $id into, or a string with a view entity path to get a domId for.

string $id optional 'id'
The name of the 'id' attribute.
Returns
mixed

If $options was an array, an array will be returned with $id set. If a string was supplied, a string will be returned.


field() public ¶

field( )

Gets the currently-used model field of the rendering context.

Returns
string

get__() public ¶

get__( $name )

Default overload methods

loadConfig() public ¶

loadConfig( $name = 'tags' )

Parses tag templates into $this->tags.

Parameters
$name optional 'tags'
name inside app/config to load.
Returns
array
merged tags from config/$name.php

model() public ¶

model( )

Gets the currently-used model of the rendering context.

Returns
string

modelID() public ¶

modelID( )

Gets the ID of the currently-used model of the rendering context.

Returns
mixed

output() public deprecated ¶

output( string $str )

Returns a string generated by a helper method

This method can be overridden in subclasses to do generalized output post-processing

Deprecated
This method will be removed in future versions.
Parameters
string $str
String to be output.
Returns
string

setEntity() public ¶

setEntity( mixed $entity , boolean $setScope = false )

Sets this helper's model and field properties to the dot-separated value-pair in $entity.

Parameters
mixed $entity
A field name, like "ModelName.fieldName" or "ModelName.ID.fieldName"
boolean $setScope optional false
Sets the view scope to the model specified in $tagValue

set__() public ¶

set__( $name , $value )

tagIsInvalid() public ¶

tagIsInvalid( string $model = null , string $field = null , integer $modelID = null )

Returns null if given FORM field has no errors. Otherwise it returns the constant set in the array Model->validationErrors.

Parameters
string $model optional null
Model name as a string
string $field optional null
Fieldname as a string
integer $modelID optional null
Unique index identifying this record within the form
Returns
mixed
Null if no errors, string with error otherwhise.

url() public ¶

url( mixed $url = null , boolean $full = false )

Finds URL for specified action.

Returns a URL pointing at the provided parameters.

Parameters
mixed $url optional null

Either a relative string url like /products/view/23 or an array of url parameters. Using an array for urls will allow you to leverage the reverse routing features of CakePHP.

boolean $full optional false
If true, the full base URL will be prepended to the result
Returns
string
Full translated URL with base path.
Link
http://book.cakephp.org/view/1448/url

value() public ¶

value( mixed $options = array() , string $field = null , string $key = 'value' )

Gets the data for the current tag

Parameters
mixed $options optional array()

If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.

string $field optional null
string $key optional 'value'
The name of the attribute to be set, defaults to 'value'
Returns
mixed

If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.


webroot() public ¶

webroot( string $file )

Checks if a file exists when theme is used, if no file is found default location is returned

Parameters
string $file
The file to create a webroot path to.
Returns
string
Web accessible path to file.

Methods inherited from Overloadable

__call() public ¶

__call( string $method , array $params )

Magic method handler.

Parameters
string $method
Method name
array $params
Parameters to send to method
Returns
mixed
Return value from method

overload() public ¶

overload( )

Overload implementation. No need for implementation in PHP5.

Methods inherited from Object

Object() public ¶

Object( )

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns
Object

__construct() public ¶

__construct( )

Class constructor, overridden in descendant classes.

__openPersistent() public ¶

__openPersistent( string $name , string $type = null )

Open the persistent class file for reading Used by Object::_persist()

Parameters
string $name
Name of persisted class
string $type optional null
Type of persistance (e.g: registry)

_persist() public ¶

_persist( string $name , string $return , $object , $type = null )

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters
string $name
name of the class to persist
string $return
$object the object to persist
$object
$type optional null
Returns
boolean
Success

_savePersistent() public ¶

_savePersistent( string $name , object $object )

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters
string $name
name used for object to cache
object $object
the object to persist
Returns
boolean
true on save, throws error if file can not be created

_set() public ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Parameters
array $properties optional array()
An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters
$status optional 0
http://php.net/exit for values

cakeError() public ¶

cakeError( string $method , array $messages = array() )

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters
string $method
Method to be called in the error class (AppError or ErrorHandler classes)
array $messages optional array()
Message that is to be displayed by the error class
Returns
error
message

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Parameters
string $method
Name of the method to call
array $params optional array()
Parameter list to use when calling $method
Returns
mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Parameters
string $msg
Log message
integer $type optional LOG_ERROR
Error type constant. Defined in app/config/core.php.
Returns
boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Parameters
mixed $url
String or array-based url.
array $extra optional array()
if array includes the key "return" it sets the AutoRender to true.
Returns
mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.


toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns
string
The name of this class

Properties detail

$__options ¶

public array

Options used by DateTime fields

array(
    'day' => array(), 'minute' => array(), 'hour' => array(),
    'month' => array(), 'year' => array(), 'meridian' => array()
)

$_inputDefaults ¶

public array

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

array()

$_lastAction ¶

public string

The action attribute value of the last created form. Used to make form/request specific hashes for SecurityComponent.

''

$defaultModel ¶

public string

The default model being used for the current form.

null

$fields ¶

public array

List of fields created, used with secure forms.

array()

$fieldset ¶

public array

Holds the fields array('field_name' => array('type'=> 'string', 'length'=> 100), primaryKey and validates array('field_name')

array()

$helpers ¶

public array

Other helpers used by FormHelper

array('Html')

$requestType ¶

public string

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

null
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs