FormHelper Class Reference

Inheritance diagram for FormHelper:

Helper Object

List of all members.


Public Member Functions

 divTag ($class, $text)
 generateAreaDiv ($tagName, $prompt, $required=false, $errorMsg=null, $cols=60, $rows=10, $htmlOptions=null)
 generateCheckboxDiv ($tagName, $prompt, $required=false, $errorMsg=null, $htmlOptions=null)
 generateDate ($tagName, $prompt, $required=false, $errorMsg=null, $size=20, $htmlOptions=null, $selected=null)
 generateDateTime ($tagName, $prompt, $required=false, $errorMsg=null, $size=20, $htmlOptions=null, $selected=null)
 generateFields ($fields, $readOnly=false)
 generateInputDiv ($tagName, $prompt, $required=false, $errorMsg=null, $size=20, $htmlOptions=null)
 generateSelectDiv ($tagName, $prompt, $options, $selected=null, $selectAttr=null, $optionAttr=null, $required=false, $errorMsg=null)
 generateSubmitDiv ($displayText, $htmlOptions=null)
 generateTime ($tagName, $prompt, $required=false, $errorMsg=null, $size=20, $htmlOptions=null, $selected=null)
 generateYear ($tagName, $prompt, $required=false, $errorMsg=null, $size=20, $htmlOptions=null, $selected=null)
 isFieldError ($field)
 labelTag ($tagName, $text)
 pTag ($class, $text)

Public Attributes

 $helpers = array('Html')

Detailed Description

Definition at line 53 of file form.php.

Member Function Documentation

FormHelper::divTag ( $  class,
$  text 
)

Returns a formatted DIV tag for HTML FORMs.

Parameters:
string $class CSS class name of the div element.
string $text String content that will appear inside the div element.
Returns:
string The formatted DIV element public

Definition at line 97 of file form.php.

Referenced by generateAreaDiv(), generateCheckboxDiv(), generateDate(), generateDateTime(), generateInputDiv(), generateSelectDiv(), generateSubmitDiv(), generateTime(), and generateYear().

FormHelper::generateAreaDiv ( $  tagName,
$  prompt,
$  required = false,
$  errorMsg = null,
$  cols = 60,
$  rows = 10,
$  htmlOptions = null 
)

Returns a formatted TEXTAREA inside a DIV for use with HTML forms.

Parameters:
string $tagName This should be "Modelname/fieldname"
string $prompt Text that will appear in the label field.
boolean $required True if this field is required.
string $errorMsg ext that will appear if an error has occurred.
integer $cols Number of columns.
integer $rows Number of rows.
array $htmlOptions HTML options array.
Returns:
string The formatted TEXTAREA element, wrapped in a div. public

Definition at line 303 of file form.php.

References divTag(), isFieldError(), labelTag(), and pTag().

Referenced by generateFields().

FormHelper::generateCheckboxDiv ( $  tagName,
$  prompt,
$  required = false,
$  errorMsg = null,
$  htmlOptions = null 
)

Returns a formatted CHECKBOX tag inside a DIV for HTML FORMs.

Parameters:
string $tagName This should be "Modelname/fieldname"
string $prompt Text that will appear in the label field.
bool $required True if this field is a required field.
string $errorMsg Text that will appear if an error has occurred.
array $htmlOptions HTML options array.
Returns:
string The formatted checkbox div public

Definition at line 152 of file form.php.

References divTag(), isFieldError(), labelTag(), and pTag().

Referenced by generateFields().

FormHelper::generateDate ( $  tagName,
$  prompt,
$  required = false,
$  errorMsg = null,
$  size = 20,
$  htmlOptions = null,
$  selected = null 
)

Returns a formatted date option element for HTML FORMs.

Parameters:
string $tagName This should be "Modelname/fieldname"
string $prompt Text that will appear in the label field.
bool $required True if this field is a required field.
string $errorMsg Text that will appear if an error has occurred.
int $size Not used.
array $htmlOptions HTML options array
Returns:
string Date option wrapped in a div.
Todo:
Remove the $size parameter from this method. public

Definition at line 182 of file form.php.

References divTag(), isFieldError(), labelTag(), and pTag().

Referenced by generateFields().

FormHelper::generateDateTime ( $  tagName,
$  prompt,
$  required = false,
$  errorMsg = null,
$  size = 20,
$  htmlOptions = null,
$  selected = null 
)

Returns a formatted datetime option element for HTML FORMs.

Parameters:
string $tagName This should be "Modelname/fieldname"
string $prompt Text that will appear in the label field.
bool $required True if this field is required.
string $errorMsg Text that will appear if an error has occurred.
int $size Not used.
array $htmlOptions HTML options array
array $selected Selected index in the dateTimeOption tag.
Returns:
string The formatted datetime option element wrapped in a div.
Todo:
Remove the $size parameter from this method. public

Definition at line 273 of file form.php.

References divTag(), isFieldError(), labelTag(), and pTag().

Referenced by generateFields().

FormHelper::generateFields ( $  fields,
$  readOnly = false 
)

Generates a form to go onto a HtmlHelper object.

Parameters:
array $fields An array of form field definitions
boolean $readOnly True if the form should be rendered as READONLY
Returns:
string The completed form specified by the $fields parameter public

Definition at line 373 of file form.php.

References generateAreaDiv(), generateCheckboxDiv(), generateDate(), generateDateTime(), generateInputDiv(), generateSelectDiv(), generateTime(), and generateYear().

FormHelper::generateInputDiv ( $  tagName,
$  prompt,
$  required = false,
$  errorMsg = null,
$  size = 20,
$  htmlOptions = null 
)

Returns a formatted INPUT tag for HTML FORMs.

Parameters:
string $tagName This should be "Modelname/fieldname"
string $prompt Text that will appear in the label field.
bool $required True if this field is a required field.
string $errorMsg Text that will appear if an error has occurred.
int $size Size attribute for INPUT element
array $htmlOptions HTML options array.
Returns:
string The formatted INPUT element, with a label and wrapped in a div. public

Definition at line 123 of file form.php.

References divTag(), isFieldError(), labelTag(), and pTag().

Referenced by generateFields().

FormHelper::generateSelectDiv ( $  tagName,
$  prompt,
$  options,
$  selected = null,
$  selectAttr = null,
$  optionAttr = null,
$  required = false,
$  errorMsg = null 
)

Returns a formatted SELECT tag for HTML FORMs.

Parameters:
string $tagName This should be "Modelname/fieldname"
string $prompt Text that will appear in the label field
array $options Options to be contained in SELECT element
string $selected Currently selected item
array $selectAttr Array of HTML attributes for the SELECT element
array $optionAttr Array of HTML attributes for the OPTION elements
bool $required True if this field is required
string $errorMsg Text that will appear if an error has occurred
Returns:
string The formatted INPUT element, wrapped in a div public

Definition at line 337 of file form.php.

References divTag(), isFieldError(), labelTag(), and pTag().

Referenced by generateFields().

FormHelper::generateSubmitDiv ( $  displayText,
$  htmlOptions = null 
)

Returns a formatted submit widget for HTML FORMs.

Parameters:
string $displayText Text that will appear on the widget
array $htmlOptions HTML options array
Returns:
string The formatted submit widget public

Definition at line 362 of file form.php.

References divTag().

FormHelper::generateTime ( $  tagName,
$  prompt,
$  required = false,
$  errorMsg = null,
$  size = 20,
$  htmlOptions = null,
$  selected = null 
)

Returns a formatted date option element for HTML FORMs.

Parameters:
string $tagName This should be "Modelname/fieldname"
string $prompt Text that will appear in the label field.
bool $required True if this field is a required field.
string $errorMsg Text that will appear if an error has occurred.
int $size Not used.
array $htmlOptions HTML options array
Returns:
string Date option wrapped in a div.
Todo:
Remove the $size parameter from this method. public

Definition at line 212 of file form.php.

References divTag(), isFieldError(), labelTag(), and pTag().

Referenced by generateFields().

FormHelper::generateYear ( $  tagName,
$  prompt,
$  required = false,
$  errorMsg = null,
$  size = 20,
$  htmlOptions = null,
$  selected = null 
)

Returns a formatted year option element for HTML FORMs.

Parameters:
string $tagName This should be "Modelname/fieldname"
string $prompt Text that will appear in the label field.
bool $required True if this field is a required field.
string $errorMsg Text that will appear if an error has occurred.
int $size Not used.
array $htmlOptions HTML options array
Returns:
string Date option wrapped in a div.
Todo:
Remove the $size parameter from this method. public

Definition at line 242 of file form.php.

References divTag(), isFieldError(), labelTag(), and pTag().

Referenced by generateFields().

FormHelper::isFieldError ( $  field  ) 

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

Parameters:
string $field This should be "Modelname/fieldname"
Returns:
bool If there are errors this method returns true, else false. public

Definition at line 68 of file form.php.

Referenced by generateAreaDiv(), generateCheckboxDiv(), generateDate(), generateDateTime(), generateInputDiv(), generateSelectDiv(), generateTime(), and generateYear().

FormHelper::labelTag ( $  tagName,
$  text 
)

Returns a formatted LABEL element for HTML FORMs.

Parameters:
string $tagName This should be "Modelname/fieldname"
string $text Text that will appear in the label field.
Returns:
string The formatted LABEL element public

Definition at line 86 of file form.php.

References Inflector::camelize().

Referenced by generateAreaDiv(), generateCheckboxDiv(), generateDate(), generateDateTime(), generateInputDiv(), generateSelectDiv(), generateTime(), and generateYear().

FormHelper::pTag ( $  class,
$  text 
)

Returns a formatted P tag with class for HTML FORMs.

Parameters:
string $class CSS class name of the p element.
string $text Text that will appear inside the p element.
Returns:
string The formatted P element public

Definition at line 108 of file form.php.

Referenced by generateAreaDiv(), generateCheckboxDiv(), generateDate(), generateDateTime(), generateInputDiv(), generateSelectDiv(), generateTime(), and generateYear().

Member Data Documentation

FormHelper::$helpers = array('Html')

Definition at line 60 of file form.php.

The documentation for this class was generated from the following file: