Docs For Class Step2

## Class Step2

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 /examples/_steps.inc (line 106)

    FormContent
       |
       --StandardFormContent
          |
          --Step2

Method Summary
void confirm_action ()
void form_content ()
void form_init_data ()
void form_init_elements ()
void &_optional_info ()
Variables

#### Inherited Variables

Inherited from StandardFormContent

> StandardFormContent::$_allow_actions
> StandardFormContent::$_form_title
> StandardFormContent::$_infotable
> StandardFormContent::$_wizard_id

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
confirm_action (line 199)

This method will get called after all validation has passed, and the confirmation has been accepted.

This is where u save the info to the DB.

void confirm_action ()

Redefinition of:

StandardFormContent::confirm_action()
  This method is responsible for handling the confirmation page's Confirm action.

form_content (line 161)

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.

In this example we have 2 form 'blocks'.

void form_content ()

Redefinition of:

StandardFormContent::form_content()
  Child class MUST override this to provide the form fields

form_init_data (line 141)

This method is called only the first time the form page is hit.

void form_init_data ()

Redefinition of:

FormContent::form_init_data()
  This method is called by the

form_init_elements (line 112)

This method gets called EVERY time the object is

created

void form_init_elements ()

Redefinition of:

FormContent::form_init_elements()
  This method is what is called to build the list of FormElements that will be used by this form.

_optional_info (line 171)

This private method builds the table that holds

the 'optional' form fields'

void &_optional_info ()

#### Inherited Methods

Inherited From StandardFormContent

> StandardFormContent::StandardFormContent()
> StandardFormContent::add_form_block()
> StandardFormContent::build_form_block()
> StandardFormContent::confirm_action()
> StandardFormContent::form()
> StandardFormContent::form_action()
> StandardFormContent::form_confirm()
> StandardFormContent::form_content()
> StandardFormContent::form_content_buttons()
> StandardFormContent::get_wizard_id()
> StandardFormContent::set_form_title()
> StandardFormContent::set_wizard_id()
> StandardFormContent::_div_wrapper()
> StandardFormContent::_form_content_table()

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:42 -0700 by phpDocumentor 1.3.0RC3