Docs For Class atkActionHandler
Atk API home Class tree Element index

Todo list

Packages: » atk Classes: general » AllTests » atkConfig » atkController » atkDataNode » atkErrorHandlerBase » atkFileEditor » atkLanguage » atkMailErrorHandler » atkMetaNode » atkMockNode » atkNode » atkNodeValidator » atkOneToManyRelationSessionGridHandler » atkPHPView » atkSessionStore » atkStatementIterator » atkTreeNode » atkWizardBase » atkZendPlatformErrorHandler » clsTbsDataSource » clsTbsLocator » clsTinyButStrong » clsTinyButStrongOOo » FCKeditor » getSupportedLanguagesCollector » layout » node » sql_whereclause_blacklist_checker » test » tree utils » atkAbstractFrame » atkActionListener » atkClassFinder » atkClassLoader » atkCompatSelector » atkDataHolder » atkDebugger » atkDirectoryTraverser » atkEventLog » atkFileUtils » atkFrame » atkFrameSet » atkIpUtils » atkJSON » atkMail » atkMailer » atkMessageQueue » atkMLSelector » atkmlsplitter » atkRootFrameset » atkSelector » atkSelectorIterator » atkString » atkStringParser » atkTableRenderer » atkTableRendererGrouped » atkTextMarker » atkTmpFile » atkTriggerListener » atkYAML » atkZip » browserInfo fixture » atkAbstractFixtureLoader » atkFixtureManager » atkPHPFixtureLoader » atkYAMLFixtureLoader testcases » atkAbstractSearchHandler ui » atkActionBoxBuilder » atkDialog » atkIndexPage » atkOutput » atkPage » atkPageBuilder » atkTheme » atkThemeCompiler » atkUI handlers » atkActionHandler » atkAddHandler » atkAddOrCopyHandler » atkAdminHandler » atkAttributeEditHandler » atkCopyHandler » atkDeleteHandler » atkDocumentHandler » atkEditCopyHandler » atkEditHandler » atkExportHandler » atkFeedbackHandler » atkFileExport » atkImportHandler » atkMultiSelectHandler » atkMultiUpdatehandler » atkSaveHandler » atkSearchHandler » atkSelectHandler » atkSmartSearchHandler » atkUpdatehandler » atkViewEditBase » atkViewHandler » atkXmlHandler attributes » atkAggregatedColumn » atkAttribute » atkBoolAttribute » atkCalculatorAttribute » atkCaptchaAttribute » atkColorPickerAttribute » atkCountryAttribute » atkCreatedByAttribute » atkCreateStampAttribute » atkCurrencyAttribute » atkDateAttribute » atkDateTimeAttribute » atkDocumentAttribute » atkDummyAttribute » atkDurationAttribute » atkEmailAttribute » atkExpressionAttribute » atkFckAttribute » atkFieldSet » atkFileAttribute » atkFileWriterAttribute » atkFlagAttribute » atkFormatAttribute » atkFuzzySearchAttribute » atkHiddenAttribute » atkHtmlAttribute » atkIpAttribute » atkListAttribute » atkLiveTextPreview » atkMlAttribute » atkMlFckAttribute » atkMlHtmlAttribute » atkMlNumberAttribute » atkMlSelectorAttribute » atkMlTextAttribute » atkMlWrapper » atkMultipleFileAttribute » atkMultiSelectAttribute » atkNumberAttribute » atkParserAttribute » atkPasswordAttribute » atkProfileAttribute » atkRadioAttribute » atkRadioDetailsAttribute » atkRowCounter » atkStateAttribute » atkTabbedPane » atkTagAttribute » atkTextAttribute » atkTimeAttribute » atkTimeZoneAttribute » atkToolbar » atkUpdatedByAttribute » atkUpdateStampAttribute » atkUrlAttribute » atkWeekdayAttribute » atkWysiwygAttribute datatypes » atkArrayDt » atkDataType » atkStringDt » atkTime subpackage » atkAttributeTestCase security » atkBajusEncryption » atkBase64Encryption » atkEncryption » atkMockSecurityManager » atkOpenSSLEncryption » atkSecurityListener » atkSecurityManager » atkUrlVault » auth_config » auth_db » auth_imap » auth_interface » auth_ldap » auth_none » auth_pop3 » auth_saml » auth_server » auth_sspi cache » atkCache » atkCache_apc » atkCache_eaccelerator » atkCache_file » atkCache_memcache » atkCache_var » atkCache_xcache » atkCache_zp_disk » atkCache_zp_output » atkCache_zp_shm test » atkCacheTestCase » atkPluginTestCase » atkTestCase » test_sql_whereclause_blacklist_checker db » atkClusterDb » atkClusterDDL » atkClusterQuery » atkDb » atkdb2db » atkDb2DDL » atkDb2Query » atkDDL » atki5db » atki5DDL » atki5query » atkMockDb » atkMockDDL » atkMockQuery » atkMsSqlDb » atkMsSqlDDL » atkMssqlQuery » atkMysqlDb » atkMysqlDDL » atkMysqliDb » atkMysqliDDL » atkMysqliQuery » atkMysqlQuery » atkOci8Db » atkOci8DDL » atkOci8Query » atkOci9Db » atkOci9DDL » atkOci9Query » atkOci805Db » atkOci805Query » atkPgsqlDb » atkPgsqlDDL » atkPgsqlQuery » atkQuery recordlist » atkColumnConfig » atkCSVRecordList » atkCustomRecordList » atkExcelCSVRecordList » atkHTMLRecordList » atkPrintableRecordList » atkRecordList » atkRecordlistCache » atkTotalizer db-statement » atkCompatStatement » atkMySQLiStatement » atkStatement » atkStatementException » atkStatementParser console » atkConsoleController menu » atkcookmenu » atkDhtmlMenu » atkDropdownMenu » atkFramesMenu » atkMenu » atkmenuinterface » atkModernMenu » atkOutlookMenu » atkPlainMenu datagrid » atkDataGrid » atkDGComponent » atkDGEditControl » atkDGEvent » atkDGIndex » atkDGLimit » atkDGList » atkDGNoRecordsFound » atkDGPaginator » atkDGRenderer » atkDGSummary lock » atkDbLock » atkLock filters » atkDistinctFilter » atkFilter » atkGroupByFilter document » atkDocumentWriter » atkDocxWriter » atkOpenDocumentWriter meta » atkDutchMetaGrammar » atkMetaAttributeModifier » atkMetaCompiler » atkMetaGrammar » atkMetaPolicy » mod_meta relations » atkExtendableShuttleRelation » atkManyBoolRelation » atkManyToManyListRelation » atkManyToManyRelation » atkManyToManySelectRelation » atkManyToOneRelation » atkManyToOneTreeRelation » atkMatrixRelation » atkOneToManyRelation » atkOneToOneRelation » atkPolymorphicOneToOneRelation » atkRelation » atkSecureRelation » atkShuttleControl » atkShuttleFilter » atkShuttleRelation front » atkFrontController » atkFrontControllerBridge keyboard » atkKeyboard meta-relations » atkMetaExtendableShuttleRelation » atkMetaManyBoolRelation » atkMetaManyToManyListRelation » atkMetaManyToManySelectRelation » atkMetaManyToOneRelation » atkMetaOneToManyRelation » atkMetaOneToOneRelation » atkMetaShuttleRelation session » atkMockSessionManager » atkSessionManager » atkState modules » atkModule » mod_test listeners » atkRecycleBin interface » atkServer » atkSoapServer wizard » atkWizard » AtkWizardActionLoader » atkWizardPanel
Interfaces: datagrid » atkDGListener interface » atkServerInterface
Files: general » adodb-time.inc.php » AllTests.php » atknodetools.inc » atktools.inc » atktreetools.inc » basexml.php » bootstrap.inc » bootstrap.php » class.atkconfig.inc » class.atkcontroller.inc » class.atkdatanode.inc » class.atkerrorhandlerbase.inc » class.atkfileeditor.inc » class.atki5db.inc » class.atki5ddl.inc » class.atki5query.inc » class.atklanguage.inc » class.atkmailerrorhandler.inc » class.atkmetanode.inc » class.atkmocknode.inc » class.atkmocksessionmanager.inc » class.atknode.inc » class.atknodevalidator.inc » class.atkonetomanyrelationsessiongridhandler.inc » class.atkphpview.inc » class.atkpolymorphiconetoonerelation.inc » class.atksessionstore.inc » class.atkstatementiterator.inc » class.atktreenode.inc » class.atkwizardbase.inc » class.atkzendplatformerrorhandler.inc » class.layout.inc » class.nodename.inc » class.sql_whereclause_blacklist_checker.inc » class.test.inc » class.test_sql_whereclause_blacklist_checker.inc » commands.php » config.modules.inc » config.php » connector.php » console.php » db2yaml.php » defaultconfig.inc.php » fckeditor.php » fckeditor_php4.php » fckeditor_php5.php » io.php » module.inc » phpcompat.php » server.php » spellchecker.php » table2yaml.php » tbsooo_class.php » tbs_class.php » tooltip.tpl.php » upload.php » util.php » version.inc attributes » class.atkaggregatedcolumn.inc » class.atkattribute.inc » class.atkboolattribute.inc » class.atkcalculatorattribute.inc » class.atkcaptchaattribute.inc » class.atkcolorpickerattribute.inc » class.atkcountryattribute.inc » class.atkcreatedbyattribute.inc » class.atkcreatestampattribute.inc » class.atkcurrencyattribute.inc » class.atkdateattribute.inc » class.atkdatetimeattribute.inc » class.atkdocumentattribute.inc » class.atkdummyattribute.inc » class.atkdurationattribute.inc » class.atkemailattribute.inc » class.atkexpressionattribute.inc » class.atkfckattribute.inc » class.atkfieldset.inc » class.atkfileattribute.inc » class.atkfilewriterattribute.inc » class.atkflagattribute.inc » class.atkformatattribute.inc » class.atkfuzzysearchattribute.inc » class.atkhiddenattribute.inc » class.atkhtmlattribute.inc » class.atkipattribute.inc » class.atklistattribute.inc » class.atklivetextpreview.inc » class.atkmlattribute.inc » class.atkmlfckattribute.inc » class.atkmlhtmlattribute.inc » class.atkmlnumberattribute.inc » class.atkmlselectorattribute.inc » class.atkmltextattribute.inc » class.atkmlwrapper.inc » class.atkmultiplefileattribute.inc » class.atkmultiselectattribute.inc » class.atknumberattribute.inc » class.atkparserattribute.inc » class.atkpasswordattribute.inc » class.atkprofileattribute.inc » class.atkradioattribute.inc » class.atkradiodetailsattribute.inc » class.atkrowcounter.inc » class.atkstateattribute.inc » class.atktabbedpane.inc » class.atktagattribute.inc » class.atktextattribute.inc » class.atktimeattribute.inc » class.atktimezoneattribute.inc » class.atktoolbar.inc » class.atkupdatedbyattribute.inc » class.atkupdatestampattribute.inc » class.atkurlattribute.inc » class.atkweekdayattribute.inc » class.atkwysiwygattribute.inc attributes-- » property_accessor.php cache » class.atkcache.inc » class.atkcache_apc.inc » class.atkcache_eaccelerator.inc » class.atkcache_file.inc » class.atkcache_memcache.inc » class.atkcache_var.inc » class.atkcache_xcache.inc » class.atkcache_zp_disk.inc » class.atkcache_zp_output.inc » class.atkcache_zp_shm.inc console » class.atkconsolecontroller.inc datagrid » class.atkdatagrid.inc » class.atkdgcomponent.inc » class.atkdgeditcontrol.inc » class.atkdgevent.inc » class.atkdgindex.inc » class.atkdglimit.inc » class.atkdglist.inc » class.atkdglistener.inc » class.atkdgnorecordsfound.inc » class.atkdgpaginator.inc » class.atkdgrenderer.inc » class.atkdgsummary.inc datatypes » class.atkarraydt.inc » class.atkdatatype.inc » class.atkstringdt.inc » class.atktimedt.inc db » class.atkclusterdb.inc » class.atkclusterddl.inc » class.atkclusterquery.inc » class.atkdb.inc » class.atkdb2db.inc » class.atkdb2ddl.inc » class.atkdb2query.inc » class.atkddl.inc » class.atkmockdb.inc » class.atkmockddl.inc » class.atkmockquery.inc » class.atkmssqldb.inc » class.atkmssqlddl.inc » class.atkmssqlquery.inc » class.atkmysqldb.inc » class.atkmysqlddl.inc » class.atkmysqlidb.inc » class.atkmysqliddl.inc » class.atkmysqliquery.inc » class.atkmysqlquery.inc » class.atkoci8db.inc » class.atkoci8ddl.inc » class.atkoci8query.inc » class.atkoci9db.inc » class.atkoci9ddl.inc » class.atkoci9query.inc » class.atkoci805db.inc » class.atkoci805query.inc » class.atkpgsqldb.inc » class.atkpgsqlddl.inc » class.atkpgsqlquery.inc » class.atkquery.inc db-statement » class.atkcompatstatement.inc » class.atkmysqlistatement.inc » class.atkstatement.inc » class.atkstatementexception.inc » class.atkstatementparser.inc document » class.atkdocumentwriter.inc » class.atkdocxwriter.inc » class.atkopendocumentwriter.inc filters » class.atkdistinctfilter.inc » class.atkfilter.inc » class.atkgroupbyfilter.inc fixture » class.atkabstractfixtureloader.inc » class.atkfixturemanager.inc » class.atkphpfixtureloader.inc » class.atkyamlfixtureloader.inc front » class.atkfrontcontroller.inc » class.atkfrontcontrollerbridge.inc handlers » class.atkactionhandler.inc » class.atkaddhandler.inc » class.atkaddorcopyhandler.inc » class.atkadminhandler.inc » class.atkattributeedithandler.inc » class.atkcopyhandler.inc » class.atkdeletehandler.inc » class.atkdocumenthandler.inc » class.atkeditcopyhandler.inc » class.atkedithandler.inc » class.atkexporthandler.inc » class.atkfeedbackhandler.inc » class.atkfileexport.inc » class.atkimporthandler.inc » class.atkmultiselecthandler.inc » class.atkmultiupdatehandler.inc » class.atksavehandler.inc » class.atksearchhandler.inc » class.atkselecthandler.inc » class.atksmartsearchhandler.inc » class.atkupdatehandler.inc » class.atkvieweditbase.inc » class.atkviewhandler.inc » class.atkxmlhandler.inc include » autoload.inc » basics.inc » compatibility.inc » configs.inc » debugging.inc » errorhandler.inc » globals.inc » initial.inc » security.inc interface » class.atkserver.inc » class.atksoapserver.inc » interface.atkserverinterface.inc javascript » class.atkmultilanguage.js.php » class.atkprofileattribute.js.php » dhtml_tabs.js.php keyboard » class.atkkeyboard.inc listeners » class.atkrecyclebin.inc lock » class.atkdblock.inc » class.atklock.inc » lock.php lock-- » lock.js.php menu » atkmenutools.inc » class.atkcookmenu.inc » class.atkdhtmlmenu.inc » class.atkdropdownmenu.inc » class.atkframesmenu.inc » class.atkmenu.inc » class.atkmenuinterface.inc » class.atkmodernmenu.inc » class.atkoutlookmenu.inc » class.atkplainmenu.inc meta » class.atkdutchmetagrammar.inc » class.atkmetaattributemodifier.inc » class.atkmetacompiler.inc » class.atkmetagrammar.inc » class.atkmetapolicy.inc » module.inc meta-relations » class.atkmetaextendableshuttlerelation.inc » class.atkmetamanyboolrelation.inc » class.atkmetamanytomanylistrelation.inc » class.atkmetamanytomanyselectrelation.inc » class.atkmetamanytoonerelation.inc » class.atkmetaonetomanyrelation.inc » class.atkmetaonetoonerelation.inc » class.atkmetashuttlerelation.inc modules » class.atkmodule.inc modules-- » atkmoduletools.inc popups » colorpicker.inc recordlist » class.atkcolumnconfig.inc » class.atkcsvrecordlist.inc » class.atkcustomrecordlist.inc » class.atkexcelcsvrecordlist.inc » class.atkhtmlrecordlist.inc » class.atkprintablerecordlist.inc » class.atkrecordlist.inc » class.atkrecordlistcache.inc » class.atktotalizer.inc relations » class.atkextendableshuttlerelation.inc » class.atkmanyboolrelation.inc » class.atkmanytomanylistrelation.inc » class.atkmanytomanyrelation.inc » class.atkmanytomanyselectrelation.inc » class.atkmanytoonerelation.inc » class.atkmanytoonetreerelation.inc » class.atkmatrixrelation.inc » class.atkonetomanyrelation.inc » class.atkonetoonerelation.inc » class.atkrelation.inc » class.atksecurerelation.inc » class.atkshuttlecontrol.inc » class.atkshuttlefilter.inc » class.atkshuttlerelation.inc security » class.atkbajusencryption.inc » class.atkbase64encryption.inc » class.atkencryption.inc » class.atkmocksecuritymanager.inc » class.atkmocksecuritymanager.inc » class.atkopensslencryption.inc » class.atksecuritylistener.inc » class.atksecuritymanager.inc » class.atkurlvault.inc » class.auth_config.inc » class.auth_db.inc » class.auth_imap.inc » class.auth_interface.inc » class.auth_ldap.inc » class.auth_none.inc » class.auth_pop3.inc » class.auth_saml.inc » class.auth_server.inc » class.auth_sspi.inc session » class.atksessionmanager.inc » class.atkstate.inc skel » app.php » atk.inc » config.inc.php » debugger.php » dispatch.php » include.php » index.php » menu.php » top.php » welcome.php subpackage » class.atkattributetestcase.inc test » class.atkcachetestcase.inc » class.atkplugintestcase.inc » class.atktestcase.inc testcases » class.atkabstractsearchhandler.inc themes » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc » themedef.inc ui » block.atknavigator.php » block.atknavigatorinfo.php » class.atkactionboxbuilder.inc » class.atkdialog.inc » class.atkindexpage.inc » class.atkoutput.inc » class.atkpage.inc » class.atkpagebuilder.inc » class.atktheme.inc » class.atkthemecompiler.inc » class.atkui.inc » function.atkconf.php » function.atkconfig.php » function.atkdatefield.php » function.atkdispatchfile.php » function.atkfrontcontroller.php » function.atkloadscript.php » function.atkmessages.php » function.atkmoduledir.php » function.atkscript.php » function.atkstyle.php » function.atktext.php » function.atkthemeicon.php » function.atkthemeimg.php » function.stacktrace.php » modifier.atkjson.php » modifier.atkvardump.php » resource.string.php » resource.theme.php » resource.ui.php utils » atkbrowsertools.inc » class.atkactionlistener.inc » class.atkclassloader.inc » class.atkcompatselector.inc » class.atkdataholder.inc » class.atkdebugger.inc » class.atkdirectorytraverser.inc » class.atkeventlog.inc » class.atkfileutils.inc » class.atkframeset.inc » class.atkiputils.inc » class.atkjson.inc » class.atkmail.inc » class.atkmailer.inc » class.atkmessagequeue.inc » class.atkmlselector.inc » class.atkmlsplitter.inc » class.atkselector.inc » class.atkselectoriterator.inc » class.atkstring.inc » class.atkstringparser.inc » class.atktablerenderer.inc » class.atktablerenderergrouped.inc » class.atktextmarker.inc » class.atktmpfile.inc » class.atktriggerlistener.inc » class.atkyaml.inc » class.atkzip.inc » help.inc wizard » class.atkwizard.inc » class.atkwizardactionloader.inc » class.atkwizardpanel.inc
Home  ->  Documentation home  ->  Atk index  ->  Docs For Class atkActionHandler [ package: atk ]

Class: atkActionHandler

Source Location: /handlers/class.atkactionhandler.inc

Class atkActionHandler

Class Overview

Generic action handler base class.

Action handlers are responsible for performing actions on nodes (for example "add", "edit", "delete", or any other custom actions your application might have). An action from the default handler can be overridden by implementing a method in your node with the name action_<actionname> where <actionname> is the action you want to perform. The original handler is passed as a parameter to the override.

Custom action handlers should always be derived from atkActionHandler, and should contain at least an implementation for the handle() method, which is called by the framework to execute the action.

Located in /handlers/class.atkactionhandler.inc [line 45]

Wiki documentation



		
				Author(s):
		
		
		API Tags:
Abstract:  

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class Description
atkAbstractSearchHandler Abstract class for implementing an atkSearchHandler
atkAddHandler Handler for the 'add' action of a node. It draws a page where the user can enter a new record.
atkAddOrCopyHandler Handler for the 'editcopy' action of a node. It copies the selected record, and then redirects to the edit action for the copied record.
atkAdminHandler Handler for the 'admin' action of a node. It displays a recordlist with existing records, and links to view/edit/delete them (or custom actions if present), and an embedded addform or a link to an addpage (depending on the presence of the NF_ADD_LINK or NF_ADD_DIALOG flag).
atkAttributeEditHandler Handler for the 'attributeedit' action of a node. It shows a dialog for altering the value of a selectable attribute for multiple records at the same time.
atkCopyHandler Handler for the 'tcopy' action of a node. It copies the selected record, and then redirects back to the calling page.
atkDeleteHandler 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.
atkDocumentHandler Handler class for the document action
atkEditCopyHandler Handler for the 'editcopy' action of a node. It copies the selected record, and then redirects to the edit action for the copied record.
atkExportHandler Handler for the 'import' action of a node. The import action is a generic tool for importing CSV files into a table.
atkFeedbackHandler Handler class for the feedback action of a node. The handler draws a screen with a message, giving the user feedback on some action that occurred.
atkImportHandler Handler for the 'import' action of a node. The import action is a generic tool for importing CSV files into a table.
atkMultiUpdatehandler
atkSaveHandler 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.
atkSelectHandler Handler class for the select action of a node. The handler draws a generic select form for searching through the records and selecting one of the records.
atkUpdatehandler 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.
atkViewEditBase Handler class for the edit action of a node. The handler draws a generic edit form for the given node.
atkXmlHandler Handler class for the exporting a record to an XML file.

[ Top ]

Property Summary

mixed   $m_action  
mixed   $m_boxTemplate  
atkNode   $m_node  
mixed   $m_partial  
mixed   $m_rejecting  
mixed   $m_renderBoxVars  
string   $m_renderMode   Render mode, defaults to "box" but can be changed to "dialog".
mixed   $m_returnbehaviour  

[ Top ]

Method Summary

static void   getDefaultHandler()   Static factory method to get the default action handler for a certain action.
atkActionHandler   atkActionHandler()   Default constructor.
void   addRenderBoxVar()   Add a variable to the renderbox
boolean   allowed()   Current action allowed on the given record?
void   clearCache()   Clear the recordlist cache
void   closeDialog()   Output JavaScript to close the dialog.
string   getCSRFToken()   Get/generate CSRF token for the current session stack.
atkNode   getNode()   Returns the node object.
atkPage   &getPage()   Get the page instance for generating output.
atkRecordListCache   getRecordlistCache()   Get the cached recordlist
Array   getRejectInfo()   Get the reject info from the session This is used by the atkAddHandler and atkEditHandler to show the validation errors
string   getRenderMode()   Returns the render mode.
String   getReturnBehaviour()   Get the returnbehaviour of this action
atkUi   &getUi()   Get the ui instance for drawing and templating purposes.
void   handle()   The handle() method handles the action.
mixed   invoke()   Generic method invoker.
boolean   isValidCSRFToken()   Checks whatever the given CSRF token matches the one stored in the session stack.
void   modifyDataGrid()   Modify grid.
void   notify()   Notify the node that an action has occured
void   partial()   Handle partial.
String   renderAccessDeniedDialog()   Render access denied dialog contents.
void   renderAccessDeniedPage()   Render access denied page.
String   renderMessageDialog()   Render message dialog contents.
void   setAction()   Sets the current action.
void   setBoxTemplate()  
void   setNode()   Set the calling node of the current action.
void   setPostvars()   Set postvars of the the calling node of the current action.
void   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
void   setRenderMode()   Sets the render mode ("box" or "dialog").
void   setReturnBehaviour()   Set the returnbehaviour of this action
void   updateDialog()   Outputs JavaScript for updating the existing dialog contents.
String   _getAccessDeniedPage()   Get the access denied page

[ Top ]

Properties

mixed   $m_action = "" [line 54]
API Tags:
Access:  private


[ Top ]
mixed   $m_boxTemplate = "box" [line 69]
API Tags:
Access:  protected


[ Top ]
atkNode   $m_node = NULL [line 51]
API Tags:
Access:  private


[ Top ]
mixed   $m_partial = NULL [line 57]
API Tags:
Access:  private


[ Top ]
mixed   $m_rejecting = false [line 63]
API Tags:
Access:  private


[ Top ]
mixed   $m_renderBoxVars = array() [line 60]
API Tags:
Access:  private


[ Top ]
string   $m_renderMode = 'box' [line 77]

Render mode, defaults to "box" but can be changed to "dialog".

API Tags:
Access:  protected


[ Top ]
mixed   $m_returnbehaviour = ATK_ACTION_STAY [line 66]
API Tags:
Access:  private


[ Top ]

Methods

static method getDefaultHandler  [line 294]

  static void getDefaultHandler( String $action  )

Static factory method to get the default action handler for a certain action.

When no action handler class can be found for the action, a default handler is instantiated and returned. The default handler assumes that the node has an action_.... method, that will be called when the actionhandler's handle() mehod is called.

Parameters:
String   $action:  The action for which an action handler should be retrieved.


[ Top ]
Constructor atkActionHandler  [line 82]

  atkActionHandler atkActionHandler( )

Default constructor.



[ Top ]
addRenderBoxVar  [line 376]

  void addRenderBoxVar( string $key, string $value  )

Add a variable to the renderbox

Parameters:
string   $key: 
string   $value: 


[ Top ]
allowed  [line 407]

  boolean allowed( array $record  )

Current action allowed on the given record?

Parameters:
array   $record:  record

API Tags:
Return:  is action allowed on record?


[ Top ]
clearCache  [line 349]

  void clearCache( )

Clear the recordlist cache



[ Top ]
closeDialog  [line 488]

  void closeDialog( )

Output JavaScript to close the dialog.



[ Top ]
getCSRFToken  [line 526]

  string getCSRFToken( )

Get/generate CSRF token for the current session stack.

http://www.owasp.org/index.php/Cross-Site_Request_Forgery_%28CSRF%29_Prevention_Cheat_Sheet


API Tags:
Return:  CSRF token
Access:  public


[ Top ]
getNode  [line 122]

  atkNode getNode( )

Returns the node object.


API Tags:
Access:  public


[ Top ]
getPage  [line 211]

  atkPage &getPage( )

Get the page instance for generating output.


API Tags:
Return:  The active page instance.


[ Top ]
getRecordlistCache  [line 333]

  atkRecordListCache getRecordlistCache( )

Get the cached recordlist


API Tags:
Return:  object


[ Top ]
getRejectInfo  [line 134]

  Array getRejectInfo( )

Get the reject info from the session This is used by the atkAddHandler and atkEditHandler to show the validation errors


API Tags:
Return:  The reject info


[ Top ]
getRenderMode  [line 196]

  string getRenderMode( )

Returns the render mode.


API Tags:
Return:  render mode


[ Top ]
getReturnBehaviour  [line 396]

  String getReturnBehaviour( )

Get the returnbehaviour of this action


API Tags:
Return:  the return behaviour


[ Top ]
getUi  [line 221]

  atkUi &getUi( )

Get the ui instance for drawing and templating purposes.


API Tags:
Return:  An atkUi instance for drawing and templating.


[ Top ]
handle  [line 100]

  void handle( &$node, String $action, &$postvars, atkNode $node, array $postvars  )

The handle() method handles the action.

The default implementation invokes an action_$action override (if present) and stores the postvars. Custom handlers may override this behavior. If there is no node action override and a partial is set for the action we don't invoke the action_$action override but instead let the partial method handle the action.

Parameters:
atkNode   $node:  The node on which the action should be performed.
String   $action:  The action that is being performed.
array   $postvars:  Any variables from the request
   &$node: 
   &$postvars: 


[ Top ]
invoke  [line 259]

  mixed invoke( String $methodname  )

Generic method invoker.

Handler methods invoked with invoke() instead of directly, have a major advantage: the handler automatically searches for an override in the node. For example, If a handler calls its getSomething() method using the invoke method, the node may implement its own version of getSomething() and that method will then be called instead of the original. The handler is passed by reference to the override function as first parameter, so if necessary, you can call the original method from inside the override.

The function accepts a variable number of parameters. Any parameter that you would pass to the method, can be passed to invoke(), and invoke() will pass the parameters on to the method.

There is one limitation: you can't pass parameters by reference if you use invoke().

Example:

  1.    $handler->invoke("editPage"$record$mode);

This will call editPage(&$handler, $record, $mode) on your node class if present, or editPage($record, $mode) in the handler if the node has no override.

Parameters:
String   $methodname:  The name of the method to call.

API Tags:
Return:  The method returns the return value of the invoked method.


[ Top ]
isValidCSRFToken  [line 548]

  boolean isValidCSRFToken( $token  )

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

Parameters:
   $token: 

API Tags:
Return:  is valid CSRF token?
Access:  protected


[ Top ]
modifyDataGrid  [line 319]

  void modifyDataGrid( atkDataGrid $grid, int $mode  )

Modify grid.

Parameters:
atkDataGrid   $grid:  grid
int   $mode:  CREATE or RESUME

API Tags:
Access:  protected


[ Top ]
notify  [line 365]

  void notify( string $action, array $record  )

Notify the node that an action has occured

Parameters:
string   $action:  The action that occurred
array   $record:  The record on which the action was performed


[ Top ]
partial  [line 501]

  void partial( string $partial  )

Handle partial.

Parameters:
string   $partial:  full partial


[ Top ]
renderAccessDeniedDialog  [line 438]

  String renderAccessDeniedDialog( )

Render access denied dialog contents.


API Tags:
Return:  The access denied page in a dialog


[ Top ]
renderAccessDeniedPage  [line 415]

  void renderAccessDeniedPage( )

Render access denied page.



[ Top ]
renderMessageDialog  [line 454]

  String renderMessageDialog( String $message  )

Render message dialog contents.

Parameters:
String   $message:  The message to render in a dialog

API Tags:
Return:  The message dialog


[ Top ]
setAction  [line 167]

  void setAction( string $action  )

Sets the current action.

Parameters:
string   $action:  The action name.


[ Top ]
setBoxTemplate  [line 201]

  void setBoxTemplate( $tpl  )

Parameters:
   $tpl: 


[ Top ]
setNode  [line 156]

  void setNode( &$node, atkNode $node  )

Set the calling node of the current action.

Parameters:
atkNode   $node:  The node on which the action should be performed.
   &$node: 


Redefined in descendants as:

[ Top ]
setPostvars  [line 176]

  void setPostvars( &$postvars, array $postvars  )

Set postvars of the the calling node of the current action.

Parameters:
array   $postvars:  Postvars of the node on which the action should be performed.
   &$postvars: 


[ Top ]
setRejectInfo  [line 146]

  void setRejectInfo( array $data  )

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

Parameters:
array   $data:  The reject information


[ Top ]
setRenderMode  [line 186]

  void setRenderMode( string $mode  )

Sets the render mode ("box" or "dialog").

Parameters:
string   $mode:  render mode


[ Top ]
setReturnBehaviour  [line 386]

  void setReturnBehaviour( Integer $returnbehaviour  )

Set the returnbehaviour of this action

Parameters:
Integer   $returnbehaviour:  The return behaviour (possible values: ATK_ACTION_BACK and ATK_ACTION_STAY)


[ Top ]
updateDialog  [line 477]

  void updateDialog( string $content  )

Outputs JavaScript for updating the existing dialog contents.

Parameters:
string   $content: 


[ Top ]
_getAccessDeniedPage  [line 426]

  String _getAccessDeniedPage( )

Get the access denied page


API Tags:
Return:  the HTML code of the access denied page


[ Top ]
Home | About | Contact