Docs For Class atkWizard

Home

Documentation home

Atk index

Docs For Class atkWizard [ package: atk ]

Class: atkWizard

Source Location: /wizard/class.atkwizard.inc

Class atkWizard

Class Overview

atkWizard class which is capable of using atknodes as wizardpanels.

This class makes the distinction between update/save and navigation actions from the wizard and respondis correspondingly.

atkWizard's highest baseclass is atkController. When an atkWizard is created and becomes the controller of the atkapp, it will stay the controller untill we take a non wizard specific action.

Located in /wizard/class.atkwizard.inc [line 51]

Wiki documentation

atkController
   |
   --atkWizardBase
      |
      --atkWizard

Author(s):

maurice <maurice@ibuildings.nl>

Information Tags:

Properties

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkController atkController::$m_hidden_vars atkController::$m_module_name atkController::$m_name atkController::$m_node atkController::$m_php_file atkController::$m_postvars atkController::$m_return_output	Inherited From atkWizardBase atkWizardBase::atkWizardBase() Constructor of atkWizardBase atkWizardBase::getFormButtons() Returns the form buttons for a certain page. atkWizardBase::showFinishButton() Determine if this panel should show a finish button Inherited From atkController atkController::atkController() Constructor of atkController atkController::accessDeniedPage() Render a generic access denied page. atkController::actionPageTitle() Return the title to be show on top of an Action Page atkController::createInstance() Return the one and only instance of the class atkController::dispatch() This method is a wrapper for calling the node dispatch function Therefore each node can define it's own dispatch function The default dispatch function of the atkNode will call the handleRequest function of the controller atkController::dispatchUrl() Generate a dispatch menu URL for use with nodes and their specific actions. atkController::feedbackUrl() Determine the url for the feedbackpage. atkController::genericPage() Render a generic page, with a box, title, stacktrace etc. atkController::getButton() Create a button. atkController::getDialogButton() Create a dialog button. atkController::getFormButtons() Returns the form buttons for a certain page. atkController::getHiddenVars() Return m_hidden_vars array. atkController::getHiddenVarsString() Return m_hidden_vars as html input types. atkController::getHtmlTitle() Return the html title for the content frame. Default we show node name and action. atkController::getInstance() Return the one and only instance of the class atkController::getModuleName() Return module name of controller atkController::getName() Return controller name atkController::getNode() Get m_node variable or if not set make instance of atkNode class (determined by using the postvars) atkController::getPage() Return a reference to the atkPage object. This object is used to render output as an html page. atkController::getPhpFile() Return php_file. If not set, returns theme-level dispatchfile, if not set either, return (sanitized) PHP_SELF atkController::getReturnOutput() Return the setting for returning output atkController::getUi() Get the ui instance for drawing and templating purposes. atkController::handleRequest() This is the wrapper method for all http requests on a node. atkController::invoke() Generic method invoker (copied from class.atkactionhandler.inc). atkController::loadDispatchPage() Does the actual loading of the dispatch page And adds it to the page for the dispatch() method to render. atkController::renderActionPage() Render a generic action. atkController::setHiddenVar() Set Key/value pair in m_hidden_vars array. Saved pairs are send as post or get vars in the next page load atkController::setNode() Set m_node variable of this class atkController::setPhpFile() Set php_file member variable atkController::setReturnOutput() Configure if you want the html returned or leave it up to atkOutput. atkController::_instance() Create instance of controller (determined by class variable) if not yet created, return instance of atkcontroller

Inherited Properties

Inherited Methods

Inherited From atkController

atkController::$m_hidden_vars

atkController::$m_module_name

atkController::$m_name

atkController::$m_node

atkController::$m_php_file

atkController::$m_postvars

atkController::$m_return_output

Inherited From atkWizardBase

atkWizardBase::atkWizardBase()

Constructor of atkWizardBase

atkWizardBase::getFormButtons()

Returns the form buttons for a certain page.

atkWizardBase::showFinishButton()

Determine if this panel should show a finish button

Inherited From atkController

atkController::atkController()

Constructor of atkController

atkController::accessDeniedPage()

Render a generic access denied page.

atkController::actionPageTitle()

Return the title to be show on top of an Action Page

atkController::createInstance()

Return the one and only instance of the class

atkController::dispatch()

This method is a wrapper for calling the node dispatch function Therefore each node can define it's own dispatch function The default dispatch function of the atkNode will call the handleRequest function of the controller

atkController::dispatchUrl()

Generate a dispatch menu URL for use with nodes and their specific actions.

atkController::feedbackUrl()

Determine the url for the feedbackpage.

atkController::genericPage()

Render a generic page, with a box, title, stacktrace etc.

atkController::getButton()

Create a button.

atkController::getDialogButton()

Create a dialog button.

atkController::getFormButtons()

Returns the form buttons for a certain page.

atkController::getHiddenVars()

Return m_hidden_vars array.

atkController::getHiddenVarsString()

Return m_hidden_vars as html input types.

atkController::getHtmlTitle()

Return the html title for the content frame. Default we show node name and action.

atkController::getInstance()

Return the one and only instance of the class

atkController::getModuleName()

Return module name of controller

atkController::getName()

Return controller name

atkController::getNode()

Get m_node variable or if not set make instance of atkNode class (determined by using the postvars)

atkController::getPage()

Return a reference to the atkPage object. This object is used to render output as an html page.

atkController::getPhpFile()

Return php_file. If not set, returns theme-level dispatchfile, if not set either, return (sanitized) PHP_SELF

atkController::getReturnOutput()

Return the setting for returning output

atkController::getUi()

Get the ui instance for drawing and templating purposes.

atkController::handleRequest()

This is the wrapper method for all http requests on a node.

atkController::invoke()

Generic method invoker (copied from class.atkactionhandler.inc).

atkController::loadDispatchPage()

Does the actual loading of the dispatch page And adds it to the page for the dispatch() method to render.

atkController::renderActionPage()

Render a generic action.

atkController::setHiddenVar()

Set Key/value pair in m_hidden_vars array. Saved pairs are send as post or get vars in the next page load

atkController::setNode()

Set m_node variable of this class

atkController::setPhpFile()

Set php_file member variable

atkController::setReturnOutput()

Configure if you want the html returned or leave it up to atkOutput.

atkController::_instance()

Create instance of controller (determined by class variable) if not yet created, return instance of atkcontroller

[ Top ]

Property Summary

array	$m_currentPanelIndex	Index of panel which is currently shown or processed
array	$m_hiddenParams	Key-value array which will be added as hidden value in edit/add forms
bool	$m_isWizardInitiated	It can com in handy to know if we are at the start of the wizard and have not performed any wizard actions.
array	$m_mode	The mode in which the wizard is run (add/edit).
int	$m_page_flags	Value needed by atkPage to render the content of a page. Default we need to render a complete html page, but it might be necesary to only render the content part.
array	$m_panelIndex	Key/value array containing panel name as key and index as value
array	$m_panelList	Array of panels First item is first to show in wizard
array	$m_redirectParams	Key-value array which will be url when redirecting to a new page
object	$m_self	We use a reference to ourselfs because we pass data to the wizardpanel which has a reference to its wizard parent.
string	$m_wizardAction	Action to perform in the wizard. Actions can be: next, finish, saveandnext, saveandaddnew.

[ Top ]

Method Summary

atkWizard	atkWizard()	Constructor
string	actionPageTitle()	Return the title to be show on top of an Action Page. This is an override of the atkController::actionPageTitle function.
void	addPanel()	Add wizardpanel to the wizard. Only objects of type atkWizardPanel can be added. The order of additions to the wizard determines order in which the panels are shown.
void	checkWizardInitiationStatus()	This function is called from the constructor to check if the wizard goes through the initialisation. This means that the first panel is shown and no wizard actions have been taken.
void	collectWizardSessionData()	This function is called from the constructor. Its basic function is to collect wizard information from the session stack. To run the wizard we need to be able to use atk's session stack. Default it is turned on, but it might be turned off explicitly.
void	finish()	Finish the wizard
object of	&getCurrentPanel()	Return the current active panel object.
array	getHiddenParam()	Return the hidden params
define	getMode()	Get the wizard mode
string	getWizardAction()	Return the current wizardaction
String	handleRequest()	Main execution function (start of the wizard). Every page load will go through this function. This function overrides atkController::handleRequest but it always calls its parent in the end.
bool	isFinishPanel()	Return if this panel is the last one in the wizard
bool	save()	We are saving a newly added record. On success or failure ATK will redirect.
void	setHiddenParam()	Collect the variables which should be set as hidden input fields in forms.
void	setHtmlTitle()	Set the value of the html meta tag. This is an override of the atkcontroller::setHtmlTitle.
void	setMode()	Set the wizard mode. Options: WIZARD_MODE_ADD (default), WIZARD_MODE_EDIT
void	setPageFlags()	Set a defined value needed by atkPage to render the content of a page. Default we need to render a complete html (HTML_ALL) page, but it might be necesary to only render the content part.
void	setRedirectParam()	Collect the variables which should be added to the redirect url.
void	wizardDispatch()	Determine the wizardPanel to load and let the wizardpanel do some dispatching too.

[ Top ]

Properties

array $m_currentPanelIndex = 0 [line 102]

Index of panel which is currently shown or processed

API Tags:

Access:

private

[ Top ]

array $m_hiddenParams = array() [line 86]

Key-value array which will be added as hidden value in edit/add forms

API Tags:

Access:

private

[ Top ]

bool $m_isWizardInitiated [line 136]

It can com in handy to know if we are at the start of the wizard and have not performed any wizard actions.

[ Top ]

array $m_mode = WIZARD_MODE_ADD [line 78]

The mode in which the wizard is run (add/edit).

Default is add

API Tags:

Access:

private

[ Top ]

int $m_page_flags = HTML_ALL [line 111]

Value needed by atkPage to render the content of a page. Default we need to render a complete html page, but it might be necesary to only render the content part.

[ Top ]

array $m_panelIndex = array() [line 69]

Key/value array containing panel name as key and index as value

API Tags:

Access:

private

[ Top ]

array $m_panelList = array() [line 60]

Array of panels First item is first to show in wizard

API Tags:

Access:

private

[ Top ]

array $m_redirectParams = array() [line 94]

Key-value array which will be url when redirecting to a new page

API Tags:

Access:

private

[ Top ]

object $m_self [line 120]

We use a reference to ourselfs because we pass data to the wizardpanel which has a reference to its wizard parent.

API Tags:

Access:

private

[ Top ]

string $m_wizardAction [line 128]

Action to perform in the wizard. Actions can be: next, finish, saveandnext, saveandaddnew.

[ Top ]

Methods

Constructor atkWizard [line 143]

atkWizard atkWizard(
)

Constructor

[ Top ]

actionPageTitle [line 484]

string actionPageTitle(
)

Return the title to be show on top of an Action Page. This is an override of the atkController::actionPageTitle function.

We now want to show the wizard name, wizard panel and which step we are at.

API Tags:

Return:	The title
Access:	public

Redefinition of:

atkController::actionPageTitle(): Return the title to be show on top of an Action Page

[ Top ]

addPanel [line 235]

void addPanel(

&$atkWizardPanel, object
$atkWizardPanel 
)

Add wizardpanel to the wizard. Only objects of type atkWizardPanel can be added. The order of additions to the wizard determines order in which the panels are shown.

Parameters:

object	$atkWizardPanel:
	&$atkWizardPanel:

API Tags:

Access:

public

[ Top ]

checkWizardInitiationStatus [line 167]

void checkWizardInitiationStatus(
)

This function is called from the constructor to check if the wizard goes through the initialisation. This means that the first panel is shown and no wizard actions have been taken.

We check this by saving searching the sessing for the var 'wizard_initiation_level'. If it does not exist we fill it with the current atkLevel.

API Tags:

Access:

private

[ Top ]

collectWizardSessionData [line 192]

void collectWizardSessionData(
)

This function is called from the constructor. Its basic function is to collect wizard information from the session stack. To run the wizard we need to be able to use atk's session stack. Default it is turned on, but it might be turned off explicitly.

API Tags:

Access:

private

[ Top ]

finish [line 380]

void finish(
)

Finish the wizard

This function can be overriden in the your extended wizard class.

TODO/FIXME It would be even more cool if wizardpanels could listen to the finish action and be notified of this action/event.

API Tags:

Access:

protected

[ Top ]

getCurrentPanel [line 430]

object of &getCurrentPanel(
)

Return the current active panel object.

API Tags:

Return:	type atkWizardPanel
Access:	public

[ Top ]

getHiddenParam [line 408]

array getHiddenParam(
)

Return the hidden params

API Tags:

Access:

public

[ Top ]

getMode [line 222]

define getMode(
)

Get the wizard mode

API Tags:

Return:	value
Access:	public

[ Top ]

getWizardAction [line 497]

string getWizardAction(
)

Return the current wizardaction

API Tags:

Return:	wizardaction (eg next, saveandnext, saveandaddnew, finish).
Access:	public

[ Top ]

handleRequest [line 248]

String handleRequest(
)

Main execution function (start of the wizard). Every page load will go through this function. This function overrides atkController::handleRequest but it always calls its parent in the end.

API Tags:

Return:	The html output
Access:	public

Redefinition of:

atkController::handleRequest(): This is the wrapper method for all http requests on a node.

[ Top ]

isFinishPanel [line 446]

bool isFinishPanel(
string
$name 
)

Return if this panel is the last one in the wizard

Parameters:

string

$name:

API Tags:

Access:

public

[ Top ]

save [line 352]

bool save(
string
$atkwizardaction 
)

We are saving a newly added record. On success or failure ATK will redirect.

On failure the session stack of the previous level is loaded to show the same wizardpanel again (now with error message). On succes we need to set some redirect vars to make sure we go to the next wizardpanel.

Parameters:

string

$atkwizardaction:

The wizard action for redirecting

API Tags:

Return:	on successfully executing this function
Access:	protected

[ Top ]

setHiddenParam [line 398]

void setHiddenParam(
string
$key, mixed
$value 
)

Collect the variables which should be set as hidden input fields in forms.

Save them in a key/value array.

Parameters:

string	$key:
mixed	$value:

API Tags:

Access:

public

[ Top ]

setHtmlTitle [line 471]

void setHtmlTitle(
)

Set the value of the html meta tag. This is an override of the atkcontroller::setHtmlTitle.

We now want to show the wizard name, wizard panel and which step we are at.

API Tags:

Access:

public

[ Top ]

setMode [line 212]

void setMode(
[integer
$mode = WIZARD_MODE_ADD] 
)

Set the wizard mode. Options: WIZARD_MODE_ADD (default), WIZARD_MODE_EDIT

Parameters:

integer

$mode:

API Tags:

Access:

public

[ Top ]

setPageFlags [line 461]

void setPageFlags(
define
$flag 
)

Set a defined value needed by atkPage to render the content of a page. Default we need to render a complete html (HTML_ALL) page, but it might be necesary to only render the content part.

Parameters:

define

$flag:

API Tags:

Access:

public

[ Top ]

setRedirectParam [line 420]

void setRedirectParam(
string
$key, mixed
$value 
)

Collect the variables which should be added to the redirect url.

Save them in a key/value array.

Parameters:

string	$key:
mixed	$value:

API Tags:

Access:

public

[ Top ]

wizardDispatch [line 308]

void wizardDispatch(
String
$atkWizardaction 
)

Determine the wizardPanel to load and let the wizardpanel do some dispatching too.

Parameters:

String

$atkWizardaction:

API Tags:

Access:

protected

[ Top ]