phpDocumentor epesi-utils
wizard
[ class tree: epesi-utils ] [ index: epesi-utils ] [ all elements ]

Class: Utils_Wizard

Source Location: /modules/Utils/Wizard/Wizard_0.php

Class Utils_Wizard

Class Overview

Wizard class.

Located in /modules/Utils/Wizard/Wizard_0.php [line 14]

ModuleAcl
   |
   --ModulePrimitive
      |
      --Module
         |
         --Utils_Wizard
Author(s): Information Tags:
Version:  1.0
Copyright:  Copyright © 2006, Telaxus LLC
License:  MIT

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Module

Module::$children
Module::$display_func
Module::$parent

Inherited From Module

Module::__construct()
Constructor. Should not be called directly using new Module('name').
Module::call_callback_href()
Module::clear_module_variables()
Unset all module variables.
Module::create_back_href()
Creates link that will lead back to previous page content.
Module::create_back_href_js()
Module::create_callback_href()
Creates link similar to link created with create_href.
Module::create_callback_href_js()
Creates link similar to link created with create_href.
Module::create_callback_href_with_id()
Creates link similar to links created with create_href.
Module::create_callback_href_with_id_js()
Creates link similar to links created with create_href.
Module::create_confirm_callback_href()
Creates link similar to link created with create_href.
Module::create_confirm_callback_href_with_id()
Creates link similar to links created with create_href.
Module::create_confirm_href()
Create onClick action string (with href="javascript:void(0);").
Module::create_confirm_unique_href()
Similar to create_href, but variables passed to this function will only be accessible in module that called this function.
Module::create_href()
Create onClick action string (with href="javascript:void(0);").
Module::create_href_js()
Create onClick action string destined for js code.
Module::create_unique_href()
Similar to create_href, but variables passed to this function will only be accessible in module that called this function.
Module::create_unique_href_js()
Create onClick action string destined for js code.
Module::create_unique_key()
Returns unique key name, generated from unique name of this module (function get_path) and string parameter.
Module::displayed()
Returns whether this module instance was already displayed.
Module::display_module()
Call method of the module passed as first parameter, which name is passed as second parameter.
Module::freeze_module()
Makes child module to not loose its module variables
Module::get_child()
Gets child module with specified node id.
Module::get_children()
Gets array of children modules.
Module::get_html_of_module()
Call method of the module passed as first parameter, which name is passed as second parameter.
Module::get_instance_id()
Returns id of module instance.
Module::get_jses()
Returns list of jses to evaluate.
Module::get_module_variable()
Returns value of a module variable. If the variable is not set, function will return value given as second parameter.
Module::get_module_variable_or_unique_href_variable()
Returns href variable.
Module::get_node_id()
Get node identifier.
Module::get_parent_path()
Returns unique path of parent module.
Module::get_parent_type()
Returns name(type) of parent module.
Module::get_path()
Returns unique path of calling module.
Module::get_reload()
Returns current reload settings.
Module::get_unique_href_variable()
Returns variable passed with create_unique_href.
Module::init_module()
Creates module instance which name is given as first parameter.
Module::isset_module_variable()
Checks if variable exists.
Module::isset_unique_href_variable()
Checks if variable given as first parameter was passed with create_unique_href function.
Module::is_back()
Checks if set_back_location was used.
Module::is_fast_process()
Returns whether this module instance has fast processing turned on.
Module::is_inline_display()
Returns whether this module instance is displayed inline.
Module::js()
Appends js code to list of jses to evaluate.
Module::mark_displayed()
Marks this module instance as it was displayed.
Module::pack_module()
Creates instance of module given as first parameter as a child of the module that has called this function.
Module::register_method()
Module::set_back_location()
Sets reload location to previous page display.
Module::set_fast_process()
Enable fast processing for this module instance.
Module::set_inline_display()
Changes display behavior for this module instance to inline.
Module::set_module_variable()
Sets variable that will be available only for module instance that called this function.
Module::set_reload()
Mark module to force its reload or prevent being reloaded.
Module::share_module_variable()
Share variable passed as first parameter with module passed as second parameter.
Module::share_unique_href_variable()
Share href variable passed as first parameter with module passed as second parameter.
Module::static_get_module_variable()
Returns value of a module variable. If the variable is not set, function will return value given as third parameter.
Module::static_isset_module_variable()
Checks if variable exists.
Module::static_set_module_variable()
Sets variable that will be available only for module instance that called this function.
Module::static_unset_module_variable()
Module::unset_module_variable()
Unset module variable.
Module::unset_unique_href_variable()
Unsets *unique_href variable.
Module::__call()

Inherited From ModulePrimitive

ModulePrimitive::__construct()
ModulePrimitive::check_access()
Checks access to function which name is passed as first parameter.
ModulePrimitive::create_data_dir()
Creates default data directory for module. Typical usage: in module installation
ModulePrimitive::get_data_dir()
Returns path to the default data directory for module calling this method.
ModulePrimitive::get_module_dir()
Returns path to the module directory.
ModulePrimitive::get_type()
Returns name(type) of module that called this function.
ModulePrimitive::get_type_with_bt()
ModulePrimitive::remove_data_dir()
Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()
ModuleAcl::add_aco()
ModuleAcl::del_aco()
ModuleAcl::get_type()

[ Top ]
Method Summary
object QuickForm   begin_page()   Starts new wizard step.
void   body()   Displays wizard current step.
void   callback_page()  
void   construct()   Module constructor.
void   delete_page()   Delete page
array   get_data()   Gets data submited till now.
void   next_page()   Finishes current page.
void   set_alternative_renderer()   Sets renderer that will be used to display current step.
void   set_caption()  
void   submit()   For internal use only.

[ Top ]
Methods
begin_page  [line 58]

  object QuickForm begin_page( [string $name = null], [ $always_return_valid_form = true]  )

Starts new wizard step.

This method returns QuickForm object which you should use to create wizard step.

Parameters:
string   $name:  alias for the page
   $always_return_valid_form: 

API Tags:
Return:  object
Access:  public


[ Top ]
body  [line 219]

  void body( method $func  )

Displays wizard current step.

You can also specify function to process the data from all the pages.

Parameters:
method   $func:  method to process the data

API Tags:
Access:  public


[ Top ]
callback_page  [line 79]

  void callback_page( $func, [ $name = null], [ $begin_page_args = null], [ $func_args = null]  )

Parameters:
   $func: 
   $name: 
array   $begin_page_args: 
array   $func_args: 

API Tags:
Access:  public


[ Top ]
construct  [line 33]

  void construct( [integer $start_page = 0]  )

Module constructor.

You can choose starting page while creating new instance of this module.

Parameters:
integer   $start_page:  starting page number

API Tags:
Access:  public


[ Top ]
delete_page  [line 184]

  void delete_page( page $x  )

Delete page

Parameters:
page   $x:  name or number

API Tags:
Access:  public


[ Top ]
get_data  [line 168]

  array get_data( )

Gets data submited till now.


API Tags:
Access:  public


[ Top ]
next_page  [line 103]

  void next_page( [mixed $func = null], [ $func_args = null]  )

Finishes current page.

You can also choose specific page (by number or alias).

Parameters:
mixed   $func:  next page
array   $func_args: 

API Tags:
Access:  public


[ Top ]
set_alternative_renderer  [line 93]

  void set_alternative_renderer( object HTML &$rend  )

Sets renderer that will be used to display current step.

Parameters:
object HTML   &$rend:  QuickForm renderer object

API Tags:
Access:  public


[ Top ]
set_caption  [line 45]

  void set_caption( $caption, [ $level = 0]  )

Parameters:
   $caption: 
   $level: 

API Tags:
Access:  public


[ Top ]
submit  [line 175]

  void submit( $d  )

For internal use only.

Parameters:
   $d: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:47:46 -0500 by phpDocumentor 1.4.2