Docs For Class atkAdminHandler

Home

Documentation home

Atk index

Docs For Class atkAdminHandler [ package: atk ]

Class: atkAdminHandler

Source Location: /handlers/class.atkadminhandler.inc

Class atkAdminHandler

Class Overview

Handler for the 'admin' action of a node. It displays a recordlist with existing records, and links to view/edit/delete them (or custom actions if present), and an embedded addform or a link to an addpage (depending on the presence of the NF_ADD_LINK or NF_ADD_DIALOG flag).

Located in /handlers/class.atkadminhandler.inc [line 32]

Wiki documentation

atkActionHandler
   |
   --atkAdminHandler

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Properties

$m_actionSessionStatus

Methods

[ Top ]

Descendants

Child Class	Description
atkMultiSelectHandler	Handler class for the select action of a node. The handler draws a generic select form for searching through the records and selecting multiple records.

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkActionHandler atkActionHandler::$m_action atkActionHandler::$m_node atkActionHandler::$m_partial atkActionHandler::$m_rejecting atkActionHandler::$m_renderBoxVars atkActionHandler::$m_renderMode atkActionHandler::$m_returnbehaviour	Inherited From atkActionHandler atkActionHandler::atkActionHandler() Default constructor. atkActionHandler::addRenderBoxVar() Add a variable to the renderbox atkActionHandler::allowed() Current action allowed on the given record? atkActionHandler::clearCache() Clear the recordlist cache atkActionHandler::closeDialog() Output JavaScript to close the dialog. atkActionHandler::getDefaultHandler() Static factory method to get the default action handler for a certain action. atkActionHandler::getNode() Returns the node object. atkActionHandler::getPage() Get the page instance for generating output. atkActionHandler::getRecordlistCache() Get the cached recordlist atkActionHandler::getRejectInfo() Get the reject info from the session This is used by the atkAddHandler and atkEditHandler to show the validation errors atkActionHandler::getRenderMode() Returns the render mode. atkActionHandler::getReturnBehaviour() Get the returnbehaviour of this action atkActionHandler::getUi() Get the ui instance for drawing and templating purposes. atkActionHandler::handle() The handle() method handles the action. atkActionHandler::invoke() Generic method invoker. atkActionHandler::notify() Notify the node that an action has occured atkActionHandler::partial() Handle partial. atkActionHandler::renderAccessDeniedDialog() Render access denied dialog contents. atkActionHandler::renderAccessDeniedPage() Render access denied page. atkActionHandler::renderMessageDialog() Render message dialog contents. atkActionHandler::setAction() Sets the current action. atkActionHandler::setNode() Set the calling node of the current action. atkActionHandler::setPostvars() Set postvars of the the calling node of the current action. atkActionHandler::setRejectInfo() Store the reject info in the session This is used by the atkSaveHandler and atkUpdateHandler to store the record if the record is not validated atkActionHandler::setRenderMode() Sets the render mode ("box" or "dialog"). atkActionHandler::setReturnBehaviour() Set the returnbehaviour of this action atkActionHandler::updateDialog() Outputs JavaScript for updating the existing dialog contents. atkActionHandler::_getAccessDeniedPage() Get the access denied page

Inherited Properties

Inherited Methods

Inherited From atkActionHandler

atkActionHandler::$m_action

atkActionHandler::$m_node

atkActionHandler::$m_partial

atkActionHandler::$m_rejecting

atkActionHandler::$m_renderBoxVars

atkActionHandler::$m_renderMode

atkActionHandler::$m_returnbehaviour

Inherited From atkActionHandler

atkActionHandler::atkActionHandler()

Default constructor.

atkActionHandler::addRenderBoxVar()

Add a variable to the renderbox

atkActionHandler::allowed()

Current action allowed on the given record?

atkActionHandler::clearCache()

Clear the recordlist cache

atkActionHandler::closeDialog()

Output JavaScript to close the dialog.

atkActionHandler::getDefaultHandler()

Static factory method to get the default action handler for a certain action.

atkActionHandler::getNode()

Returns the node object.

atkActionHandler::getPage()

Get the page instance for generating output.

atkActionHandler::getRecordlistCache()

Get the cached recordlist

atkActionHandler::getRejectInfo()

Get the reject info from the session This is used by the atkAddHandler and atkEditHandler to show the validation errors

atkActionHandler::getRenderMode()

Returns the render mode.

atkActionHandler::getReturnBehaviour()

Get the returnbehaviour of this action

atkActionHandler::getUi()

Get the ui instance for drawing and templating purposes.

atkActionHandler::handle()

The handle() method handles the action.

atkActionHandler::invoke()

Generic method invoker.

atkActionHandler::notify()

Notify the node that an action has occured

atkActionHandler::partial()

Handle partial.

atkActionHandler::renderAccessDeniedDialog()

Render access denied dialog contents.

atkActionHandler::renderAccessDeniedPage()

Render access denied page.

atkActionHandler::renderMessageDialog()

Render message dialog contents.

atkActionHandler::setAction()

Sets the current action.

atkActionHandler::setNode()

Set the calling node of the current action.

atkActionHandler::setPostvars()

Set postvars of the the calling node of the current action.

atkActionHandler::setRejectInfo()

Store the reject info in the session This is used by the atkSaveHandler and atkUpdateHandler to store the record if the record is not validated

atkActionHandler::setRenderMode()

Sets the render mode ("box" or "dialog").

atkActionHandler::setReturnBehaviour()

Set the returnbehaviour of this action

atkActionHandler::updateDialog()

Outputs JavaScript for updating the existing dialog contents.

atkActionHandler::_getAccessDeniedPage()

Get the access denied page

[ Top ]

Property Summary

mixed

$m_actionSessionStatus

[ Top ]

Method Summary

void	action_admin()	The action method
String	addPage()	Draws the form for adding new records.
String	adminFooter()	Function that is called when creating an adminPage.
String	adminHeader()	Function that is called when creating an adminPage.
String	adminPage()	Admin page displays records and the actions that can be performed on them (edit, delete)
String	getAddLink()	Get the add link to add to the admin header
String	getExportLink()	Get the exportlink to add to the admin header
String	getHeaderLinks()	Get all links to add to the admin header
String	getImportLink()	Get the importlink to add to the admin header
void	modifyDataGrid()	Modify grid.
void	partial_attribute()	Attribute handler.
string	partial_datagrid()	Update the admin datagrid.
void	partial_dialog()	Dialog handler.
boolean	redirectToSearchAction()	If a search action has been defined and a search only returns one result the user will be automatically redirected to the search action.
String	renderAdminList()	Renders the recordlist for the admin mode
array	renderAdminPage()	Render the adminpage, including addpage if necessary
void	setActionSessionStatus()	Sets the action session status for actions in the recordlist.

[ Top ]

Properties

mixed $m_actionSessionStatus = SESSION_NESTED [line 34]

[ Top ]

Methods

action_admin [line 39]

void action_admin(
)

The action method

[ Top ]

addPage [line 93]

String addPage(
[array
$record = NULL] 
)

Draws the form for adding new records.

The implementation delegates drawing of the form to the atkAddHandler.

Parameters:

array

$record:

The record

API Tags:

Return:

A box containing the add page.

[ Top ]

adminFooter [line 288]

String adminFooter(
)

Function that is called when creating an adminPage.

The default implementation returns an empty string, but developers can override this function in their custom handlers or directly in the node class.

API Tags:

Return:

A string that is displayed below the recordlist.

[ Top ]

adminHeader [line 274]

String adminHeader(
)

Function that is called when creating an adminPage.

The default implementation returns an empty string, but developers can override this function in their custom handlers or directly in the node class.

API Tags:

Return:

A string that is displayed above the recordlist.

[ Top ]

adminPage [line 113]

String adminPage(
[array
$actions = ""] 
)

Admin page displays records and the actions that can be performed on them (edit, delete)

Parameters:

array

$actions:

The list of actions displayed next to each record. Nodes can implement a recordActions($record, &$actions, &$mraactions) method to add/remove record-specific actions.

API Tags:

Return:

A box containing the admin page (without the add form, which is added later.

[ Top ]

getAddLink [line 334]

String getAddLink(
)

Get the add link to add to the admin header

API Tags:

Return:

HTML code with link to the add action of the node (if allowed)

[ Top ]

getExportLink [line 313]

String getExportLink(
)

Get the exportlink to add to the admin header

API Tags:

Return:

HTML code with link to the export action of the node (if allowed)

[ Top ]

getHeaderLinks [line 381]

String getHeaderLinks(
)

Get all links to add to the admin header

API Tags:

Return:

String with the HTML code of the links (each link separated with |)

[ Top ]

getImportLink [line 298]

String getImportLink(
)

Get the importlink to add to the admin header

API Tags:

Return:

HTML code with link to the import action of the node (if allowed)

[ Top ]

modifyDataGrid [line 200]

void modifyDataGrid(
atkDataGrid
$grid, int
$mode 
)

Modify grid.

Parameters:

atkDataGrid	$grid:	grid
int	$mode:	CREATE or RESUME

API Tags:

Access:

protected

[ Top ]

partial_attribute [line 408]

void partial_attribute(
string
$partial 
)

Attribute handler.

Parameters:

string

$partial:

full partial

[ Top ]

partial_datagrid [line 170]

string partial_datagrid(
)

Update the admin datagrid.

API Tags:

Return:	new grid html
Access:	public

[ Top ]

partial_dialog [line 396]

void partial_dialog(
)

Dialog handler.

[ Top ]

redirectToSearchAction [line 216]

boolean redirectToSearchAction(
atkDataGrid
$grid 
)

If a search action has been defined and a search only returns one result the user will be automatically redirected to the search action.

Parameters:

atkDataGrid

$grid:

data grid

API Tags:

Return:	redirect active?
Access:	protected

[ Top ]

renderAdminList [line 138]

String renderAdminList(
[Array
$actions = ""] 
)

Renders the recordlist for the admin mode

Parameters:

Array

$actions:

An array with the actions for the admin mode

API Tags:

Return:

The HTML for the admin recordlist

[ Top ]

renderAdminPage [line 68]

array renderAdminPage(
)

Render the adminpage, including addpage if necessary

API Tags:

Return:

with result of adminPage and addPage

[ Top ]

setActionSessionStatus [line 58]

void setActionSessionStatus(
Integer
$sessionStatus 
)

Sets the action session status for actions in the recordlist.

(Defaults to SESSION_NESTED).

Parameters:

Integer

$sessionStatus:

The sessionstatus (for example SESSION_REPLACE)

[ Top ]