[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/ctools/includes/ -> wizard.inc (summary)

(no description)

File Size: 460 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 5 functions

  ctools_wizard_multistep_form()
  ctools_wizard_wrapper()
  ctools_wizard_submit()
  ctools_wizard_get_path()
  ctools_wizard_defaults()

Functions
Functions that are not part of a class:

ctools_wizard_multistep_form($form_info, $step, &$form_state)   X-Ref
Display a multi-step form.

Aside from the addition of the $form_info which contains an array of
information and configuration so the multi-step wizard can do its thing,
this function works a lot like ctools_build_form.

Remember that the form builders for this form will receive
&$form, &$form_state, NOT just &$form_state and no additional args.

Do NOT use #required => TRUE with these forms as that validation
cannot be skipped for the CANCEL button.

param: $form_info
param: $step
param: &$form_state

ctools_wizard_wrapper(&$form, &$form_state)   X-Ref
Provide a wrapper around another form for adding multi-step information.


ctools_wizard_submit(&$form, &$form_state)   X-Ref
On a submit, go to the next form.


ctools_wizard_get_path($form_info, $step)   X-Ref
Create a path from the form info and a given step.


ctools_wizard_defaults(&$form_info)   X-Ref
Set default parameters and callbacks if none are given.
Callbacks follows pattern:
$form_info['id']_$hook
$form_info['id']_$form_info['forms'][$step_key]_$hook




Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7