This is the main engine for the processing
of Forms. It builds the form tag, and calls the appropriate FormContent methods to build the FormElement's and validation, as well as backend processing to do the action after the data has been validated.
Located in Program_Root/form/FormWizard.inc (line 26)
Container | --FormProcessor | --FormWizard
Class | Description |
---|---|
MyWizard | This is the main engine for the processing |
This holds the array of
step objects for the wizard
Holds a bunch of state
variables
Inherited from FormProcessor
FormProcessor::$_auto_show_errors
FormProcessor::$_confirmed
FormProcessor::$_confirmed_successfull
FormProcessor::$_FormValidation
FormProcessor::$_form_attributes
FormProcessor::$_form_content
FormProcessor::$_form_submit_action
FormProcessor::$_form_success_render
FormProcessor::$_has_errors
Inherited from Container
Container::$_flags
The constructor
This adds a step to the wizard
- the title for the step
- the description for the step
- the help url for the step (if any)
- the form content object that is the step.
This function renders the
FormWizard
This function renders the confirmation page. This page sits in between the front end form, and the action handler.
This only gets called after a form and its data has been successfully validated.
- $indent_level
- $output_debug
A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.
This builds the javascript needed for the navigation of the wizard
This function builds an image for a step #
- the step # to build
This renders the toolbar/step table
for the navigation of the wizard
This function cleans up the saved Session state for the wizard. This gets called when we have completed the wizard w/o errors.
This returns the current step id
from the session
This function initializes all of the fields we need to keep track of for the internal state of the wizard. It also walks each of the step FormContent objects and initializes them.
We save some of the state of the wizard in the session.
This method initializes the session
variable that we use
This tests to see if the step has been visited or not.
- the step to mark
This method does the logic of
doing the form processing
This ensures that we have sessions started
This sets the current step id
- the new step #
This function sets the _form_content object for the current step we are operating on.
The parent FormProcessor needs this object set in order to process the step correctly.
This sets the state variable for the step to let us know it has been visited or not
- the step to mark
- TRUE = visited
Inherited From FormProcessor
FormProcessor::FormProcessor()
FormProcessor::can_validate()
FormProcessor::do_validation()
FormProcessor::get_action()
FormProcessor::get_auto_error_display()
FormProcessor::get_error_array()
FormProcessor::get_error_display_object()
FormProcessor::get_form_action()
FormProcessor::get_form_enctype()
FormProcessor::get_form_method()
FormProcessor::get_form_name()
FormProcessor::get_form_target()
FormProcessor::has_errors()
FormProcessor::is_action_successfull()
FormProcessor::render()
FormProcessor::render_confirm()
FormProcessor::render_error()
FormProcessor::render_form()
FormProcessor::setup_validation()
FormProcessor::set_auto_error_display()
FormProcessor::set_form_action()
FormProcessor::set_form_enctype()
FormProcessor::set_form_method()
FormProcessor::set_form_name()
FormProcessor::set_form_target()
FormProcessor::set_render_form_after_success()
FormProcessor::_add_confirm_data()
FormProcessor::_add_hidden_fields()
FormProcessor::_build_form_tag()
FormProcessor::_build_javascript()
FormProcessor::_pre_confirm()
FormProcessor::_process_action()
FormProcessor::_process_form()
FormProcessor::_set_action()
FormProcessor::_set_confirmed_success()
FormProcessor::__hidden_fields()
Inherited From Container
Container::Container()
Container::add()
Container::add_reference()
Container::count_content()
Container::get_indent_flag()
Container::push()
Container::push_reference()
Container::render()
Container::reset_content()
Container::set_collapse()
Container::set_indent_flag()
Container::_set_flags()
Documention generated on Thu, 31 Jul 2003 18:32:46 -0700 by phpDocumentor 1.2.0