Docs For Class atkUpdatehandler

Home

Documentation home

Atk index

Docs For Class atkUpdatehandler [ package: atk ]

Class: atkUpdatehandler

Source Location: /handlers/class.atkupdatehandler.inc

Class atkUpdatehandler

Class Overview

Handler class for the update action of a node. The action saves an existing record to the database. The data is retrieved from the postvars.

This is the action that follows an 'edit' action. The 'edit' action draws the edit form, the 'update' action saves the data to the database. Validation of the record is performed before storage. If validation fails, the edit handler is invoked again.

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

Wiki documentation

atkActionHandler
   |
   --atkUpdatehandler

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Todo:

Add locking check for when an application calls an action_update on a locked node

Properties

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 ]

Property Summary

mixed	$m_dialogSaveUrl
string	$m_editAction	Edit action.

[ Top ]

Method Summary

void	action_update()	The action handler method.
void	doUpdate()	Perform the update action
string	getEditAction()	Returns the edit action, which is called when we want to return the user to the edit form.
String	getEditPage()	This method is obsolete. Do not use it. It is only here for backwards compatibility...
Array	getRecord()	Get the record for updating
void	handleAccessDenied()	Called when the acces to this action was denied for the current user.
void	handleCancel()	Called when the user clicks cancel
bool	handleProcess()	Process a record (preUpdate/validate/store)
void	handleUpdate()	Handle the update of a dialog.
void	handleUpdateError()	Handle update error. This can either be an error in the record data the user can correct or a fatal error when saving the record in the database. If the latter is the case the $error parameter is set.
void	handleUpdateSuccess()	Handle update success. Normally redirects the user either back to the edit form (when the user only saved) or back to the previous action if the user choose save and close.
bool	hasError()	Check if there is an error (this can be determined by the variable atkerror in the record).
void	loadEditDialogWithErrors()	Update the edit dialog for a failed update
void	loadSuccessDialog()
void	partial_dialog()	Handle the dialog partial
void	renderEditPage()	This method is obsolete. Do not use it. It is only here for backward compatibility...
void	setDialogSaveUrl()	Override the dialog save url
void	setEditAction()	Sets the edit action which should be called when we need to return the user to the edit form.
mixed	updateRecord()	Update a record, determines wether to update it to the session or the database
mixed	updateRecordInDb()	Update a record in the database
mixed	updateRecordInSession()	Update a record in the session

[ Top ]

Properties

mixed $m_dialogSaveUrl [line 34]

API Tags:

Access:

public

[ Top ]

string $m_editAction = 'edit' [line 41]

Edit action.

API Tags:

Access:

private

[ Top ]

Methods

action_update [line 46]

void action_update(
)

The action handler method.

API Tags:

Access:

public

[ Top ]

doUpdate [line 89]

void doUpdate(
)

Perform the update action

API Tags:

Access:

public

[ Top ]

getEditAction [line 70]

string getEditAction(
)

Returns the edit action, which is called when we want to return the user to the edit form.

Defaults to the 'edit' action.

API Tags:

Return:	edit action
Access:	public

[ Top ]

getEditPage [line 467]

String getEditPage(

&$record, Array
$record 
)

This method is obsolete. Do not use it. It is only here for backwards compatibility...

Parameters:

Array	$record:
	&$record:

API Tags:

Return:	HTML code for the edit page
Deprecated:
Access:	public

[ Top ]

getRecord [line 140]

Array getRecord(
)

Get the record for updating

API Tags:

Return:	The record to update
Access:	public

[ Top ]

handleAccessDenied [line 149]

void handleAccessDenied(
)

Called when the acces to this action was denied for the current user.

API Tags:

Access:

public

[ Top ]

handleCancel [line 159]

void handleCancel(
array
$record 
)

Called when the user clicks cancel

Parameters:

array

$record:

API Tags:

Access:

public

[ Top ]

handleProcess [line 174]

bool handleProcess(
array
$record, [string
$errorHandler = 'handleUpdateError'], [string
$successHandler = "handleUpdateSuccess"], [array
$extraParams = array()] 
)

Process a record (preUpdate/validate/store)

Parameters:

array	$record:	Record to store
string	$errorHandler:	Error handler method to call on current handler
string	$successHandler:	Success handler method to call on current handler
array	$extraParams:	Extra params to pass along to error/success handler methods

API Tags:

Return:	Wether the process succeeded in storing the record
Access:	public

[ Top ]

handleUpdate [line 372]

void handleUpdate(
[String
$attrRefreshUrl = null] 
)

Handle the update of a dialog.

Parameters:

String

$attrRefreshUrl:

API Tags:

Access:

public

[ Top ]

handleUpdateError [line 304]

void handleUpdateError(
array
$record, [string
$error = null] 
)

Handle update error. This can either be an error in the record data the user can correct or a fatal error when saving the record in the database. If the latter is the case the $error parameter is set.

This method can be overriden inside your node.

Parameters:

array	$record:
string	$error:	error string (only on fatal errors)

API Tags:

Access:

public

[ Top ]

handleUpdateSuccess [line 328]

void handleUpdateSuccess(
array
$record 
)

Handle update success. Normally redirects the user either back to the edit form (when the user only saved) or back to the previous action if the user choose save and close.

This method can be overriden inside your node.

Parameters:

array

$record:

the record

API Tags:

Access:

public

[ Top ]

hasError [line 218]

bool hasError(
array
$record 
)

Check if there is an error (this can be determined by the variable atkerror in the record).

Parameters:

array

$record:

Record to check for errors

API Tags:

Return:	Error detected?
Access:	public

[ Top ]

loadEditDialogWithErrors [line 420]

void loadEditDialogWithErrors(
array
$record 
)

Update the edit dialog for a failed update

Parameters:

array

$record:

Record that failed update

API Tags:

Access:

private

[ Top ]

loadSuccessDialog [line 396]

void loadSuccessDialog(

$record, 
$extraParams, unknown_type
$attrRefreshUrl 
)

Parameters:

unknown_type	$attrRefreshUrl:
	$record:
	$extraParams:

API Tags:

Access:

private

Information Tags:

Todo:	document.location.href is problematic if you already clicked the save action on a normal edit page. If you use the editdialog after that and you save the dialog, the page will redirect to the index page of the application.
Todo:	refresh only the recordlist not the full page.

[ Top ]

partial_dialog [line 352]

void partial_dialog(
String
$mode 
)

Handle the dialog partial

Parameters:

String

$mode:

The current mode

[ Top ]

renderEditPage [line 448]

void renderEditPage(

&$record, array
$record 
)

This method is obsolete. Do not use it. It is only here for backward compatibility...

Render an editpage

We have to make the entire system think we are in edit mode again.

Parameters:

array	$record:
	&$record:

API Tags:

Deprecated:

[ Top ]

setDialogSaveUrl [line 362]

void setDialogSaveUrl(
string
$url 
)

Override the dialog save url

Parameters:

string

$url:

dialog save URL

[ Top ]

setEditAction [line 81]

void setEditAction(
string
$action 
)

Sets the edit action which should be called when we need to return the user to the edit form.

Parameters:

string

$action:

action name

API Tags:

Access:

public

[ Top ]

updateRecord [line 238]

mixed updateRecord(

&$record, array
$record 
)

Update a record, determines wether to update it to the session or the database

Parameters:

array	$record:	Record to update
	&$record:

API Tags:

Return:	Result of the update, true, false or string with error
Access:	private

[ Top ]

updateRecordInDb [line 257]

mixed updateRecordInDb(

&$record, array
$record 
)

Update a record in the database

Parameters:

array	$record:	Record to update
	&$record:

API Tags:

Return:	Result of the update, true, false or string with error
Access:	private

[ Top ]

updateRecordInSession [line 286]

mixed updateRecordInSession(
array
$record 
)

Update a record in the session

Parameters:

array

$record:

Record to update

API Tags:

Return:	Result of the update, true or false
Access:	private

[ Top ]