Docs For Class atkSaveHandler

Home

Documentation home

Atk index

Docs For Class atkSaveHandler [ package: atk ]

Class: atkSaveHandler

Source Location: /handlers/class.atksavehandler.inc

Class atkSaveHandler

Class Overview

Handler class for the save action of a node. The action saves a new record to the database. The data is retrieved from the postvars.

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

Located in /handlers/class.atksavehandler.inc [line 33]

Wiki documentation

atkActionHandler
   |
   --atkSaveHandler

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Properties

$m_dialogSaveUrl

Methods

[ 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_dialogSaveUrl

[ Top ]

Method Summary

void	action_save()	The action handler method
void	doSave()	Save record.
string	getSuccessReturnURL()	Get the URL to redirect to after successfully saving a record.
void	goBack()	Go back to the add page
void	handleAddError()	Handle error in preAdd/addDb.
void	handleSave()	Handle save of dialog.
html	partial_dialog()	The handler for the dialog partial call.
void	setDialogSaveUrl()	Override the dialog save url
bool	storeRecord()	Store a record, either in the database or in the session
bool	storeRecordInDb()	Store a record in the database
bool	storeRecordInSession()	Store a record in the session
void	validate()	Validate record.
Integer	_getSkip()	Get the number of levels to skip

[ Top ]

Properties

mixed $m_dialogSaveUrl [line 35]

[ Top ]

Methods

action_save [line 40]

void action_save(
)

The action handler method

[ Top ]

doSave [line 61]

void doSave(
)

Save record.

[ Top ]

getSuccessReturnURL [line 123]

string getSuccessReturnURL(
array
$record 
)

Get the URL to redirect to after successfully saving a record.

Parameters:

array

$record:

Saved record

API Tags:

Return:	Location to redirect to
Access:	private

[ Top ]

goBack [line 257]

void goBack(
Array
$record 
)

Go back to the add page

Parameters:

Array

$record:

The record with reject info

[ Top ]

handleAddError [line 217]

void handleAddError(
array
$record 
)

Handle error in preAdd/addDb.

Parameters:

array

$record:

[ Top ]

handleSave [line 291]

void handleSave(
[string
$attrRefreshUrl = ''] 
)

Handle save of dialog.

Parameters:

string

$attrRefreshUrl:

the attribute refresh url if not specified the entire page is refreshed

[ Top ]

partial_dialog [line 358]

html partial_dialog(
)

The handler for the dialog partial call.

[ Top ]

setDialogSaveUrl [line 368]

void setDialogSaveUrl(
string
$url 
)

Override the dialog save url

Parameters:

string

$url:

dialog save URL

[ Top ]

storeRecord [line 170]

bool storeRecord(

&$record, array
$record 
)

Store a record, either in the database or in the session

Parameters:

array	$record:	Record to store
	&$record:

API Tags:

Return:	Successfull save?
Access:	private

[ Top ]

storeRecordInDb [line 201]

bool storeRecordInDb(

&$record, array
$record 
)

Store a record in the database

Parameters:

array	$record:	Record to store in the database
	&$record:

API Tags:

Return:	Successfull save?
Access:	private

[ Top ]

storeRecordInSession [line 188]

bool storeRecordInSession(

&$record, array
$record 
)

Store a record in the session

Parameters:

array	$record:	Record to store in the session
	&$record:

API Tags:

Return:	Successfull save?
Access:	private

[ Top ]

validate [line 268]

void validate(
Array
&$record 
)

Validate record.

Parameters:

Array

&$record:

The record to validate

[ Top ]

_getSkip [line 242]

Integer _getSkip(
)

Get the number of levels to skip

API Tags:

Return:

The number of levels to skip

[ Top ]