Docs For Class atkDeleteHandler

Home

Documentation home

Atk index

Docs For Class atkDeleteHandler [ package: atk ]

Class: atkDeleteHandler

Source Location: /handlers/class.atkdeletehandler.inc

Class atkDeleteHandler

Class Overview

Handler for the 'delete' action of a node. It asks the user for confirmation and upon actual confirmation, deletes the record (and for any attribute that has AF_CASCADE_DELETE set, deletes any detail information (if any) by calling the attributes' delete() method.

Located in /handlers/class.atkdeletehandler.inc [line 30]

Wiki documentation

atkActionHandler
   |
   --atkDeleteHandler

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkActionHandler atkActionHandler::$m_action atkActionHandler::$m_boxTemplate 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::getCSRFToken() Get/generate CSRF token for the current session stack. 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::isValidCSRFToken() Checks whatever the given CSRF token matches the one stored in the session stack. atkActionHandler::modifyDataGrid() Modify grid. 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::setBoxTemplate() 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_boxTemplate

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::getCSRFToken()

Get/generate CSRF token for the current session stack.

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::isValidCSRFToken()

Checks whatever the given CSRF token matches the one stored in the session stack.

atkActionHandler::modifyDataGrid()

Modify grid.

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::setBoxTemplate()

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 ]

Method Summary

void	action_delete()	The action handler.
bool	checkAttributes()	Checks with each of the attributes of the node whose record is about to be deleted
boolean	_checkAllowed()	Check if we are allowed to remove the given records.
bool	_checkLocked()	We check if the node is locked, if it is, we display the locked page,
void	_doDelete()	Given an confirmed delete, determine where the record needs to be deleted (session or dabase), delete it and redirect to the feedback url.
mixed	_doDeleteDb()	Delete the record in the database
bool	_doDeleteSession()	Delete the database in the session
void	_handleCancelAction()

[ Top ]

Properties

Methods

action_delete [line 35]

void action_delete(
)

The action handler.

[ Top ]

checkAttributes [line 193]

bool checkAttributes(
)

Checks with each of the attributes of the node whose record is about to be deleted

if they allow the deletion

API Tags:

Return:

wether or not the attributes have allowed deletion

[ Top ]

_checkAllowed [line 85]

boolean _checkAllowed(
)

Check if we are allowed to remove the given records.

API Tags:

Return:

is delete action allowed?

[ Top ]

_checkLocked [line 163]

bool _checkLocked(
)

We check if the node is locked, if it is, we display the locked page,

if it's not but it uses the locking feature, we lock it

API Tags:

Return:

wether or not we displayed the 'locked' page

[ Top ]

_doDelete [line 109]

void _doDelete(
)

Given an confirmed delete, determine where the record needs to be deleted (session or dabase), delete it and redirect to the feedback url.

API Tags:

Access:

protected

[ Top ]

_doDeleteDb [line 131]

mixed _doDeleteDb(
)

Delete the record in the database

API Tags:

Return:	Results, true or string with errormessage
Access:	protected

[ Top ]

_doDeleteSession [line 152]

bool _doDeleteSession(
)

Delete the database in the session

API Tags:

Return:	Results, true or false
Access:	protected

[ Top ]

_handleCancelAction [line 73]

void _handleCancelAction(
)

API Tags:

Access:

protected

[ Top ]