Docs For Class atkNode
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 atkNode [ package: atk ]

Class: atkNode

Source Location: /class.atknode.inc

Class atkNode

Class Overview

The atkNode class represents a piece of information that is part of an application. This class provides standard functionality for adding, editing and deleting nodes.

This class must be seen as an abstract base class: For every piece of information in an application, a class must be derived from this class with specific implementations for that type of node.

Located in /class.atknode.inc [line 284]

Wiki documentation



		
				Author(s):
		
		
		
Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class Description
atkDataNode The ATK data node can be used to create nodes that don't retrieve their data from the database.
atkFileEditor File editing node.
atkMetaNode The ATK Meta Node class.
atkTreeNode Extension on the atkNode class. Here you will find all functions for the tree view. If you want to use the treeview, you must define the atkTreeNode instead of atkNode.
test The atkNode class represents a piece of information that is part of an application. This class provides standard functionality for adding, editing and deleting nodes.
atkMockNode The atkMockNode class is an atkNode mock object for testing purposes

[ Top ]

Property Summary

String   $m_action   The action that the node is currently performing.
Array   $m_actionListeners   List of action listeners
array   $m_attribIndexList   Index list containing the attributes in the order in which they will appear on screen.
array   $m_attribList   The list of attributes of a node. These should be of the class atkAttribute or one of its derivatives.
int   $m_attribOrder   Current maximum attribute order value.
boolean   $m_attribsizesset   Check to prevent double execution of setAttribSizes on pages with more than one form.
array   $m_attributeTabs   Keep track of tabs per attribute.
array   $m_cascadingAttribs   For speed, we keep track of a list of attributes that have the cascade delete flag set.
mixed   $m_db   The database that the node is using for storing and loading its data.
string   $m_defaultColumn   Default column name (null means across all columns)
String   $m_defaultlanguage   Default language used by Multilanguage Nodes.
String   $m_default_expanded_sections   Default sections that are expanded.
String   $m_default_order   Default order by statement.
String   $m_default_tab   Default tab being displayed in add/edit mode.
Object   $m_descHandler   Descriptor handler.
String   $m_descTemplate   Descriptor template.
Array   $m_editableListAttributes   List of editable list attributes.
String   $m_edit_fieldprefix   The default edit fieldprefix to use for atk
String   $m_extended_search_action   Extended search action. The action which is called if the user wants to perform an extended search.
array   $m_feedback   List of actions that should give success/failure feedback
array   $m_filledTabs   Keep track if a tab contains attribs (checkEmptyTabs function)
array   $m_filters   Record filters, in attributename/required value pairs.
int   $m_flags   Bitwise mask of node flags (NF_* flags).
array   $m_fuzzyFilters   Record filters, as a list of sql statements.
atkActionHandler   $m_handler   The active action handler.
mixed   $m_index  
boolean   $m_initialised   Nodes must be initialised using the init() function before they can be used. This member indicated whether the node has been initialised.
array   $m_listExcludes   For speed, we keep track of a list of attributes that we don't have to load in recordlists.
String   $m_lngfield   Name of the attribute that contains the language of a record.
atkLock   $m_lock   The lock instance
int   $m_lockMode   Lock mode.
String   $m_modifier   Tracker variable to see if we are currently in 'modifier mode' (running inside the scope of a modname_nodename_modifier() method). The variable contains the name of the modifying module.
String   $m_module   The module of the node.
int   $m_mraSelectionMode   Multi-record actions, selection mode.
mixed   $m_numbering   Number to use with numbering
atkPage   $m_page   Reference to the page on which the node is rendering its output.
mixed   $m_partial   Contains the definition of what needs to rendered partially.
array   $m_postvars   The postvars (or getvars) that are passed to a page will be passed to the class using the dispatch function. We store them in a member variable for easy access.
array   $m_primaryKey   List of names of the attributes that form this node's primary key.
array   $m_priority_actions   Priority actions
int   $m_priority_max   Maximum for the mra priority select
int   $m_priority_min   Minimum for the mra priority select
array   $m_recordActionsCallbacks   List of callback functions to manipulate the record actions
array   $m_relations   var used for tracking relation within this node.
array   $m_rowClassCallback   List of callback functions to add css class to row.
array   $m_search_action   Auto search-actions; action that will be performed if only one record is found.
array   $m_sectionList   List of available sections. Associative array structured like this:
String   $m_securityAlias   Name of the node that is used for privilege checking.
array   $m_securityImplied   The right to execute certain actions can be implied by the fact that you
array   $m_securityMap   Actions are mapped to security units.
String   $m_seq   The name of the sequence used for autoincrement fields.
mixed   $m_statusbarDone  
String   $m_table   The table to use for data storage.
array   $m_tabList   List of available tabs. Associative array structured like this:
Array   $m_triggerListeners   List of trigger listeners
String   $m_type   The nodetype.
array   $m_uniqueFieldSets   Unique field sets of a certain node.
mixed   $m_unsecuredActions  
String   $m_validate_class   reference to the class which is used to validate atknodes the validator is overridable by changing this variabele
array   $m_viewExcludes   For speed, we keep track of a list of attributes that we don't have to load when in view pages.

[ Top ]

Method Summary

static void   redirect()   Redirect the browser to a different location.
atkNode   atkNode()   Constructor.
String   actionTitle()   Generate a title for a certain action on a certain action.
atkAttribute   add()   Add an atkAttribute (or one of its derivatives) to the node.
void   addAllowedAction()   Disable privilege checking for an action.
boolean   addDb()   Save a new record to the database.
void   addDefaultExpandedSections()   Add sections that must be expanded by default.
void   addFieldSet()   Add fieldset.
void   addFilter()   Add a recordset filter.
void   addFlag()   Add a flag to the node.
void   addListener()   Add an atkActionListener to the node.
void   addSecurityMap()   Set the security of one or more actions action the same as other actions.
void   addStyle()   Add a stylesheet to the page.
void   addToQuery()   Add this node to an existing query.
void   addUniqueFieldset()   Add a unique field set.
boolean   allowed()   This function determines if the user has the privilege to perform a certain action on the node.
String   atkNodeType()   Get the full atknodetype of this node (module.nodetype notation). This is sometimes referred to as the node name (or nodename) or node string.
void   attribSort()   This function resorts the attribIndexList and attribList.
int   attrib_cmp()   Small compare function for sorting attribs on order field
array   buildTabs()   Builds a list of tabs.
void   callHandler()   Invoke the handler for an action.
void   changeMapping()   change the securitymap that already exist. Where actions are mapped on $oldmapped change it by $newmapped
void   checkAttributeSecurity()   Check attribute security.
array   checkEmptyTabs()   Remove tabs without attribs from the tablist
array   checkTabRights()   Check if the user has the rights to access existing tabs and removes tabs from the list that may not be accessed
void;   collectRecordActions()   Function that is called for each record in a recordlist, to determine what actions may be performed on the record.
String   confirmAction()   Function returns a page in which the user is asked if he really wants to perform a certain action.
String   confirmActionText()   Determine the confirmation message.
boolean   copyDb()   Copy a record in the database.
atkPageBuilder   createPageBuilder()   Returns a new page builder instance.
array   defaultActions()   Retrieve an array with the default actions for a certain mode.
boolean   deleteDb()   Delete record(s) from the database.
String   descriptor()   Determine a descriptor of a record.
array   descriptorFields()   Retrieve the list of attributes that are used in the descriptor definition.
void   dispatch()   This is the wrapper method for all http requests on a node.
array   editArray()   Function outputs an array with edit fields. For each field the array contains the name, edit HTML code etc. (name, html, obligatory, error, label)
array   edit_values()   Retrieve new values for an existing record.
string   escapeSQL()   Escape SQL string, uses the node's database to do the escaping.
bool   executeTrigger()   Executes a trigger on a add,update or delete action
String   feedbackUrl()   Determine the url for the feedbackpage.
array   fetchByPk()   Returns a record (array) as identified by a primary key (usually an "id" column), including applicable relations.
boolean.   &filledInForm()   Checks if the user has filled in something: return true if he has, otherwise return false
String   genericPage()   Render a generic page, with a box, title, stacktrace etc.
string   getAction()   Returns the current action for this node.
void   getActiveSections()   Get the active sections.
String   getActiveTab()   Returns the currently active tab.
atkAttribute   &getAttribute()   Get an attribute by name.
array   getAttributeNames()   Returns a list of attribute names.
void   getAttributeOrder()   Gets the attribute order.
array   &getAttributes()   Gets all the attributes.
atkColumnConfig   &getColumnConfig()   Get the column configuration object
atkDb   getDb()   Get the database connection for this node.
array   getDefaultActionParams()   Determine the default form parameters for an action template.
string   getDefaultColumn()   Returns the default column name.
Object   &getDescriptorHandler()   Get descriptor handler.
String   getDescriptorTemplate()   Returns the descriptor template for this node.
string   getEditFieldPrefix()   Get the edit fieldprefix to use
extended   getExtendedSearchAction()   Get extended search action.
string   getFirstTargetFieldFromFilterSql()   Get the targeted field and table from a snippet of filter string sql
Integer   getFlags()   Returns the node flags.
array   getFormButtons()   Returns the form buttons for a certain page.
atkActionHandler   &getHandler()   Get the atkActionHandler object for a certain action.
String   getHelp()   Retrieve help link for the current node.
int   getLockMode()   Returns the lock mode.
String   getLockStatusIcon()   Get img tag for lock icon.
string   getModule()   Returns the module for this node.
Integer   getMRASelectionMode()   Returns the multi-record-action selection mode.
mixed   getNumbering()   Gets the numbering of the attributes
String   getOrder()   Get default sort order for the node.
atkPage   &getPage()   Get the page instance of the page on which the node can render output.
string   getPartial()   Returns the current partial name.
array   getRowClassCallback()   Return array with callback function list, which use for add css class to row
string   getSearchCondition()   Get search condition for this node.
mixed   getSearchMode()   Get the current searchmode.
array   getSections()   Retrieve the sections for the active tab.
string   getSecurityAlias()   Returns the node's security alias (if set).
void   getTabFromSection()   Strip section part from a section and return the tab.
string   getTable()   Returns the table name for this node.
array   getTabs()   Get a list of tabs for a certain action.
void   getTabsFromSections()   Retrieve the tabnames from the sections string (tab.section).
String   getTemplate()   Get the template to use for a certain action.
string   getType()   Returns the type of this node. (This is *not* the full ATK node type; see atkNodeType() for the full node type.)
atkUi   &getUi()   Get the ui instance for drawing and templating purposes.
void   groupFieldsBySection()   Group fields by section.
boolean   hasFlag()   Checks if the node has a certain flag set.
String   helpUrl()   Get the help url for this node.
String   hideForm()   Function outputs a form with all values hidden.
void   init()   This function initialises certain elements of the node.
array   initial_values()   Retrieve the initial values for a new record.
void   injectSections()   Add sections to the edit/view fields array.
boolean   isPartial()   Is partial request?
String   lockPage()   Generate a box displaying a message that the current record is locked.
void   modifyRecord()   Update a record with variables from a form posting.
void   notify()   Notify all listeners of the occurance of a certain action.
boolean   postAdd()   Function that is called by the framework, right after a new record has been saved to the database.
bool   postDel()   Deprecated function that is called by the framework, right after a record has been deleted.
bool   postDelete()   Function that is called by the framework, right after a record has been deleted.
boolean   postUpdate()   Function that is called by the framework, right after an existing record has been updated in the database.
void   preAdd()   Function that is called by the framework, just before a new record will be saved to the database.
void   preAddToEditArray()   The preAddToEditArray method is called from within the editArray
void   preAddToViewArray()   The preAddToViewArray method is called from within the viewArray
void   preCopy()   Function that is called by the framework, right before a copied record is stored to the database.
void   preDelete()   Function that is called by the framework, right before a record will be deleted. Should this method return false the deleting will halt.
void   preNotify()   Notify all listeners in advance of the occurance of a certain action.
bool   preUpdate()   Function that is called by the framework, just before an existing record will be saved to the database.
String   primaryKey()   Returns the primary key sql expression of a record.
String   primaryKeyField()   Retrieve the name of the primary key attribute.
String   primaryKeyTpl()   Returns a primary key template.
void   recordActions()   Function that is called for each record in a recordlist, to determine what actions may be performed on the record.
void   registerRecordActionsCallback()   Registers a function/method that is called for each record in a recordlist, to determine what actions may be performed on the record.
void   remove()   Remove an attribute.
void   removeDefaultExpandedSections()   Remove sections that must be expanded by default.
TRUE   removeFilter()   Search and remove a recordset filter.
void   removeFlag()   Removes a flag from the node.
String   renderActionPage()   Render a generic action.
string   resolveColumn()   Resolve column for sections.
void   resolveNodeTypeAndAction()   Resolves a possible node / action alias for the given node / action.
resolved   resolveSection()   Resolve section. If a section is only prefixed by a dot this means we need to add the default tab before the dot.
array   resolveSections()   Resolve sections.
void   resolveSectionsTabsOrder()   Resolve sections, tabs and the order based on the given argument to the attribute add method.
string   rowClass()   Row CSS class.
array   searchDb()   Search all records for the occurance of a certain expression.
String   securityKey()   Retrieve the security key of an action.
atkSelector   select()   Retrieve records from the database using a handy helper class.
void   setAttribSizes()   This function reads meta information from the database and initialises its attributes with the metadata.
void   setAttributeOrder()   Sets an attributes order
void   setDb()   Sets the database connection.
void   setDefaultColumn()   Set default column name.
void   setDefaultTab()   Set default tab being displayed in view/add/edit mode.
void   setDescriptorHandler()   Set descriptor handler.
void   setDescriptorTemplate()   Sets the descriptor template for this node.
void   setEditableListAttributes()   Sets the editable list attributes. If you supply this method with one or more string arguments, all arguments are collected in an array. Else the first parameter will be used.
void   setEditFieldPrefix()   Set the edit fieldprefix to use in atk
void   setExtendedSearchAction()   Set extended search action.
void   setFeedback()   Use this function to enable feedback for one or more actions.
void   setFlags()   Set node flags.
void   setIndex()   Create an alphabetical index.
void   setLockMode()   Sets the lock mode.
void   setMRASelectionMode()   Sets the multi-record-action selection mode. Can either be MRA_MULTI_SELECT (default), MRA_SINGLE_SELECT or MRA_NO_SELECT.
void   setNumbering()   Sets numbering of the attributes to begin with the number that was passed to it, or defaults to 1.
void   setOrder()   Set default sort order for the node.
void   setPriorityActions()   Sets the possible multi-record-priority actions.
void   setPriorityRange()   Sets the priority range, for multi-record-priority actions.
boolean   setRowClassCallback()   Add callback function for add css class to row.
void   setSearchAction()   Sets the search action.
void   setSecurityAlias()   Set the security alias of a node.
void   setTabIndex()   Set tab index
void   setTable()   Set the table that the node should use.
void   statusbar()   Display a statusbar with a stacktrace and a help button.
String   tabulate()   Place a set of tabs around content.
String   text()   Translate using this node's module and type.
void   trackChangesIfNeeded()   Called by updateDb to load the original record inside the record if the NF_TRACK_CHANGES flag is set.
boolean   updateDb()   Update a record in the database.
array   updateRecord()   Parse a set of url vars into a valid record structure.
void   validate()   Validates a record.
String   validateFilter()   Validates if a filter is valid for this node.
array   viewArray()   Function outputs an array with view fields. For each field the array contains the name, view HTML code etc.
void   _addListeners()   Add the listeners for the current node
void   _initSelector()   Set some default for the selector.
boolean   _storeAttributes()   Call the store() method on a list of attributes.
void   __call()   Catch missing methods.
string   __toString()   String representation for this node (PHP5 only).

[ Top ]

Properties

String   $m_action [line 442]

The action that the node is currently performing.

API Tags:
Access:  protected


[ Top ]
Array   $m_actionListeners = array() [line 686]

List of action listeners

API Tags:
Access:  protected


[ Top ]
array   $m_attribIndexList = array() [line 339]

Index list containing the attributes in the order in which they will appear on screen.

API Tags:
Access:  private


[ Top ]
array   $m_attribList = array() [line 331]

The list of attributes of a node. These should be of the class atkAttribute or one of its derivatives.

API Tags:
Access:  private


[ Top ]
int   $m_attribOrder = 0 [line 769]

Current maximum attribute order value.

API Tags:
Access:  private


[ Top ]
boolean   $m_attribsizesset = false [line 323]

Check to prevent double execution of setAttribSizes on pages with more than one form.

API Tags:
Access:  private


[ Top ]
array   $m_attributeTabs = array() [line 369]

Keep track of tabs per attribute.

API Tags:
Access:  private


[ Top ]
array   $m_cascadingAttribs = array() [line 542]

For speed, we keep track of a list of attributes that have the cascade delete flag set.

API Tags:
Access:  private

Information Tags:
Todo:  This should be moved to the delete handler, or should not be cached at all. (caching this on each load is slower than just retrieving the list when it's needed)

[ Top ]
mixed   $m_db = NULL [line 397]

The database that the node is using for storing and loading its data.

API Tags:
Access:  protected


[ Top ]
string   $m_defaultColumn = null [line 762]

Default column name (null means across all columns)

API Tags:
Access:  private


[ Top ]
String   $m_defaultlanguage = "" [line 658]

Default language used by Multilanguage Nodes.

API Tags:
Access:  protected


[ Top ]
String   $m_default_expanded_sections = array() [line 500]

Default sections that are expanded.

API Tags:
Access:  private


[ Top ]
String   $m_default_order = "" [line 462]

Default order by statement.

API Tags:
Access:  protected


[ Top ]
String   $m_default_tab = "default" [line 493]

Default tab being displayed in add/edit mode.

API Tags:
Access:  private


[ Top ]
Object   $m_descHandler = NULL [line 679]

Descriptor handler.

API Tags:
Access:  protected


[ Top ]
String   $m_descTemplate = NULL [line 672]

Descriptor template.

API Tags:
Access:  protected


[ Top ]
Array   $m_editableListAttributes = array() [line 733]

List of editable list attributes.

API Tags:
Access:  private


[ Top ]
String   $m_edit_fieldprefix = '' [line 747]

The default edit fieldprefix to use for atk

API Tags:
Access:  private


[ Top ]
String   $m_extended_search_action = NULL [line 726]

Extended search action. The action which is called if the user wants to perform an extended search.

API Tags:
Access:  private


[ Top ]
array   $m_feedback = array() [line 651]

List of actions that should give success/failure feedback

API Tags:
Access:  private


[ Top ]
array   $m_filledTabs = array() [line 376]

Keep track if a tab contains attribs (checkEmptyTabs function)

API Tags:
Access:  private


[ Top ]
array   $m_filters = array() [line 507]

Record filters, in attributename/required value pairs.

API Tags:
Access:  private


[ Top ]
int   $m_flags [line 478]

Bitwise mask of node flags (NF_* flags).


[ Top ]
array   $m_fuzzyFilters = array() [line 514]

Record filters, as a list of sql statements.

API Tags:
Access:  private


[ Top ]
atkActionHandler   $m_handler = NULL [line 455]

The active action handler.

API Tags:
Access:  protected


[ Top ]
mixed   $m_index = "" [line 486]

[ Top ]
boolean   $m_initialised = false [line 315]

Nodes must be initialised using the init() function before they can be used. This member indicated whether the node has been initialised.

API Tags:
Access:  private


[ Top ]
array   $m_listExcludes = array() [line 522]

For speed, we keep track of a list of attributes that we don't have to load in recordlists.

API Tags:
Access:  protected


[ Top ]
String   $m_lngfield [line 419]

Name of the attribute that contains the language of a record.

Used with ATK's data internationalization feature.

API Tags:
Access:  private


[ Top ]
atkLock   $m_lock = NULL [line 644]

The lock instance

API Tags:
Access:  protected


[ Top ]
int   $m_lockMode = 'exclusive' [line 754]

Lock mode.

API Tags:
Access:  private


[ Top ]
String   $m_modifier = "" [line 717]

Tracker variable to see if we are currently in 'modifier mode' (running inside the scope of a modname_nodename_modifier() method). The variable contains the name of the modifying module.

API Tags:
Access:  private


[ Top ]
String   $m_module [line 390]

The module of the node.

API Tags:
Access:  protected


[ Top ]
int   $m_mraSelectionMode = MRA_MULTI_SELECT [line 740]

Multi-record actions, selection mode.

API Tags:
Access:  private


[ Top ]
mixed   $m_numbering = null [line 665]

Number to use with numbering

API Tags:
Access:  protected


[ Top ]
atkPage   $m_page = NULL [line 346]

Reference to the page on which the node is rendering its output.

API Tags:
Access:  private


[ Top ]
mixed   $m_partial = NULL [line 448]

Contains the definition of what needs to rendered partially.

If set to NULL not in partial rendering mode.


[ Top ]
array   $m_postvars = array() [line 435]

The postvars (or getvars) that are passed to a page will be passed to the class using the dispatch function. We store them in a member variable for easy access.

API Tags:
Access:  protected


[ Top ]
array   $m_primaryKey = array() [line 426]

List of names of the attributes that form this node's primary key.

API Tags:
Access:  protected


[ Top ]
array   $m_priority_actions = array() [line 623]

Priority actions

API Tags:
Access:  private

Information Tags:
Todo:  This, and the priority_min/max members, should be moved to the recordlist

[ Top ]
int   $m_priority_max = 0 [line 637]

Maximum for the mra priority select

API Tags:
Access:  private


[ Top ]
int   $m_priority_min = 1 [line 630]

Minimum for the mra priority select

API Tags:
Access:  private


[ Top ]
array   $m_recordActionsCallbacks = array() [line 700]

List of callback functions to manipulate the record actions

API Tags:
Access:  protected


[ Top ]
array   $m_relations = array() [line 472]

var used for tracking relation within this node.

API Tags:
Access:  private

Information Tags:
Todo:  Remove this member, it's using memory while it's used only in the case of multilanguage node, and even then only on one occasion.

[ Top ]
array   $m_rowClassCallback = array() [line 708]

List of callback functions to add css class to row.

See details in atkDGList::getRecordlistData() method

API Tags:
Access:  protected


[ Top ]
array   $m_search_action [line 614]

Auto search-actions; action that will be performed if only one record is found.

API Tags:
Access:  private


[ Top ]
array   $m_sectionList = array() [line 362]

List of available sections. Associative array structured like this:

array($action=>$arrayOfSectionnames)

API Tags:
Access:  private


[ Top ]
String   $m_securityAlias = "" [line 586]

Name of the node that is used for privilege checking.

If a class is named 'project', then by default, if the system needs to know whether a user may edit a record, the securitymanager searches for 'edit' access on 'project'. However, if an alias is set here, the securitymanger searches for 'edit' on that alias.

API Tags:
Access:  private


[ Top ]
array   $m_securityImplied = array("view"=>"admin") [line 574]

The right to execute certain actions can be implied by the fact that you

have some other right. For example, if you have the right to access a feature (admin right), you may also view that record, and don't need explicit rights to view it. So the 'view' right is said to be 'implied' by the 'admin' right. This is a subtle difference with m_securityMap.

API Tags:
Access:  protected


[ Top ]
array   $m_securityMap = array("save"=>"add",
"update"=>"edit",
"multiupdate"=>"edit",
"copy"=>"add",
"import"=>"add",
"editcopy"=>"add",
"search"=>"admin",
"smartsearch"=>"admin")
[line 555]

Actions are mapped to security units.

For example, both actions "save" and "add" require access "add". If an item is not in this list, it's treated 'as-is'. Derived nodes may add more mappings to tell the systems that some custom actions require the same privilege as others. Structure: array($action=>$requiredPrivilege)

API Tags:
Access:  protected


[ Top ]
String   $m_seq [line 411]

The name of the sequence used for autoincrement fields.

API Tags:
Access:  protected


[ Top ]
mixed   $m_statusbarDone = false [line 606]

[ Top ]
String   $m_table [line 404]

The table to use for data storage.

API Tags:
Access:  protected


[ Top ]
array   $m_tabList = array() [line 354]

List of available tabs. Associative array structured like this:

array($action=>$arrayOfTabnames)

API Tags:
Access:  private


[ Top ]
Array   $m_triggerListeners = array() [line 693]

List of trigger listeners

API Tags:
Access:  protected


[ Top ]
String   $m_type [line 383]

The nodetype.

API Tags:
Access:  protected


[ Top ]
array   $m_uniqueFieldSets = array() [line 306]

Unique field sets of a certain node.

Indicates which field combinations should be unique. It doesn't contain the unique fields which have been set by flag AF_UNIQUE.

API Tags:
Access:  private


[ Top ]
mixed   $m_unsecuredActions = array("select", "multiselect", "feedback") [line 596]

[ Top ]
String   $m_validate_class = "atk.atknodevalidator" [line 294]

reference to the class which is used to validate atknodes the validator is overridable by changing this variabele

API Tags:
Access:  private


[ Top ]
array   $m_viewExcludes = array() [line 531]

For speed, we keep track of a list of attributes that we don't have to load when in view pages.

API Tags:
Access:  protected

Information Tags:
Todo:  This can probably be moved to the view handler.

[ Top ]

Methods

static method redirect  [line 3103]

  static void redirect( [String $location = ""], [array $recordOrExit = array()], [boolean $exit = false], [int $levelskip = 1]  )

Redirect the browser to a different location.

This is usually used at the end of actions that have no output. An example: when the user clicks 'save and close' in an edit screen, the action 'save' is executed. If the save is succesful, this method is called to redirect the user back to the adminpage. When $config_debug is set to 2, redirects are paused and you can click a link to execute the redirect (useful for debugging the action that called the redirect). Note: this method should be called before any output has been sent to the browser, i.e. before any echo or before the call to atkOutput::outputFlush().

Parameters:
String   $location:  The url to which you want to redirect the user. If ommitted, the call automatically redirects to the previous screen of the user. (one level back on the session stack).
array   $recordOrExit:  If you pass a record here, the record is passed as 'atkpkret' to the redirected url. Usually it's not necessary to pass this parameter. If you pass a boolean here we assume it's value must be used for the exit parameter.
boolean   $exit:  Exit script after redirect.
int   $levelskip:  Number of levels to skip


[ Top ]
Constructor atkNode  [line 783]

  atkNode atkNode( [String $type = ""], [int $flags = 0]  )

Constructor.

This initialises the node. Derived classes should always call their parent constructor ($this->atkNode($name, $flags), to initialize the base class.
Example:

  1. $this->atkNode('test',NF_NO_EDIT);

Parameters:
String   $type:  The nodetype (by default equal to the classname)
int   $flags:  Bitmask of node flags (NF_*).


[ Top ]
actionTitle  [line 1930]

  String actionTitle( String $action, [array $record = ""]  )

Generate a title for a certain action on a certain action.

The default implementation displayes the action name, and the descriptor of the current record between brackets. This can be overridden by derived classes.

Parameters:
String   $action:  The action for which the title is generated.
array   $record:  The record for which the title is generated.

API Tags:
Return:  The full title of the action.


[ Top ]
add  [line 939]

  atkAttribute add( atkAttribute $attribute, [mixed $sections = NULL], [int $order = 0]  )

Add an atkAttribute (or one of its derivatives) to the node.

Parameters:
atkAttribute   $attribute:  The attribute you want to add
mixed   $sections:  The sections/tab(s) on which the attribute should be displayed. Can be a tabname (String) or a list of tabs (array) or "*" if the attribute should be displayed on all tabs.
int   $order:  The order at which the attribute should be displayed. If ommitted, this defaults to 100 for the first attribute, and 100 more for each next attribute that is added.

API Tags:
Return:  the attribute just added
Access:  public


[ Top ]
addAllowedAction  [line 4424]

  void addAllowedAction( String $action  )

Disable privilege checking for an action.

This method disables privilege checks for the specified action, for the duration of the current http request.

Parameters:
String   $action:  The name of the action for which security is disabled.


[ Top ]
addDb  [line 3848]

  boolean addDb( &$record, [boolean $exectrigger = true], [string $mode = "add"], [array $excludelist = array()], array $record  )

Save a new record to the database.

The record is passed by reference, because any autoincrement field gets its value when stored to the database. The record is updated, so after the call to addDb you can use access the primary key fields.

NOTE: Does not commit your transaction! If you are using a database that uses transactions you will need to call 'atkGetDb()->commit()' manually.

Parameters:
array   $record:  The record to save.
boolean   $exectrigger:  Indicates whether the postAdd trigger should be fired.
string   $mode:  The mode we're in
array   $excludelist:  List of attributenames that should be ignored and not stored in the database.
   &$record: 

API Tags:
Return:  True if succesful, false if not.


Redefined in descendants as:

[ Top ]
addDefaultExpandedSections  [line 1661]

  void addDefaultExpandedSections( )

Add sections that must be expanded by default.



[ Top ]
addFieldSet  [line 1097]

  void addFieldSet( string $name, string $template, [int $flags = 0], [mixed $sections = NULL], [int $order = 0]  )

Add fieldset.

To include an attribute label use [attribute.label] inside your template. To include an attribute edit/display field use [attribute.field] inside your template.

Parameters:
string   $name:  name
string   $template:  template string
int   $flags:  attribute flags
mixed   $sections:  The sections/tab(s) on which the attribute should be displayed. Can be a tabname (String) or a list of tabs (array) or "*" if the attribute should be displayed on all tabs.
int   $order:  The order at which the attribute should be displayed. If ommitted, this defaults to 100 for the first attribute, and 100 more for each next attribute that is added.

API Tags:
Access:  public


[ Top ]
addFilter  [line 1821]

  void addFilter( String $filter, [String $value = ""]  )

Add a recordset filter.

Parameters:
String   $filter:  The fieldname you want to filter OR a SQL where clause expression.
String   $value:  Required value. (Ommit this parameter if you pass an SQL expression for $filter.)


[ Top ]
addFlag  [line 1285]

  void addFlag( int $flag  )

Add a flag to the node.

Parameters:
int   $flag:  The flag to add.


[ Top ]
addListener  [line 4908]

  void addListener( &$listener, atkActionListener $listener  )

Add an atkActionListener to the node.

Parameters:
atkActionListener   $listener: 
   &$listener: 


[ Top ]
addSecurityMap  [line 4864]

  void addSecurityMap( Mixed $action, [String $mapped = ""]  )

Set the security of one or more actions action the same as other actions.

If $mapped is empty $action has to be an array. The key would be used as action and would be mapped to the value. If $mapped is not empty $action kan be a string containing one action of an array with one or more action. In both cases al actions would be mapped to $mappped

Parameters:
Mixed   $action:  The action that has to be mapped
String   $mapped:  The action on witch $action has to be mapped


[ Top ]
addStyle  [line 4830]

  void addStyle( String $style  )

Add a stylesheet to the page.

The theme engine is used to determine the path, and load the correct stylesheet.

Parameters:
String   $style:  The filename of the stylesheet (without path).


[ Top ]
addToQuery  [line 3699]

  void addToQuery( &$query, [String $alias = ""], [int $level = 0], [boolean $allfields = false], [string $mode = "select"], [array $includes = array()], atkQuery $query  )

Add this node to an existing query.

Framework method, it should not be necessary to call this method directly. This method is used when adding the entire node to an existing query, as part of a join.

Parameters:
atkQuery   $query:  The query statement
String   $alias:  The aliasprefix to use for fields from this node
int   $level:  The recursion level.
boolean   $allfields:  If set to true, all fields from the node are added to the query. If set to false, only the primary key and fields from the desriptor are added.
string   $mode:  The mode we're in
array   $includes:  List of fields that should be included
   &$query: 

Information Tags:
Todo:  The allfields parameter is too inflexible.

[ Top ]
addUniqueFieldset  [line 3415]

  void addUniqueFieldset( array $fieldArr  )

Add a unique field set.

When you add a set of attributes using this method, any combination of values for the attributes should be unique. For example, if you pass array("name", "parent_id"), name does not have to be unique, parent_id does not have to be unique, but the combination should be unique.

Parameters:
array   $fieldArr:  The list of names of attributes that should be unique in combination.


[ Top ]
allowed  [line 4338]

  boolean allowed( String $action, [array $record = ""]  )

This function determines if the user has the privilege to perform a certain action on the node.

Parameters:
String   $action:  The action to be checked.
array   $record:  The record on which the action is to be performed. The standard implementation ignores this parameter, but derived classes may override this method to implement their own record based security policy. Keep in mind that a record is not passed in every occasion. The method is called several times without a record, to just see if the user has the privilege for the action regardless of the record being processed.

API Tags:
Return:  True if the action may be performed, false if not.


[ Top ]
atkNodeType  [line 4316]

  String atkNodeType( )

Get the full atknodetype of this node (module.nodetype notation). This is sometimes referred to as the node name (or nodename) or node string.


API Tags:
Return:  The atknodetype of the node.


[ Top ]
attribSort  [line 4655]

  void attribSort( )

This function resorts the attribIndexList and attribList.

This is necessary if you add attributes *after* init() is already called, and you set an order for those attributes.



[ Top ]
attrib_cmp  [line 2831]

  int attrib_cmp( array $a, array $b  )

Small compare function for sorting attribs on order field

Parameters:
array   $a:  The first attribute
array   $b:  The second attribute

API Tags:
Access:  private


[ Top ]
buildTabs  [line 2550]

  array buildTabs( [String $action = ""]  )

Builds a list of tabs.

This doesn't generate the actual HTML code, but returns the data for the tabs (title, selected, urls that should be loaded upon click of the tab etc).

Parameters:
String   $action:  The action for which the tabs should be generated.

API Tags:
Return:  List of tabs

Information Tags:
Todo:  Make translation of tabs module aware

[ Top ]
callHandler  [line 4544]

  void callHandler( String $action  )

Invoke the handler for an action.

If there is a known registered external handler method for the specified action, this method will call it. If there is no custom external handler, the atkActionHandler object is determined and the actionis invoked on the actionhandler.

Parameters:
String   $action:  the node action


[ Top ]
changeMapping  [line 4894]

  void changeMapping( string $oldmapped, string $newmapped  )

change the securitymap that already exist. Where actions are mapped on $oldmapped change it by $newmapped

Parameters:
string   $oldmapped:  the old value
string   $newmapped:  the new value with replace the old one


[ Top ]
checkAttributeSecurity  [line 2034]

  void checkAttributeSecurity( string $mode, [array $record = NULL]  )

Check attribute security.

Makes some attributes read-only, or hides the attribute based on the current mode / record.

Parameters:
string   $mode:  current mode (add, edit, view etc.)
array   $record:  current record (optional)


[ Top ]
checkEmptyTabs  [line 1742]

  array checkEmptyTabs( array $list  )

Remove tabs without attribs from the tablist

Parameters:
array   $list:  The list of tabnames

API Tags:
Return:  The list of tabnames without the empty tabs.


[ Top ]
checkTabRights  [line 1687]

  array checkTabRights( &$tablist, array $tablist  )

Check if the user has the rights to access existing tabs and removes tabs from the list that may not be accessed

Parameters:
array   $tablist:  Array containing the current tablist
   &$tablist: 

API Tags:
Return:  with disable tabs


Redefined in descendants as:
  • atkMockNode::checkTabRights() : Check if the user has the rights to access existing tabs and removes tabs from the list that may not be accessed

[ Top ]
collectRecordActions  [line 4254]

  void; collectRecordActions( array $record, array &$actions, array &$mraactions  )

Function that is called for each record in a recordlist, to determine what actions may be performed on the record.

This function is a framework method and should not be called directly. It should not be overridden either.

To change the record actions, either override atkNode::recordActions() in you node, or call atkNode::registerRecordActionsCallback to register a callback.

Parameters:
array   $record:  The record for which the actions need to be determined.
array   &$actions:  Reference to an array with the already defined actions. This is an associative array with the action identifier as key, and an url as value. Actions can be removed from it, or added to the array.
array   &$mraactions:  List of multirecordactions that are supported for the passed record.

API Tags:
Access:  public


[ Top ]
confirmAction  [line 2727]

  String confirmAction( mixed $atkselector, String $action, [boolean $locked = false], [boolean $checkoverride = true], [boolean $mergeSelectors = true], [ $csrfToken = null]  )

Function returns a page in which the user is asked if he really wants to perform a certain action.

Parameters:
mixed   $atkselector:  Selector of current record on which the action will be performed (String), or an array of selectors when multiple records are processed at once. The method uses the selector(s) to display the current record(s) in the confirmation page.
String   $action:  The action for which confirmation is needed.
boolean   $locked:  Pass true if the current record is locked.
boolean   $checkoverride:  If set to true, this method will try to find a custom method named "confirm".$action."()" (e.g. confirmDelete() and call that method instead.
boolean   $mergeSelectors:  Merge all selectors to one selector string (if more then one)?
   $csrfToken: 

API Tags:
Return:  Complete html fragment containing a box with the confirmation page, or the output of the custom override if $checkoverride was true.


[ Top ]
confirmActionText  [line 2817]

  String confirmActionText( [String $atkselector = ""], [String $action = "delete"], [boolean $checkoverride = TRUE]  )

Determine the confirmation message.

Parameters:
String   $atkselector:  The record(s) on which the action is performed.
String   $action:  The action being performed.
boolean   $checkoverride:  If true, returns the output of a custom method named "confirm".$action."text()"

API Tags:
Return:  The confirmation text.


[ Top ]
copyDb  [line 3577]

  boolean copyDb( &$record, [string $mode = "copy"], array $record  )

Copy a record in the database.

Primarykeys are automatically regenerated for the copied record. Any detail records (onetomanyrelation) are copied too. Refered records manytoonerelation) are not copied.

Parameters:
array   $record:  The record to copy.
string   $mode:  The mode we're in (mostly "copy")
   &$record: 

API Tags:
Return:  True if succesful, false if not.


Redefined in descendants as:

[ Top ]
createPageBuilder  [line 3070]

  atkPageBuilder createPageBuilder( )

Returns a new page builder instance.


API Tags:
Access:  public


[ Top ]
defaultActions  [line 2615]

  array defaultActions( String $mode, [array $params = array()]  )

Retrieve an array with the default actions for a certain mode.

This will return a list of actions that can be performed on records of this node in an admin screen. The actions may contain a [pk] template variable to reference a record, so for each record you should run the stringparser on the action.

Parameters:
String   $mode:  The mode for which you want a list of actions. Currently available modes for this method:
  • "admin" (for actions in adminscreens)
  • "relation" (for the list of actions when displaying a recordlist in a onetomany-relation)
  • "view" (for actions when viewing only)
Note: the default implementation of defaultActions makes no difference between "relation" and "admin" and will return the same actions for both, but you might want to override this behaviour in derived classes.
array   $params:  An array of extra parameters to add to all the action urls. You can use this to pass things like an atkfilter for example. The array should be key/value based.

API Tags:
Return:  List of actions in the form array($action=>$actionurl)


[ Top ]
deleteDb  [line 3982]

  boolean deleteDb( String $selector, [bool $exectrigger = true], [bool $failwhenempty = false]  )

Delete record(s) from the database.

After deletion, the postDel() trigger in the node method is called, and on any attribute that has the AF_CASCADE_DELETE flag set, the delete() method is invoked.

NOTE: Does not commit your transaction! If you are using a database that uses transactions you will need to call 'atkGetDb()->commit()' manually.

Parameters:
String   $selector:  SQL expression used as where-clause that indicates which records to delete.
bool   $exectrigger:  wether to execute the pre/post triggers
bool   $failwhenempty:  determine whether to throw an error if there is nothing to delete

API Tags:
Return:  True if successful, false if not.

Information Tags:
Todo:  There's a discrepancy between updateDb, addDb and deleteDb: There should be a deleteDb which accepts a record, instead of a selector.

Redefined in descendants as:

[ Top ]
descriptor  [line 3331]

  String descriptor( [array $rec = ""]  )

Determine a descriptor of a record.

The descriptor is a string that describes a record for the user. For person records, this may be the firstname and the lastname, for companies it may be the company name plus the city etc. The descriptor is used when displaying records in a dropdown for example, or in the title of editpages, delete confirmations etc.

The descriptor method calls a method named descriptor_def() on the node to retrieve a template for the descriptor (string with attributenames between blockquotes, for example "[lastname], [firstname]".

If the node has no descriptor_def() method, the first attribute of the node is used as descriptor.

Derived classes may override this method to implement custom descriptor logic.

Parameters:
array   $rec:  The record for which the descriptor is returned.

API Tags:
Return:  The descriptor for the record.


[ Top ]
descriptorFields  [line 3269]

  array descriptorFields( )

Retrieve the list of attributes that are used in the descriptor definition.


API Tags:
Return:  The names of the attributes forming the descriptor.


[ Top ]
dispatch  [line 2980]

  void dispatch( array $postvars, [int $flags = NULL]  )

This is the wrapper method for all http requests on a node.

The method looks at the atkaction from the postvars and determines what should be done. If possible, it instantiates actionHandlers for handling the actual action.

Parameters:
array   $postvars:  The request variables for the node.
int   $flags:  Render flags (see class atkPage).


[ Top ]
editArray  [line 2108]

  array editArray( [String $mode = "add"], [array $record = NULL], [array $forceList = ""], [array $suppressList = ""], [String $fieldprefix = ""], [bool $ignoreTab = false], [bool $injectSections = true]  )

Function outputs an array with edit fields. For each field the array contains the name, edit HTML code etc. (name, html, obligatory, error, label)

Parameters:
String   $mode:  The edit mode ("add" or "edit")
array   $record:  The record currently being edited.
array   $forceList:  A key-value array used to preset certain fields to a certain value, regardless of the value in the record.
array   $suppressList:  List of attributenames that you want to hide
String   $fieldprefix:  Of set, each form element is prefixed with the specified prefix (used in embedded form fields)
bool   $ignoreTab:  Ignore the tabs an attribute should be shown on.
bool   $injectSections:  Inject sections?

API Tags:
Return:  List of edit fields (per field ( name, html, obligatory, error, label })

Information Tags:
Todo:  The editArray method should use a set of classes to build the form, instead of an array with an overly complex structure.

[ Top ]
edit_values  [line 2472]

  array edit_values( array $record  )

Retrieve new values for an existing record.

The system calls this method to override the values of a record before editing the record. The default implementation does not do anything to the record, but derived classes may override this method to make modifications to. the record.

Parameters:
array   $record:  The record that is about to be edited.

API Tags:
Return:  The manipulated record.


[ Top ]
escapeSQL  [line 5028]

  string escapeSQL( string $string  )

Escape SQL string, uses the node's database to do the escaping.

Parameters:
string   $string:  string to escape

API Tags:
Return:  escaped string
Access:  public


[ Top ]
executeTrigger  [line 3921]

  bool executeTrigger( string $trigger, &$record, [string $mode = null], array $record  )

Executes a trigger on a add,update or delete action

To prevent triggers from executing twice, the method stores an indication in the record when a trigger is executed. ('__executed<triggername>')

Parameters:
string   $trigger:  function, such as 'postUpdate'
array   $record:  record on which action is performed
string   $mode:  mode like add or update
   &$record: 

API Tags:
Return:  true on case of success or when the trigger isn't returning anything (assumes success)


[ Top ]
feedbackUrl  [line 4737]

  String feedbackUrl( String $action, int $status, [array $record = ""], [String $message = ""], [int $levelskip = null]  )

Determine the url for the feedbackpage.

Output is dependent on the feedback configuration. If feedback is not enabled for the action, this method returns an empty string, so the result of this method can be passed directly to the redirect() method after completing the action.

The $record parameter is ignored by the default implementation, but derived classes may override this method to perform record-specific feedback.

Parameters:
String   $action:  The action that was performed
int   $status:  The status of the action.
array   $record:  The record on which the action was performed.
String   $message:  An optional message to pass to the feedbackpage, for example to explain the reason why an action failed.
int   $levelskip:  Number of levels to skip

API Tags:
Return:  The feedback url.


[ Top ]
fetchByPk  [line 3676]

  array fetchByPk( int $pk  )

Returns a record (array) as identified by a primary key (usually an "id" column), including applicable relations.

Parameters:
int   $pk:  primary key identifying the record

API Tags:
Return:  the associated record, or null if no such record exists
Access:  public


[ Top ]
filledInForm  [line 1215]

  boolean. &filledInForm( - 0  )

Checks if the user has filled in something: return true if he has, otherwise return false

Parameters:
-   0: 


[ Top ]
genericPage  [line 3000]

  String genericPage( String $title, mixed $content  )

Render a generic page, with a box, title, stacktrace etc.

Parameters:
String   $title:  The pagetitle and if $content is a string, also the boxtitle.
mixed   $content:  The content to display on the page. This can be:
  • A string which will be the content of a single box on the page.
  • An associative array of $boxtitle=>$boxcontent pairs. Each pair will be rendered as a seperate box.

API Tags:
Return:  A complete html page with the desired content.


[ Top ]
getAction  [line 4305]

  string getAction( )

Returns the current action for this node.


API Tags:
Return:  action
Access:  public


[ Top ]
getActiveSections  [line 1790]

  void getActiveSections( string $tab, string $mode  )

Get the active sections.

Parameters:
string   $tab:  The currently active tab
string   $mode:  The current mode ("edit", "add", etc.)


[ Top ]
getActiveTab  [line 1771]

  String getActiveTab( )

Returns the currently active tab.

Note that in themes which use dhtml tabs (tabs without reloads), this method will always return the name of the first tab.


API Tags:
Return:  The name of the currently visible tab.


[ Top ]
getAttribute  [line 1202]

  atkAttribute &getAttribute( String $name  )

Get an attribute by name.

Parameters:
String   $name:  The name of the attribute to retrieve.

API Tags:
Return:  The attribute.


[ Top ]
getAttributeNames  [line 1244]

  array getAttributeNames( )

Returns a list of attribute names.


API Tags:
Return:  attribute names


[ Top ]
getAttributeOrder  [line 1254]

  void getAttributeOrder( string $name  )

Gets the attribute order.

Parameters:
string   $name:  The name of the attribute


[ Top ]
getAttributes  [line 1232]

  array &getAttributes( )

Gets all the attributes.


API Tags:
Return:  Array with the attributes.


[ Top ]
getColumnConfig  [line 4962]

  atkColumnConfig &getColumnConfig( [string $id = NULL], [boolean $forceNew = false]  )

Get the column configuration object

Parameters:
string   $id:  optional column config id
boolean   $forceNew:  force new instance?


[ Top ]
getDb  [line 1492]

  atkDb getDb( )

Get the database connection for this node.


API Tags:
Return:  Database connection instance


[ Top ]
getDefaultActionParams  [line 2017]

  array getDefaultActionParams( [boolean $locked = false]  )

Determine the default form parameters for an action template.

Parameters:
boolean   $locked:  If the current record is locked, pass true, so the lockicon can be placed in the params too.

API Tags:
Return:  Default form parameters for action forms (assoc. array)


[ Top ]
getDefaultColumn  [line 837]

  string getDefaultColumn( )

Returns the default column name.


API Tags:
Return:  default column name
Access:  public


[ Top ]
getDescriptorHandler  [line 3232]

  Object &getDescriptorHandler( )

Get descriptor handler.


API Tags:
Return:  descriptor handler


[ Top ]
getDescriptorTemplate  [line 3250]

  String getDescriptorTemplate( )

Returns the descriptor template for this node.


API Tags:
Return:  The descriptor Template


[ Top ]
getEditFieldPrefix  [line 5015]

  string getEditFieldPrefix( [boolean $atk_layout = true]  )

Get the edit fieldprefix to use

Parameters:
boolean   $atk_layout:  do we want the prefix in atkstyle (with _AE_) or not

API Tags:
Return:  with edit fieldprefix


[ Top ]
getExtendedSearchAction  [line 2688]

  extended getExtendedSearchAction( )

Get extended search action.


API Tags:
Return:  search action


[ Top ]
getFirstTargetFieldFromFilterSql  [line 4809]

  string getFirstTargetFieldFromFilterSql( string $sql  )

Get the targeted field and table from a snippet of filter string sql

Parameters:
string   $sql:  is the filter string sql

API Tags:
Return:  the target table and field or an empty string


[ Top ]
getFlags  [line 1304]

  Integer getFlags( )

Returns the node flags.


API Tags:
Return:  node flags


[ Top ]
getFormButtons  [line 1880]

  array getFormButtons( String $mode, array $record  )

Returns the form buttons for a certain page.

Can be overridden by derived classes to define custom buttons.

Parameters:
String   $mode:  The action for which the buttons are retrieved.
array   $record:  The record currently displayed/edited in the form. This param can be used to define record specific buttons.


[ Top ]
getHandler  [line 4580]

  atkActionHandler &getHandler( String $action  )

Get the atkActionHandler object for a certain action.

The default implementation returns a default handler for the action, but derived classes may override this to return a custom handler.

Parameters:
String   $action:  The action for which the handler is retrieved.

API Tags:
Return:  The action handler.


[ Top ]
getHelp  [line 4471]

  String getHelp( )

Retrieve help link for the current node.


API Tags:
Return:  Complete html link, linking to the help popup.


[ Top ]
getLockMode  [line 3374]

  int getLockMode( )

Returns the lock mode.


API Tags:
Return:  lock mode (atkLock::EXCLUSIVE, atkLock::SHARED)
Access:  public


[ Top ]
getLockStatusIcon  [line 4490]

  String getLockStatusIcon( boolean $lockstatus  )

Get img tag for lock icon.

Parameters:
boolean   $lockstatus:  True if the record is locked, false if not.

API Tags:
Return:  HTML image tag with the correct lock icon.


[ Top ]
getModule  [line 4295]

  string getModule( )

Returns the module for this node.


API Tags:
Return:  node
Access:  public


[ Top ]
getMRASelectionMode  [line 1369]

  Integer getMRASelectionMode( )

Returns the multi-record-action selection mode.


API Tags:
Return:  multi-record-action selection mode


[ Top ]
getNumbering  [line 4851]

  mixed getNumbering( )

Gets the numbering of the attributes


API Tags:
Return:  the number whith which the numbering starts


[ Top ]
getOrder  [line 1449]

  String getOrder( )

Get default sort order for the node.


API Tags:
Return:  Default order by. Can be an attribute name or a SQL expression.


[ Top ]
getPage  [line 3059]

  atkPage &getPage( )

Get the page instance of the page on which the node can render output.


API Tags:
Return:  The page instance.


[ Top ]
getPartial  [line 1324]

  string getPartial( )

Returns the current partial name.


API Tags:
Return:  partial name
Access:  public


[ Top ]
getRowClassCallback  [line 5163]

  array getRowClassCallback( )

Return array with callback function list, which use for add css class to row


API Tags:
Access:  public


[ Top ]
getSearchCondition  [line 3765]

  string getSearchCondition( &$query, string $table, string $alias, string $value, string $searchmode, atkQuery $query  )

Get search condition for this node.

Parameters:
atkQuery   $query: 
string   $table: 
string   $alias: 
string   $value: 
string   $searchmode: 
   &$query: 

API Tags:
Return:  The search condition


[ Top ]
getSearchMode  [line 3607]

  mixed getSearchMode( )

Get the current searchmode.


API Tags:
Return:  If there is one searchmode set for all attributes, this method returns a string. If there are searchmodes per attribute, an array of strings is returned.


[ Top ]
getSections  [line 1637]

  array getSections( String $action  )

Retrieve the sections for the active tab.

Parameters:
String   $action: 

API Tags:
Return:  The active sections.


[ Top ]
getSecurityAlias  [line 4411]

  string getSecurityAlias( )

Returns the node's security alias (if set).


API Tags:
Return:  security alias


[ Top ]
getTabFromSection  [line 1137]

  void getTabFromSection( string $section  )

Strip section part from a section and return the tab.

If no tab name is provided, the default tab is returned.

Parameters:
string   $section:  The section to get the tab from


[ Top ]
getTable  [line 1192]

  string getTable( )

Returns the table name for this node.


API Tags:
Return:  table name


[ Top ]
getTabs  [line 1571]

  array getTabs( String $action  )

Get a list of tabs for a certain action.

Parameters:
String   $action:  The action for which you want to retrieve the list of tabs.

API Tags:
Return:  The list of tabnames.


Redefined in descendants as:

[ Top ]
getTabsFromSections  [line 1108]

  void getTabsFromSections( mixed $sections  )

Retrieve the tabnames from the sections string (tab.section).

Parameters:
mixed   $sections:  An array with sections or a section string


[ Top ]
getTemplate  [line 2498]

  String getTemplate( String $action, [array $record = NULL], [String $tab = ""]  )

Get the template to use for a certain action.

The system calls this method to determine which template to use when rendering a certain screen. The default implementation always returns the same template for the same action (it ignores parameter 2 and 3). You can override this method in derived classes however, to determine on the fly which template to use. The action, the current record (if any) and the tab are passed as parameter. By using these params, you can have custom templates per action, and/or per tab, and even per record.

Parameters:
String   $action:  The action for which you wnat to retrieve the template.
array   $record:  The record for which you want to return the template (or NULL if there is no record).
String   $tab:  The name of the tab for which you want to retrieve the template.

API Tags:
Return:  The filename of the template (without path)


[ Top ]
getType  [line 4285]

  string getType( )

Returns the type of this node. (This is *not* the full ATK node type; see atkNodeType() for the full node type.)


API Tags:
Return:  type
Access:  public


[ Top ]
getUi  [line 1914]

  atkUi &getUi( )

Get the ui instance for drawing and templating purposes.


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


[ Top ]
groupFieldsBySection  [line 2388]

  void groupFieldsBySection( &$fields, array $fields  )

Group fields by section.

Parameters:
array   $fields:  fields array (will be modified in-place)
   &$fields: 


[ Top ]
hasFlag  [line 1276]

  boolean hasFlag( int $flag  )

Checks if the node has a certain flag set.

Parameters:
int   $flag:  The flag to check.

API Tags:
Return:  True if the node has the flag.


[ Top ]
helpUrl  [line 4509]

  String helpUrl( )

Get the help url for this node.

Retrieves the url of the help popup, if there is help available for this node.


API Tags:
Return:  The help url, or an empty string if help is not available.


[ Top ]
hideForm  [line 2527]

  String hideForm( [String $mode = "add"], [array $record = NULL], [array $forceList = ""], [String $fieldprefix = ""]  )

Function outputs a form with all values hidden.

This is probably only useful for the atkOneToOneRelation's hide method.

Parameters:
String   $mode:  The edit mode ("add" or "edit")
array   $record:  The record that should be hidden.
array   $forceList:  A key-value array used to preset certain fields to a certain value, regardless of the value in the record.
String   $fieldprefix:  Of set, each form element is prefixed with the specified prefix (used in embedded form fields)

API Tags:
Return:  HTML fragment containing all hidden elements.


[ Top ]
init  [line 2845]

  void init( )

This function initialises certain elements of the node.

This must be called right after the constructor. The function has a check to prevent it from being executed twice. If you construct a node using 'new', you have to call this method. If you construct it with the getNode or newNode method, you don't have to call this method.



[ Top ]
initial_values  [line 2436]

  array initial_values( )

Retrieve the initial values for a new record.

The system calls this method to create a new record. By default this method returns an empty record, but derived nodes may override this method to perform record initialization.


API Tags:
Return:  Array containing an initial value per attribute. Only attributes that are initialized appear in the array.


[ Top ]
injectSections  [line 2351]

  void injectSections( &$fields, array $fields  )

Add sections to the edit/view fields array.

Parameters:
array   $fields:  fields array (will be modified in-place)
   &$fields: 


[ Top ]
isPartial  [line 1334]

  boolean isPartial( )

Is partial request?


API Tags:
Return:  is partial


[ Top ]
lockPage  [line 1892]

  String lockPage( )

Generate a box displaying a message that the current record is locked.


API Tags:
Return:  The HTML fragment containing a box with the message and a back-button.


[ Top ]
modifyRecord  [line 3219]

  void modifyRecord( &$record, array $vars, array $record  )

Update a record with variables from a form posting.

Similar to updateRecord(), but here you can pass an existing record (for example loaded from the db), and update it with the the variables from the request. Instead of returning a record, the record you pass is modified directly.

Parameters:
array   $record:  The record to update.
array   $vars:  The request variables that were posted from a form.
   &$record: 


[ Top ]
notify  [line 4932]

  void notify( String $action, array $record  )

Notify all listeners of the occurance of a certain action.

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


[ Top ]
postAdd  [line 4055]

  boolean postAdd( array $record, [String $mode = "add"]  )

Function that is called by the framework, right after a new record has been saved to the database.

This function does essentially nothing, but it can be overriden in derived classes if you want to do something special after you saved a record.

Parameters:
array   $record:  The record that has just been saved.
String   $mode:  The 'mode' indicates whether the added record was a completely new record ("add") or a copy ("copy").

API Tags:
Return:  True if succesful, false if not.


[ Top ]
postDel  [line 4140]

  bool postDel( array $record  )

Deprecated function that is called by the framework, right after a record has been deleted.

Please use postDelete() instead.

Parameters:
array   $record:  The record that has just been deleted.

API Tags:
Return:  Wether or not we succeeded in what we wanted to do.


[ Top ]
postDelete  [line 4157]

  bool postDelete( array $record  )

Function that is called by the framework, right after a record has been deleted.

This function does essentially nothing, but it can be overriden in derived classes if you want to do something special after a record is deleted.

Parameters:
array   $record:  The record that has just been deleted.

API Tags:
Return:  Wether or not we succeeded in what we wanted to do.


[ Top ]
postUpdate  [line 4093]

  boolean postUpdate( array $record  )

Function that is called by the framework, right after an existing record has been updated in the database.

This function does essentially nothing, but it can be overriden in derived classes if you want to do something special after the record is updated.

If the NF_TRACK_CHANGES flag is present for the node, both the new and the original record are passed to this method. The original record is stored in the new record, in $record["atkorgrec"].

Parameters:
array   $record:  The record that has just been updated in the database.

API Tags:
Return:  True if succesful, false if not.


[ Top ]
preAdd  [line 4071]

  void preAdd( &$record, array $record  )

Function that is called by the framework, just before a new record will be saved to the database.

This function does essentially nothing, but it can be overriden in derived classes if you want to modify the record just before it will be saved.

Parameters:
array   $record:  The record that will be saved to the database.
   &$record: 


[ Top ]
preAddToEditArray  [line 2067]

  void preAddToEditArray( &$record, string $mode, array $record  )

The preAddToEditArray method is called from within the editArray

method prior to letting the attributes add themselves to the edit array, but after the edit record values have been collected (a combination of the current record, initial/edit values and the forced values). This makes it possible to do some last-minute modifications to the record data and possibily add some last-minute attributes etc.

Parameters:
array   $record:  the edit record
string   $mode:  edit mode (add or edit)
   &$record: 


[ Top ]
preAddToViewArray  [line 2082]

  void preAddToViewArray( &$record, string $mode, array $record  )

The preAddToViewArray method is called from within the viewArray

method prior to letting the attributes add themselves to the view array, but after the view record values have been collected This makes it possible to do some last-minute modifications to the record data and possibily add some last-minute attributes etc.

Parameters:
array   $record:  the edit record
string   $mode:  view mode
   &$record: 


[ Top ]
preCopy  [line 4179]

  void preCopy( &$record, array $record  )

Function that is called by the framework, right before a copied record is stored to the database.

This function does nothing, but it can be overriden in derived classes if you want to do some processing on a record before it is being copied. Typical usage would be: Suppose you have a field named 'title' in a record. In the preCopy method, you could change the title field of the record to 'Copy of ..', so the user can distinguish between the original and the copy.

Parameters:
array   $record:  A reference to the copied record. You can change the contents of the record, since it is passed by reference.
   &$record: 


[ Top ]
preDelete  [line 4128]

  void preDelete( array $record  )

Function that is called by the framework, right before a record will be deleted. Should this method return false the deleting will halt.

This function does essentially nothing, but it can be overriden in derived classes if you want to do something special after a record is deleted.

If this function returns false the delete action will not continue.

Parameters:
array   $record:  The record that will be deleted.


[ Top ]
preNotify  [line 4946]

  void preNotify( String $action, &$record, array $record  )

Notify all listeners in advance of the occurance of a certain action.

Parameters:
String   $action:  The action that will occur
array   $record:  The record on which the action will be performed
   &$record: 


[ Top ]
preUpdate  [line 4110]

  bool preUpdate( &$record, array $record  )

Function that is called by the framework, just before an existing record will be saved to the database.

This function does essentially nothing, but it can be overriden in derived classes if you want to modify the record just before it will be saved.

Parameters:
array   $record:  The record that will be updated in the database.
   &$record: 

API Tags:
Return:  Wether or not we succeeded in what we wanted to do.


[ Top ]
primaryKey  [line 1379]

  String primaryKey( array $rec  )

Returns the primary key sql expression of a record.

Parameters:
array   $rec:  The record for which the primary key is calculated.

API Tags:
Return:  the primary key of the record.


[ Top ]
primaryKeyField  [line 1400]

  String primaryKeyField( )

Retrieve the name of the primary key attribute.

Note: If a node has a primary key that consists of multiple attributes, this method will retrieve only the first attribute!


API Tags:
Return:  First primary key attribute


[ Top ]
primaryKeyTpl  [line 1421]

  String primaryKeyTpl( )

Returns a primary key template.

Like primaryKey(), this method returns a sql expression, but in this case, no actual data is used. Instead, template fields are inserted into the expression. This is useful for rendering multiple primary keys later with a record and a template parser.


API Tags:
Return:  Primary key template


[ Top ]
recordActions  [line 4205]

  void recordActions( array $record, array &$actions, array &$mraactions  )

Function that is called for each record in a recordlist, to determine what actions may be performed on the record.

This function does nothing, but it can be overriden in derived classes, to make custom actions for certain records. The array with actions (edit, delete, etc.) is passed to the function and can be modified. To create a new action, just do $actions["new_action"]=$url; in the derived function. To disable existing actions, for example the edit action, for a record, use: unset($actions["edit"]);

Parameters:
array   $record:  The record for which the actions need to be determined.
array   &$actions:  Reference to an array with the already defined actions. This is an associative array with the action identifier as key, and an url as value. Actions can be removed from it, or added to the array.
array   &$mraactions:  List of multirecordactions that are supported for the passed record.


Redefined in descendants as:

[ Top ]
registerRecordActionsCallback  [line 4218]

  void registerRecordActionsCallback( $callback  )

Registers a function/method that is called for each record in a recordlist, to determine what actions may be performed on the record.

The callback receives the record, a reference to the record actions and a reference to the MRA actions as arguments.

Parameters:
   $callback: 

API Tags:
Access:  public


[ Top ]
remove  [line 1156]

  void remove( String $attribname  )

Remove an attribute.

Completely removes an attribute from a node. Note: Since other functionality may already depend on the attribute that you are about to remove, it's often better to just hide an attribute if you don't need it.

Parameters:
String   $attribname:  The name of the attribute to remove.


[ Top ]
removeDefaultExpandedSections  [line 1672]

  void removeDefaultExpandedSections( )

Remove sections that must be expanded by default.



[ Top ]
removeFilter  [line 1841]

  TRUE removeFilter( String $filter, [String $value = ""]  )

Search and remove a recordset filter.

Parameters:
String   $filter:  The filter to search for
String   $value:  The value to search for in case it is not a fuzzy filter

API Tags:
Return:  if the given filter was found and removed, FALSE otherwise.


[ Top ]
removeFlag  [line 1295]

  void removeFlag( int $flag  )

Removes a flag from the node.

Parameters:
int   $flag:  The flag to remove from the attribute


[ Top ]
renderActionPage  [line 3018]

  String renderActionPage( String $action, [mixed $blocks = array()]  )

Render a generic action.

Renders actionpage.tpl for the desired action. This includes the given block(s) and a pagetrial, but not a box.

Parameters:
String   $action:  The action for which the page is rendered.
mixed   $blocks:  Pieces of html content to be rendered. Can be a single string with content, or an array with multiple content blocks.

API Tags:
Return:  Piece of HTML containing the given blocks and a pagetrail.


[ Top ]
resolveColumn  [line 863]

  string resolveColumn( &$sections, array $sections  )

Resolve column for sections.

If one of the sections contains something after a double colon (:) than that's used as column name, else the default column name will be used.

Parameters:
array   $sections:  sections
   &$sections: 

API Tags:
Return:  column name
Access:  protected


[ Top ]
resolveNodeTypeAndAction  [line 4359]

  void resolveNodeTypeAndAction( &$alias, &$action, string $alias, string $action  )

Resolves a possible node / action alias for the given node / action.

The given node alias and action are updated depending on the found mapping.

Parameters:
string   $alias:  node type
string   $action:  action name
   &$alias: 
   &$action: 


[ Top ]
resolveSection  [line 802]

  resolved resolveSection( string $section  )

Resolve section. If a section is only prefixed by a dot this means we need to add the default tab before the dot.

Parameters:
string   $section:  section name

API Tags:
Return:  section name


[ Top ]
resolveSections  [line 820]

  array resolveSections( array $sections  )

Resolve sections.

Parameters:
array   $sections:  section list

API Tags:
Return:  resolved section list
See:  atkNode::resolveSection()


[ Top ]
resolveSectionsTabsOrder  [line 891]

  void resolveSectionsTabsOrder( &$sections, &$tabs, &$column, &$order, mixed $sections, mixed $tabs, mixed $order  )

Resolve sections, tabs and the order based on the given argument to the attribute add method.

Parameters:
mixed   $sections: 
mixed   $tabs: 
mixed   $order: 
   &$sections: 
   &$tabs: 
   &$column: 
   &$order: 


[ Top ]
rowClass  [line 5043]

  string rowClass( array $record, int $nr  )

Row CSS class.

Used to determine the CSS class(s) for rows in the datagrid list.

Parameters:
array   $record:  record
int   $nr:  row number

API Tags:
Return:  CSS class(es)
Access:  public


[ Top ]
searchDb  [line 4686]

  array searchDb( String $expression, [string $searchmethod = "OR"]  )

Search all records for the occurance of a certain expression.

This function searches in all fields that are not AF_HIDE_SEARCH, for a certain expression (substring match). The search performed is an 'or' search. If any of the fields contains the expression, the record is added to the resultset.\

Currently, searchDb only searches those attributes that are of type string or text.

Parameters:
String   $expression:  The keyword to search for.
string   $searchmethod: 

API Tags:
Return:  Set of records matching the keyword.


[ Top ]
securityKey  [line 4273]

  String securityKey( String $action  )

Retrieve the security key of an action.

Returns the privilege required to perform a certain action. Usually, the privilege and the action are equal, but in m_securityMap, aliasses may be defined.

Parameters:
String   $action:  The action for which you want to determine the privilege.

API Tags:
Return:  The security privilege required to perform the action.


[ Top ]
select  [line 3649]

  atkSelector select( [string $condition = null], [ $params = array()]  )

Retrieve records from the database using a handy helper class.

Parameters:
string   $condition:  condition
array   $params:  condition bind parameters

API Tags:
Access:  public


[ Top ]
setAttribSizes  [line 2952]

  void setAttribSizes( )

This function reads meta information from the database and initialises its attributes with the metadata.

This method should be called before rendering a form, if you want the sizes of all the inputs to match the fieldlengths from the database.



Redefined in descendants as:

[ Top ]
setAttributeOrder  [line 1265]

  void setAttributeOrder( string $name, int $order  )

Sets an attributes order

Parameters:
string   $name:  The name of the attribute
int   $order:  The order of the attribute


[ Top ]
setDb  [line 1483]

  void setDb( string|atkDb $db  )

Sets the database connection.

Parameters:
string|atkDb   $db:  database name or object

API Tags:
Access:  public


[ Top ]
setDefaultColumn  [line 847]

  void setDefaultColumn( string $name  )

Set default column name.

Parameters:
string   $name:  name default column name

API Tags:
Access:  public


[ Top ]
setDefaultTab  [line 1559]

  void setDefaultTab( [String $tab = "default"]  )

Set default tab being displayed in view/add/edit mode.

After calling this method, all attributes which are added after the method call without specification of tab will be placed on the default tab. This means you should use this method before you add any attributes to the node. If you accept the default name for the first tab ("default") you do not need to call this method.

Parameters:
String   $tab:  the name of the default tab


[ Top ]
setDescriptorHandler  [line 3241]

  void setDescriptorHandler( &$handler, Object $handler  )

Set descriptor handler.

Parameters:
Object   $handler:  The descriptor handler.
   &$handler: 


[ Top ]
setDescriptorTemplate  [line 3259]

  void setDescriptorTemplate( String $template  )

Sets the descriptor template for this node.

Parameters:
String   $template:  The descriptor template.


[ Top ]
setEditableListAttributes  [line 1346]

  void setEditableListAttributes( array $attrs  )

Sets the editable list attributes. If you supply this method with one or more string arguments, all arguments are collected in an array. Else the first parameter will be used.

Parameters:
array   $attrs:  list of attribute names


[ Top ]
setEditFieldPrefix  [line 5004]

  void setEditFieldPrefix( string $prefix  )

Set the edit fieldprefix to use in atk

Parameters:
string   $prefix: 


[ Top ]
setExtendedSearchAction  [line 2700]

  void setExtendedSearchAction( string $action  )

Set extended search action.

Parameters:
string   $action:  extended search action


[ Top ]
setFeedback  [line 3040]

  void setFeedback( mixed $action, int $statusmask  )

Use this function to enable feedback for one or more actions.

When feedback is enabled, the action does not immediately return to the previous screen, but first displays a message to the user. (e.g. 'The record has been saved').

Parameters:
mixed   $action:  The action for which feedback is enabled. You can either pass one action or an array of actions.
int   $statusmask:  The status(ses) for which feedback is enabled. If for example this is set to ACTION_FAILED, feedback is enabled only when the specified action failed. It is possible to specify more than one status by concatenating with '|'.


[ Top ]
setFlags  [line 1314]

  void setFlags( int $flags  )

Set node flags.

Parameters:
int   $flags:  node flags

API Tags:
Access:  public


[ Top ]
setIndex  [line 1517]

  void setIndex( String $attribname  )

Create an alphabetical index.

Any string- or textbased attribute can be used to create an alphabetical index in admin- and selectpages.

Parameters:
String   $attribname:  The name of the attribute for which to create the alphabetical index.


[ Top ]
setLockMode  [line 3364]

  void setLockMode( int $lockMode  )

Sets the lock mode.

Parameters:
int   $lockMode:  lock mode (atkLock::EXCLUSIVE, atkLock::SHARED)

API Tags:
Access:  public


[ Top ]
setMRASelectionMode  [line 1360]

  void setMRASelectionMode( string $mode  )

Sets the multi-record-action selection mode. Can either be MRA_MULTI_SELECT (default), MRA_SINGLE_SELECT or MRA_NO_SELECT.

Parameters:
string   $mode:  selection mode


[ Top ]
setNumbering  [line 4842]

  void setNumbering( [mixed $number = 1]  )

Sets numbering of the attributes to begin with the number that was passed to it, or defaults to 1.

Parameters:
mixed   $number:  the number that the first attribute begins with


[ Top ]
setOrder  [line 1439]

  void setOrder( String $orderby  )

Set default sort order for the node.

Parameters:
String   $orderby:  Default order by. Can be an attribute name or a SQL expression.


[ Top ]
setPriorityActions  [line 2677]

  void setPriorityActions( array $actions  )

Sets the possible multi-record-priority actions.

Parameters:
array   $actions:  list of actions


[ Top ]
setPriorityRange  [line 2666]

  void setPriorityRange( [int $min = 1], [int $max = 0]  )

Sets the priority range, for multi-record-priority actions.

Parameters:
int   $min:  the minimum priority
int   $max:  the maximum priority (0 for auto => min + record count)


[ Top ]
setRowClassCallback  [line 5129]

  boolean setRowClassCallback( mixed $callback  )

Add callback function for add css class to row.

Parameters:
mixed   $callback:  name of a function or array with an object and the name of a method or closure

API Tags:
Access:  public


[ Top ]
setSearchAction  [line 4644]

  void setSearchAction( String $action  )

Sets the search action.

The search action is the action that will be performed if only a single record is found after doing a certain search query.

You can specify more then 1 action. If the user isn't allowed to execute the 1st action, the 2nd action will be used, etc. If you want to pass multiple actions, just pass multiple params (function has a variable number of arguments).

Parameters:
String   $action:  The name of the action.

Information Tags:
Todo:  Using func_get_args is non-standard. It's cleaner to accept an array.

[ Top ]
setSecurityAlias  [line 4401]

  void setSecurityAlias( String $alias  )

Set the security alias of a node.

By default a node has it's own set of privileges. With this method, the privileges of another node can be used. This is useful when you have a master/detail relationship, and people may manipulate details when they have privileges on the master node. Note: When setting an alias for the node, the node no longer has to have a registerNode call in the getNodes method in module.inc.

Parameters:
String   $alias:  The node (module.nodename) to set as a security alias for this node.


[ Top ]
setTabIndex  [line 1529]

  void setTabIndex( string $tabname, int $index, [string $action = ""]  )

Set tab index

Parameters:
string   $tabname:  Tabname
int   $index:  Index number
string   $action:  Action name (add,edit,view)


[ Top ]
setTable  [line 1470]

  void setTable( String $tablename, [String $seq = ""], [mixed $db = NULL]  )

Set the table that the node should use.

Note: This should be called in the constructor of derived classes, after the base class constructor is called.

Parameters:
String   $tablename:  The name of the table to use.
String   $seq:  The name of the sequence to use for autoincrement attributes.
mixed   $db:  The database connection to use. If ommitted, this defaults to the default database connection. So in apps using only one database, it's not necessary to pass this parameter. You can pass either a connection (atkDb instance), or a string containing the name of the connection to use.


[ Top ]
statusbar  [line 4441]

  void statusbar( [boolean $locked = FALSE]  )

Display a statusbar with a stacktrace and a help button.

Parameters:
boolean   $locked:  is the currently displayed item locked?

API Tags:
Deprecated:  Use the {statusbar} tag in templates instead.


[ Top ]
tabulate  [line 1973]

  String tabulate( String $action, String $content  )

Place a set of tabs around content.

Parameters:
String   $action:  The action for which the tabs are loaded.
String   $content:  The content that is to be displayed within the tabset.

API Tags:
Return:  The complete tabset with content.


[ Top ]
text  [line 4983]

  String text( mixed $string, [String $module = NULL], [String $lng = ""], [String $firstfallback = ""], [boolean $nodefaulttext = false]  )

Translate using this node's module and type.

Parameters:
mixed   $string:  string or array of strings containing the name(s) of the string to return when an array of strings is passed, the second will be the fallback if the first one isn't found, and so forth
String   $module:  module in which the language file should be looked for, defaults to core module with fallback to ATK
String   $lng:  ISO 639-1 language code, defaults to config variable
String   $firstfallback:  the first module to check as part of the fallback
boolean   $nodefaulttext:  if true, then it doesn't return a default text when it can't find a translation

API Tags:
Return:  the string from the languagefile


[ Top ]
trackChangesIfNeeded  [line 3432]

  void trackChangesIfNeeded( &$record, [array $excludes = ''], [array $includes = ''], array $record  )

Called by updateDb to load the original record inside the record if the NF_TRACK_CHANGES flag is set.

NOTE: this method is made public because it's called from the update handler

Parameters:
array   $record: 
array   $excludes: 
array   $includes: 
   &$record: 

API Tags:
Access:  public


[ Top ]
updateDb  [line 3468]

  boolean updateDb( &$record, [bool $exectrigger = true], [array $excludes = ""], [array $includes = ""], array $record  )

Update a record in the database.

The record should already exist in the database, or this method will fail.

NOTE: Does not commit your transaction! If you are using a database that uses transactions you will need to call 'atkGetDb()->commit()' manually.

Parameters:
array   $record:  The record to update in the database.
bool   $exectrigger:  wether to execute the pre/post update triggers
array   $excludes:  exclude list (these attribute will *not* be updated)
array   $includes:  include list (only these attributes will be updated)
   &$record: 

API Tags:
Return:  True if succesful, false if not.


Redefined in descendants as:

[ Top ]
updateRecord  [line 3184]

  array updateRecord( [array $vars = ""], [array $includes = NULL], [array $excludes = NULL], [array $postedOnly = false]  )

Parse a set of url vars into a valid record structure.

When attributes are posted in a formposting, the values may not be valid yet. After posting, a call to updateRecord should be made to translate the html values into the internal values that the attributes work with.

Parameters:
array   $vars:  The request variables that were posted from a form.
array   $includes:  Only fetch the value for these attributes.
array   $excludes:  Don't fetch the value for these attributes.
array   $postedOnly:  Only fetch the value for attributes that have really been posted.

API Tags:
Return:  A valid record.


[ Top ]
validate  [line 3392]

  void validate( &$record, String $mode, [array $ignoreList = array()], array $record  )

Validates a record.

Validates unique fields, required fields, dataformat etc.

Parameters:
array   $record:  The record to validate
String   $mode:  The mode for which validation is performed ('add' or 'update')
array   $ignoreList:  The list of attributes that should not be validated
   &$record: 

API Tags:
Internal:  This method instantiates the node's validator object, and delegates validation to that object.


Redefined in descendants as:

[ Top ]
validateFilter  [line 4756]

  String validateFilter( String $filter  )

Validates if a filter is valid for this node.

A filter is considered valid if it doesn't contain any fields that are not part of the node.

Why isn't this used more often???

Parameters:
String   $filter:  The filter expression to validate

API Tags:
Return:  Returns $filter if the filter is valid or a empty string if not.
Access:  public


[ Top ]
viewArray  [line 2299]

  array viewArray( String $mode, array $record, [bool $injectSections = true]  )

Function outputs an array with view fields. For each field the array contains the name, view HTML code etc.

Parameters:
String   $mode:  The edit mode ("view")
array   $record:  The record currently being viewed.
bool   $injectSections:  Inject sections?

API Tags:
Return:  List of edit fields (per field ( name, html, obligatory, error, label })

Information Tags:
Todo:  The viewArray method should use a set of classes to build the form, instead of an array with an overly complex structure.

[ Top ]
_addListeners  [line 2913]

  void _addListeners( )

Add the listeners for the current node

A listener can be defined either by placing an instantiated object or the full location in atkimport style notation, in a global array called $g_nodeListeners (useful for example for adding listeners to nodes from another module's module.inc file. in module.inc files, $listeners can be used to add listeners to a node.


API Tags:
Access:  private


[ Top ]
_initSelector  [line 3629]

  void _initSelector( atkSelector $selector, [string $condition = null], [array $params = array()]  )

Set some default for the selector.

Parameters:
atkSelector   $selector:  selector
string   $condition:  condition
array   $params:  condition bind parameters

API Tags:
Access:  protected


[ Top ]
_storeAttributes  [line 3550]

  boolean _storeAttributes( array $storelist, &$record, String $mode, array $record  )

Call the store() method on a list of attributes.

Parameters:
array   $storelist:  The list of attributes for which the store() method should be called.
array   $record:  The master record being stored.
String   $mode:  The storage mode ("add", "copy" or "update")
   &$record: 

API Tags:
Return:  True if succesful, false if not.
Access:  private


[ Top ]
__call  [line 5054]

  void __call( string $method, array $params  )

Catch missing methods.

Parameters:
string   $method:  method name
array   $params:  method parameters

API Tags:
Access:  public


[ Top ]
__toString  [line 4994]

  string __toString( )

String representation for this node (PHP5 only).


API Tags:
Return:  ATK node type


[ Top ]
Home | About | Contact