Docs For Class StandardFormContent

## Class StandardFormContent

Description

This is a child of the FormContent class to provide a 'standard' look and feel for forms.

It also enables a confirmation 'page' by default.

Located in /form/StandardFormContent.inc (line 26)

    FormContent
       |
       --StandardFormContent

Direct descendents

Class | Description
--- | ---
Step1 | A simple Page Layout object child.
Step2 | This is a child of the FormContent class to provide a 'standard' look and feel for forms.
Step3 | This is a child of the FormContent class to provide a 'standard' look and feel for forms.
StandardAccountForm | A simple Page Layout object child.

Variable Summary
mixed $_allow_actions
mixed $_form_title
mixed $_infotable
mixed $_wizard_id
Method Summary
StandardFormContent StandardFormContent (mixed $title, [mixed $cancel_action = NULL], [mixed $width = "100%"])
void add_form_block ([string $title = NULL], TABLEtag &$table)
FIELDSETtag &build_form_block ([string $title = NULL], TABLEtag &$content)
void confirm_action ()
InfoTable form (array 0, array 1)
boolean form_action ()
mixed form_confirm ([string $title = "Form Confirmation"], [boolean $show_buttons = TRUE])
object form_content ()
ButtonPanel form_content_buttons ()
string get_wizard_id ()
void set_form_title (string $title)
void set_wizard_id (string $id)
void &_div_wrapper ()
void _form_content_table ([mixed $width = "100%"], mixed $border, mixed $cellspacing, [mixed $cellpadding = 3])
Variables
mixed $_allow_actions = TRUE (line 44)

Allow the default buttons to be shown?

mixed $_form_title = "" (line 33)

The title used in the wrapping table

mixed $_infotable = NULL (line 39)

the InfoTable wrapper that holds all fields.

mixed $_wizard_id = NULL (line 51)

The wizard id associated with this content

if we are being used inside a wizard

#### Inherited Variables

Inherited from FormContent

> FormContent::$_action_counter
> FormContent::$_action_message
> FormContent::$_cancel_action
> FormContent::$_default_label_css
> FormContent::$_elements
> FormContent::$_error_label_css
> FormContent::$_file_elements
> FormContent::$_FormValidation
> FormContent::$_form_action_elements_on_submit
> FormContent::$_form_errors_title
> FormContent::$_form_errors_width
> FormContent::$_form_name
> FormContent::$_form_on_submit
> FormContent::$_has_confirm
> FormContent::$_has_file_element
> FormContent::$_hidden_elements
> FormContent::$_is_readonly
> FormContent::$_label_colon_flag
> FormContent::$_required_field_marker
> FormContent::$_required_field_text
> FormContent::$_stripslashes
> FormContent::$_width

Methods
Constructor StandardFormContent (line 54)
StandardFormContent StandardFormContent (mixed $title, [mixed $cancel_action = NULL], [mixed $width = "100%"])
add_form_block (line 214)

This function is used to add a block of form fields inside a table to this form.

This table will automatically get wrapped inside a fieldset with a legend tag to label the block

void add_form_block ([string $title = NULL], TABLEtag &$table)

- string $title: - the title for the fieldset
- TABLEtag &$table: - the form fields inside a table

build_form_block (line 227)

this builds a fieldset and legend and adds the form table to it.

FIELDSETtag &build_form_block ([string $title = NULL], TABLEtag &$content)

- string $title: - the legend string
- TABLEtag &$content: - the form fields in a table

confirm_action (line 181)

This method is responsible for handling the confirmation page's Confirm action.

void confirm_action ()

Redefined in descendants as:

- Step1::confirm_action() : This method will get called after all validation has passed, and the confirmation has been accepted.
- Step2::confirm_action() : This method will get called after all validation has passed, and the confirmation has been accepted.
- Step3::confirm_action() : This method will get called after all validation has passed, and the confirmation has been accepted.
- StandardAccountForm::confirm_action() : This method will get called after all validation has passed, and the confirmation has been accepted.

form (line 80)

this builds the main wrapper for the form fields and ads the Save and Cancel buttons

- return: widget object

InfoTable form (array 0, array 1)

- array 0: - the form data
- array 1: - the form error fields (if any)

Redefinition of:

FormContent::form()
  This method builds the html form.

form_action (line 165)

This method handles the form action.

- return: TRUE = success FALSE = failed.

boolean form_action ()

Redefinition of:

FormContent::form_action()
  This method handles the

form_confirm (line 126)

This function is used to show an intermediary confirmation page. Use this function to show a confirmation of the data that was submitted by the user.

This will get called after all of the form data was successfully validated. All of the form data will automatically be created as hidden form fields. All you have to do is show the data, and a confirm submit button.

- return: - either raw html, or some container HTMLTag object.

mixed form_confirm ([string $title = "Form Confirmation"], [boolean $show_buttons = TRUE])

- string $title: - the title for the table
- boolean $show_buttons: - show the action buttons?

Redefinition of:

FormContent::form_confirm()
  This function is used to show an intermediary confirmation page. Use this function to show a confirmation of the data that was submitted by the user.

form_content (line 104)

Child class MUST override this to provide the form fields

object form_content ()

Redefined in descendants as:

- Step1::form_content() : This method is called by the StandardFormContent object to allow you to build the 'blocks' of fields you want to display. Each form block will live inside a fieldset tag with the a title.
- Step2::form_content() : This method is called by the StandardFormContent object to allow you to build the 'blocks' of fields you want to display. Each form block will live inside a fieldset tag with the a title.
- Step3::form_content() : This method is called by the StandardFormContent object to allow you to build the 'blocks' of fields you want to display. Each form block will live inside a fieldset tag with the a title.
- StandardAccountForm::form_content() : This method is called by the StandardFormContent object to allow you to build the 'blocks' of fields you want to display. Each form block will live inside a fieldset tag with the a title.

form_content_buttons (line 193)

This function is used to build the standard buttons for a form.

ButtonPanel form_content_buttons ()
get_wizard_id (line 267)

This method gets the wizard id.

string get_wizard_id ()
set_form_title (line 68)

this method sets the form title which is used to wrap the entire form

void set_form_title (string $title)

- string $title: - the form title

set_wizard_id (line 258)

This method sets the wizard id.

This is called from the FormWizard class

void set_wizard_id (string $id)

- string $id

_div_wrapper (line 240)
void &_div_wrapper ()
_form_content_table (line 246)
void _form_content_table ([mixed $width = "100%"], mixed $border, mixed $cellspacing, [mixed $cellpadding = 3])

#### Inherited Methods

Inherited From FormContent

> FormContent::FormContent()
> FormContent::add_action()
> FormContent::add_action_element()
> FormContent::add_cancel()
> FormContent::add_element()
> FormContent::add_error()
> FormContent::add_hidden_action()
> FormContent::add_hidden_element()
> FormContent::add_image_action()
> FormContent::build_confirm_table()
> FormContent::element_exists()
> FormContent::element_form()
> FormContent::element_label()
> FormContent::form()
> FormContent::form_action()
> FormContent::form_backend_validation()
> FormContent::form_confirm()
> FormContent::form_errors()
> FormContent::form_init_data()
> FormContent::form_init_elements()
> FormContent::form_success()
> FormContent::get_action()
> FormContent::get_action_element()
> FormContent::get_all_element_values()
> FormContent::get_default_css()
> FormContent::get_element()
> FormContent::get_element_value()
> FormContent::get_error_array()
> FormContent::get_form_errors_width()
> FormContent::get_form_name()
> FormContent::get_form_tabindex()
> FormContent::get_hidden_element_value()
> FormContent::get_required_marker()
> FormContent::has_confirm()
> FormContent::hidden_element_label()
> FormContent::is_readonly()
> FormContent::javascript()
> FormContent::pre_confirm()
> FormContent::set_action()
> FormContent::set_action_message()
> FormContent::set_cancel_action()
> FormContent::set_colon_flag()
> FormContent::set_confirm()
> FormContent::set_default_css()
> FormContent::set_element_value()
> FormContent::set_error_css()
> FormContent::set_form_errors_title()
> FormContent::set_form_errors_width()
> FormContent::set_form_name()
> FormContent::set_form_tabindex()
> FormContent::set_form_width()
> FormContent::set_hidden_element_value()
> FormContent::set_readonly()
> FormContent::set_required_marker()
> FormContent::set_required_text()
> FormContent::set_stripslashes()
> FormContent::_pre_confirm()
> FormContent::_set_validation_object()
> FormContent::_test_element()

Documentation generated on Thu, 1 Sep 2005 17:06:11 -0700 by phpDocumentor 1.3.0RC3