Docs For Class atkAddOrCopyHandler

Home

Documentation home

Atk index

Docs For Class atkAddOrCopyHandler [ package: atk ]

Class: atkAddOrCopyHandler

Source Location: /handlers/class.atkaddorcopyhandler.inc

Class atkAddOrCopyHandler

Class Overview

Handler for the 'editcopy' action of a node. It copies the selected record, and then redirects to the edit action for the copied record.

Located in /handlers/class.atkaddorcopyhandler.inc [line 27]

Wiki documentation

atkActionHandler
   |
   --atkAddOrCopyHandler

Author(s):

Dennis Luitwieler <dennis@ibuildings.nl>

Information Tags:

Properties

$m_processUrl

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_processUrl

[ Top ]

Method Summary

static bool	hasCopyableRecords()	Returns true if there is something to copy. This is used to determine if we can skip the whole dialog and continue to the add page directly.
void	action_addorcopy()	The action method.
void	addOrCopyPage()	Add or copy page.
string	getAddOrCopyPage()	Returns the add or copy page contents.
string	getContent()	Returns the add or copy page contents.
string	getCopyDropDown()	Creates a drop-down with copyable records.
void	getCopyIncludes()	Returns a HTML fragment which allows the user to select nested one-to-many relations he/she wants to include in the copy.
string	getCopyOption()	Returns the copy option
string	getFormStart()	Returns the form start.
string	getNewOption()	Returns the new option.
string	getOptionLabel()	Returns the option label for the given action.
string	getProcessUrl()	Returns the process URL.
void	handleAdd()	Handle add.
void	handleCopy()	Handle copy.
void	handleDialog()	Handle dialog partial.
void	handleProcess()	Handle process partial.
void	preCopy()	Remove one-to-many relations which the user didn't explicitly select.
string	renderAddOrCopyPage()	Render the add or copy page using the given parameters.
void	setProcessUrl()	Override the default process URL.

[ Top ]

Properties

mixed $m_processUrl = null [line 29]

[ Top ]

Methods

static method hasCopyableRecords [line 334]

static bool hasCopyableRecords(

&$node, [string
$selector = ''], atkNode
$node 
)

Returns true if there is something to copy. This is used to determine if we can skip the whole dialog and continue to the add page directly.

Parameters:

atkNode	$node:	The node to check
string	$selector:	an extra selector to add to the count query
	&$node:

API Tags:

Return:

true when there are records to copy, false if there are none

[ Top ]

action_addorcopy [line 34]

void action_addorcopy(
)

The action method.

[ Top ]

addOrCopyPage [line 204]

void addOrCopyPage(
)

Add or copy page.

[ Top ]

getAddOrCopyPage [line 216]

string getAddOrCopyPage(
)

Returns the add or copy page contents.

API Tags:

Return:

add or copy page contents

[ Top ]

getContent [line 255]

string getContent(
)

Returns the add or copy page contents.

API Tags:

Return:

add or copy page contents

[ Top ]

getCopyDropDown [line 375]

string getCopyDropDown(
Array
$records 
)

Creates a drop-down with copyable records.

Parameters:

Array

$records:

Array with records

API Tags:

Return:

copyable records drop-down

[ Top ]

getCopyIncludes [line 396]

void getCopyIncludes(
atkNode
$node, [String
$prefix = ''], [Integer
$level = 0] 
)

Returns a HTML fragment which allows the user to select nested one-to-many relations he/she wants to include in the copy.

Parameters:

atkNode	$node:	The node to get the onetomany relations from
String	$prefix:	The field prefix
Integer	$level:	The level of the includes

[ Top ]

getCopyOption [line 345]

string getCopyOption(
)

Returns the copy option

API Tags:

Return:

option html;

[ Top ]

getFormStart [line 282]

string getFormStart(
)

Returns the form start.

API Tags:

Return:

form start

[ Top ]

getNewOption [line 316]

string getNewOption(
)

Returns the new option.

API Tags:

Return:

option html

[ Top ]

getOptionLabel [line 295]

string getOptionLabel(
string
$action 
)

Returns the option label for the given action.

Parameters:

string

$action:

action (copy or add)

API Tags:

Return:

option label for action

[ Top ]

getProcessUrl [line 429]

string getProcessUrl(
)

Returns the process URL.

API Tags:

Return:

process URL

[ Top ]

handleAdd [line 180]

void handleAdd(
)

Handle add.

[ Top ]

handleCopy [line 114]

void handleCopy(
[string
$attrRefreshUrl = null] 
)

Handle copy.

Parameters:

string

$attrRefreshUrl:

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

[ Top ]

handleDialog [line 51]

void handleDialog(
)

Handle dialog partial.

[ Top ]

handleProcess [line 61]

void handleProcess(
)

Handle process partial.

[ Top ]

preCopy [line 83]

void preCopy(

&$record, 
&$node, array
$includes, [string
$prefix = ""], array
$record, atkNode
$node 
)

Remove one-to-many relations which the user didn't explicitly select.

Parameters:

array	$record:	record
atkNode	$node:	node reference
array	$includes:	include list
string	$prefix:	current prefix
	&$record:
	&$node:

[ Top ]

renderAddOrCopyPage [line 237]

string renderAddOrCopyPage(
array
$params 
)

Render the add or copy page using the given parameters.

Parameters:

array

$params:

parameters

API Tags:

Return:

rendered page

[ Top ]

setProcessUrl [line 446]

void setProcessUrl(
string
$url 
)

Override the default process URL.

Parameters:

string

$url:

process URL

[ Top ]