Docs For Class atkController

Array	$m_hidden_vars	Key/value Array containing which are be send als post or get vars
String	$m_module_name	The module of the wizard.
String	$m_name	The name of the wizard.
unknown_type	$m_node	Reference to the instance of currently selected atkNode
string	$m_php_file	The file to use when creating url's
array	$m_postvars	The postvars in this pageload
unknown_type	$m_return_output	By this property is determined if the output of the handleRequest method should be returned as a string or the output should be outputted by atkOutput.

[ Top ]

Method Summary

atkController	atkController()	Constructor of atkController
String	accessDeniedPage()	Render a generic access denied page.
string	actionPageTitle()	Return the title to be show on top of an Action Page
object	&createInstance()	Return the one and only instance of the class
void	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
string	dispatchUrl()	Generate a dispatch menu URL for use with nodes and their specific actions.
String	feedbackUrl()	Determine the url for the feedbackpage.
String	genericPage()	Render a generic page, with a box, title, stacktrace etc.
HTML	getButton()	Create a button.
HTML	getDialogButton()	Create a dialog button.
void	getFormButtons()	Returns the form buttons for a certain page.
array	getHiddenVars()	Return m_hidden_vars array.
string	getHiddenVarsString()	Return m_hidden_vars as html input types.
void	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
string	getModuleName()	Return module name of controller
string	getName()	Return controller name
reference	&getNode()	Get m_node variable or if not set make instance of atkNode class (determined by using the postvars)
object reference	&getPage()	Return a reference to the atkPage object. This object is used to render output as an html page.
string	getPhpFile()	Return php_file. If not set, returns theme-level dispatchfile, if not set either, return (sanitized) PHP_SELF
bool	getReturnOutput()	Return the setting for returning output
atkUi	&getUi()	Get the ui instance for drawing and templating purposes.
void	handleRequest()	This is the wrapper method for all http requests on a node.
mixed	invoke()	Generic method invoker (copied from class.atkactionhandler.inc).
void	loadDispatchPage()	Does the actual loading of the dispatch page And adds it to the page for the dispatch() method to render.
String	renderActionPage()	Render a generic action.
void	setHiddenVar()	Set Key/value pair in m_hidden_vars array. Saved pairs are send as post or get vars in the next page load
void	setNode()	Set m_node variable of this class
void	setPhpFile()	Set php_file member variable
void	setReturnOutput()	Configure if you want the html returned or leave it up to atkOutput.
instance	&_instance()	Create instance of controller (determined by class variable) if not yet created, return instance of atkcontroller

[ Top ]

Properties

Array $m_hidden_vars = array() [line 76]

Key/value Array containing which are be send als post or get vars

API Tags:

Access:

private

[ Top ]

String $m_module_name [line 39]

The module of the wizard.

API Tags:

Access:

protected

[ Top ]

String $m_name [line 31]

The name of the wizard.

API Tags:

Access:

protected

[ Top ]

unknown_type $m_node = NULL [line 46]

Reference to the instance of currently selected atkNode

[ Top ]

string $m_php_file = "" [line 60]

The file to use when creating url's

[ Top ]

array $m_postvars = NULL [line 53]

The postvars in this pageload

[ Top ]

unknown_type $m_return_output = false [line 69]

By this property is determined if the output of the handleRequest method should be returned as a string or the output should be outputted by atkOutput.

[ Top ]

Methods

Constructor atkController [line 84]

atkController atkController(
)

Constructor of atkController

API Tags:

Return:

object

[ Top ]

accessDeniedPage [line 333]

String accessDeniedPage(
)

Render a generic access denied page.

API Tags:

Return:

A complete html page with generic access denied message.

[ Top ]

actionPageTitle [line 412]

string actionPageTitle(
)

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

API Tags:

Return:

The title

Redefined in descendants as:

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

[ Top ]

createInstance [line 150]

object &createInstance(
string
$controller 
)

Return the one and only instance of the class

Parameters:

string

$controller:

The class of the controller to instanciate

[ Top ]

dispatch [line 243]

void dispatch(
array
$postvars, [integer
$flags = NULL] 
)

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

Parameters:

array	$postvars:
integer	$flags:

[ Top ]

dispatchUrl [line 466]

string dispatchUrl(
[
$params = array()], [string
$atknodetype = ""], [string
$file = ""], string
$params: 
)

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

Parameters:

string	$params::	A key/value array with extra options for the url
string	$atknodetype:	The atknodetype (modulename.nodename)
string	$file:	The php file to use for dispatching, defaults to dispatch.php
	$params:

API Tags:

Return:

url for the node with the action

[ Top ]

feedbackUrl [line 439]

String feedbackUrl(
String
$action, int
$status, [array
$record = ""], [String
$message = ""], [integer
$levelskip = 1] 
)

Determine the url for the feedbackpage.

Output is dependent on the feedback configuration. If feedback is not enabled for the action, this method returns an empty string, so the result of this method can be passed directly to the redirect() method after completing the action.

The $record parameter is ignored by the default implementation, but derived classes may override this method to perform record-specific feedback.

Parameters:

String	$action:	The action that was performed
int	$status:	The status of the action.
array	$record:	The record on which the action was performed.
String	$message:	An optional message to pass to the feedbackpage, for example to explain the reason why an action failed.
integer	$levelskip:	The number of levels to skip

API Tags:

Return:

The feedback url.

[ Top ]

genericPage [line 358]

String genericPage(
String
$title, mixed
$content 
)

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

Parameters:

String	$title:	The pagetitle and if $content is a string, also the boxtitle.
mixed	$content:	The content to display on the page. This can be: A string which will be the content of a single box on the page. An associative array of $boxtitle=>$boxcontent pairs. Each pair will be rendered as a seperate box.

API Tags:

Return:

A complete html page with the desired content.

[ Top ]

getButton [line 562]

HTML getButton(
String
$action, [Bool
$default = false], [
$label = null] 
)

Create a button.

Parameters:

String	$action:
Bool	$default:	Add the atkdefaultbutton class?
	$label:

[ Top ]

getDialogButton [line 628]

HTML getDialogButton(
String
$action, [String
$label = null], [String
$url = null], [array
$extraParams = array()] 
)

Create a dialog button.

Parameters:

String	$action:	The action ('save' or 'cancel')
String	$label:	The label for this button
String	$url:
array	$extraParams:

[ Top ]

getFormButtons [line 488]

void getFormButtons(
String
$mode, array
$record 
)

Returns the form buttons for a certain page.

Can be overridden by derived classes to define custom buttons.

Parameters:

String	$mode:	The action for which the buttons are retrieved.
array	$record:	The record currently displayed/edited in the form. This param can be used to define record specific buttons.

Redefined in descendants as:

atkWizardBase::getFormButtons() : Returns the form buttons for a certain page.

[ Top ]

getHiddenVars [line 670]

array getHiddenVars(
)

Return m_hidden_vars array.

[ Top ]

getHiddenVarsString [line 703]

string getHiddenVarsString(
)

Return m_hidden_vars as html input types.

[ Top ]

getHtmlTitle [line 228]

void getHtmlTitle(
)

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

API Tags:

Access:

protected

[ Top ]

getInstance [line 137]

atkController &getInstance(
)

Return the one and only instance of the class

[ Top ]

getModuleName [line 816]

string getModuleName(
)

Return module name of controller

API Tags:

Return:

module name

[ Top ]

getName [line 826]

string getName(
)

Return controller name

API Tags:

Return:

controller name

[ Top ]

getNode [line 265]

reference &getNode(
)

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

API Tags:

Return:

to atknode

[ Top ]

getPage [line 739]

object reference &getPage(
)

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

[ Top ]

getPhpFile [line 690]

string getPhpFile(
)

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

API Tags:

Return:

The name of the file to which subsequent requests should be posted.

[ Top ]

getReturnOutput [line 728]

bool getReturnOutput(
)

Return the setting for returning output

[ Top ]

getUi [line 751]

atkUi &getUi(
)

Get the ui instance for drawing and templating purposes.

API Tags:

Return:

An atkUi instance for drawing and templating.

[ Top ]

handleRequest [line 175]

void handleRequest(
array
$postvars, [string
$flags = NULL] 
)

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

The method looks at the atkaction from the postvars and determines what should be done. If possible, it instantiates actionHandlers for handling the actual action.

Parameters:

array	$postvars:	The request variables for the node.
string	$flags:	Render flags (see class atkPage).

Redefined in descendants as:

atkWizard::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.

[ Top ]

invoke [line 790]

mixed invoke(
String
$methodname 
)

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

Controller methods invoked with invoke() instead of directly, have a major advantage: the controller automatically searches for an override in the node. For example, If a controller calls its getSomething() method using the invoke method, the node may implement its own version of getSomething() and that method will then be called instead of the original. The controller is passed by reference to the override function as first parameter, so if necessary, you can call the original method from inside the override.

The function accepts a variable number of parameters. Any parameter that you would pass to the method, can be passed to invoke(), and invoke() will pass the parameters on to the method.

There is one limitation: you can't pass parameters by reference if you use invoke().

Example:

$controller->invoke("dispatch", $postvars, $fullpage);

This will call dispatch(&$handler, $postvars, $flags) on your node class if present, or dispatch($postvars, $flags) in the handler if the node has no override.

Parameters:

String

$methodname:

The name of the method to call.

API Tags:

Return:

The method returns the return value of the invoked method.

[ Top ]

loadDispatchPage [line 297]

void loadDispatchPage(
array
$postvars 
)

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

Parameters:

array

$postvars:

The request variables for the node.

[ Top ]

renderActionPage [line 393]

String renderActionPage(
String
$action, [mixed
$blocks = array()] 
)

Render a generic action.

Renders actionpage.tpl for the desired action. This includes the given block(s) and a pagetrial, but not a box.

Parameters:

String	$action:	The action for which the page is rendered.
mixed	$blocks:	Pieces of html content to be rendered. Can be a single string with content, or an array with multiple content blocks.

API Tags:

Return:

Piece of HTML containing the given blocks and a pagetrail.

[ Top ]

setHiddenVar [line 660]

void setHiddenVar(
string
$name, string
$value 
)

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

Parameters:

string	$name:	the reference key
string	$value:	the actual value

[ Top ]

setNode [line 255]

void setNode(

&$node, object
$node 
)

Set m_node variable of this class

Parameters:

object	$node:
	&$node:

[ Top ]

setPhpFile [line 680]

void setPhpFile(
string
$phpfile 
)

Set php_file member variable

Parameters:

string

$phpfile:

[ Top ]

setReturnOutput [line 718]

void setReturnOutput(
bool
$returnOutput 
)

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

Parameters:

bool

$returnOutput:

[ Top ]

_instance [line 107]

instance &_instance(
[string
$class = ""], [boolean
$replace = false] 
)

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

Parameters:

string	$class:
boolean	$replace:

API Tags:

Return:	of controller
Access:	private

[ Top ]