Docs For Class atkExportHandler

Home

Documentation home

Atk index

Docs For Class atkExportHandler [ package: atk ]

Class: atkExportHandler

Source Location: /handlers/class.atkexporthandler.inc

Class atkExportHandler

Class Overview

Handler for the 'import' action of a node. The import action is a generic tool for importing CSV files into a table.

Located in /handlers/class.atkexporthandler.inc [line 28]

Wiki documentation

atkActionHandler
   |
   --atkExportHandler

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_export()	The action handler.
void	deleteSelection()	Delete record
void	doExport()	the real import function
void	doInit()	This function shows a form to configure the .csv
void	doProcess()	This function checks if there is enough information to export the date
String	getAttributeSelect()	Get all attributes to select for the export
array	getExportAttributes()	Return all attributes that can be exported
string	getExportSelectionDropdown()	Build the dropdown field to add the exportselections
array	getExportSelections()	Determine the export selections that should be displayed
array	getUsableAttributes()	Gives all the attributes that can be used for the import
string	partial_export()	Handle partial request
string	partial_selection_interact()	Partial displays a interaction possibilities with an export selection
string	partial_selection_name()	Partial fetches and displays the name of the selected value
null	saveSelection()	Store selectiondetails in the database
null	updateSelection()	Update selectiondetails in the database
String	_getInitHtml()	Gets the HTML for the initial mode of the exporthandler
unknown	_getOptions()	Get the options for the export

[ Top ]

Properties

Methods

action_export [line 33]

void action_export(
)

The action handler.

[ Top ]

deleteSelection [line 370]

void deleteSelection(
integer
$id 
)

Delete record

Parameters:

integer

$id:

API Tags:

Access:

private

[ Top ]

doExport [line 515]

void doExport(
)

the real import function

import the uploaded csv file for real

[ Top ]

doInit [line 74]

void doInit(
)

This function shows a form to configure the .csv

[ Top ]

doProcess [line 213]

void doProcess(
)

This function checks if there is enough information to export the date

else it wil shows a form to set how the file wil be exported

[ Top ]

getAttributeSelect [line 402]

String getAttributeSelect(
)

Get all attributes to select for the export

API Tags:

Return:

HTML code with checkboxes for each attribute to select

[ Top ]

getExportAttributes [line 505]

array getExportAttributes(
)

Return all attributes that can be exported

API Tags:

Return:

Array with attribs that needs to be exported

[ Top ]

getExportSelectionDropdown [line 272]

string getExportSelectionDropdown(
)

Build the dropdown field to add the exportselections

API Tags:

Access:

private

[ Top ]

getExportSelections [line 381]

array getExportSelections(
)

Determine the export selections that should be displayed

API Tags:

Access:

protected

[ Top ]

getUsableAttributes [line 443]

array getUsableAttributes(
)

Gives all the attributes that can be used for the import

API Tags:

Return:

the attributes

[ Top ]

partial_export [line 137]

string partial_export(
)

Handle partial request

API Tags:

Access:

public

[ Top ]

partial_selection_interact [line 171]

string partial_selection_interact(
)

Partial displays a interaction possibilities with an export selection

API Tags:

Access:

public

[ Top ]

partial_selection_name [line 148]

string partial_selection_name(
)

Partial fetches and displays the name of the selected value

API Tags:

Access:

public

[ Top ]

saveSelection [line 298]

null saveSelection(
)

Store selectiondetails in the database

API Tags:

Access:

private

[ Top ]

updateSelection [line 332]

null updateSelection(
)

Update selectiondetails in the database

API Tags:

Access:

private

[ Top ]

_getInitHtml [line 191]

String _getInitHtml(
)

Gets the HTML for the initial mode of the exporthandler

API Tags:

Return:

The HTML for the screen

[ Top ]

_getOptions [line 245]

unknown _getOptions(
)

Get the options for the export

[ Top ]