1.14.API
For development and upgrade of own modules, the knowledge of the API is most essential. The documentation about API at the moment is very rare and urgend needs content the prevent developers wasting too much time to inspect native code in all the class files. In a first step, the function names in the classes are listed here in alphabetic order, together with the used arguments and the statement number of the class file, shown in parantheses. That is far away being enough and needs explanations, especially which methods are intended for external calls und are not only functions used internally by the methods. Hope, Matt and others can add as much informations as possible.
Core:
0001 (199) _getPostKey()
0002 (89) &getModuleNames()
0003 (429) &loadAsMod($use_file=true)
0004 (227) atHome()
0005 (759) checkBranch()
0006 (530) checkOverPost()
0007 (547) checkSecurity()
0008 (49) closeModules()
0009 (404) configRequireOnce($module, $file=NULL, $exitOnError=TRUE)
0010 (560) coreModList()
0011 (486) errorPage($code=NULL)
0012 (337) getConfigFile($module, $file=NULL)
0013 (320) getCurrentModule()
0014 (731) getCurrentUrl($relative=TRUE, $use_redirect=TRUE)
0015 (647) getHomeDir()
0016 (657) getHomeHttp($with_http=TRUE, $with_directory=TRUE, $with_slash=TRUE)
0017 (255) getHttp()
0018 (67) getModules($active=TRUE, $just_title=FALSE)
0019 (706) getVersionInfo($get_file=TRUE)
0020 (239) goBack()
0021 (247) home()
0022 (166) initCoreClass($file)
0023 (21) initializeModules()
0024 (148) initModClass($module, $file)
0025 (580) installModList()
0026 (779) isBranch()
0027 (687) isClass(&$object, $class_name)
0028 (218) isPosted()
0029 (515) isWindows()
0030 (302) killAllSessions()
0031 (293) killSession($sess_name)
0032 (463) log($message, $filename, $type=NULL)
0033 (312) moduleExists($module)
0034 (617) plugObject(&$object, $variables)
0035 (371) requireConfig($module, $file=NULL, $exitOnError=TRUE)
0036 (380) requireInc($module, $file, $exitOnError=TRUE)
0037 (269) reroute($address=NULL)
0038 (131) runCurrentModule()
0039 (114) runtimeModules()
0040 (328) setCurrentModule($module)
0041 (184) setLastPost()
0042 (591) stripObjValues($object)
0043
... to be continued ...