struct
admin
component _site.objects._bundles.bundle-admin
        extends _site.objects._bundles._bundle
EXCEPTION
component core.admin._bundle.objects.exception
        extends core.admin._bundle.objects._exception
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
blog
component _site.objects._bundles.bundle-blog
        extends _site.objects._bundles._bundle
EXCEPTION
component apps.blog._bundle.objects.exception
        extends apps.blog._bundle.objects._exception
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
books
component _site.objects._bundles.bundle-books
        extends _site.objects._bundles._bundle
EXCEPTION
component apps.books._bundle.objects.exception
        extends apps.books._bundle.objects._exception
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
comment
component _site.objects._bundles.bundle-comment
        extends _site.objects._bundles._bundle
EXCEPTION
component apps.comment._bundle.objects.exception
        extends apps.comment._bundle.objects._exception
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
d2o
component _site.objects._bundles.bundle-d2o
        extends _site.objects._bundles._bundle
EXCEPTION
component apps.d2o._bundle.objects.exception
        extends apps.d2o._bundle.objects._exception
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
demo
component _site.objects._bundles.bundle-demo
        extends _site.objects._bundles._bundle
EXCEPTION
component apps.demo._bundle.objects.exception
        extends apps.demo._bundle.objects._exception
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
forum
component _site.objects._bundles.bundle-forum
        extends _site.objects._bundles._bundle
EXCEPTION
component apps.forum._bundle.objects.exception
        extends apps.forum._bundle.objects._exception
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE
function remove
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
subscription_id Optional Any  
auth_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SAVE_TOPIC
function save_topic
Arguments:
Name Required Type Default
topic_main Optional Any  
topic_body Optional Any  
topic_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SUBSCRIBE
function subscribe
Arguments:
Name Required Type Default
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ONMISSINGMETHOD
function onMissingMethod
Arguments:
Name Required Type Default
missingMethodName Optional Any  
missingMethodArguments Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETTHREADSBYUSER
function getThreadsByUser
Arguments:
Name Required Type Default
topic_id Optional Any  
user Optional Any  
maxResults Optional Any all
includePost Optional Any false
startDate Optional Any [empty string]
endDate Optional Any [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETTHREADSBYTAG
function getThreadsByTag
Arguments:
Name Required Type Default
topic_id Optional Any  
tag_id Optional Any  
maxResults Optional Any all
includePost Optional Any false
startDate Optional Any [empty string]
endDate Optional Any [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETFILTER
function getFilter
Arguments:
Name Required Type Default
filter Optional Any [runtime expression]
startDate Optional Any [empty string]
endDate Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GETTOPICTHREADS
function getTopicThreads
Arguments:
Name Required Type Default
topic_id Optional Any  
maxResults Optional Any all
includePost Optional Any false
startDate Optional Any [empty string]
endDate Optional Any [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
POST
function post
Arguments:
Name Required Type Default
thread_id Optional Any  
post_body Optional Any  
parentPost Optional Any 0
post_id Optional Any 0
postTime Optional Any [runtime expression]
postDate Optional Any [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_THREAD
function save_thread
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_main Optional Any  
thread_body Optional Any  
thread_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
NOTIFYSUBSCRIBERS
function notifySubscribers
Arguments:
Name Required Type Default
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
METHODS
DELETE_RECORD
function delete_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSDIRECTORY
function get_settingsDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REFRESH_ACTIVESCHEMA
function refresh_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DIRECTORY
function get_directory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_REQUIREDROLES
function get_requiredRoles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEDIRECTORY
function get_moduleDirectory
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEDIRECTORY
function get_includeDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_PATH
function get_path
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:
Name Required Type Default
site Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CONFIG
function get_config
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIVESCHEMA
function get_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORD
function get_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
fieldlist Optional string [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CLASSPATH
function get_classPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INTERNAL
function get_internal
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RECORD
function save_record
Arguments:
Name Required Type Default
tablename Required string  
data Required struct  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_SETTINGSPATH
function get_settingsPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
CACHE
function cache
Arguments:
Name Required Type Default
domain Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_RELATEDLIST
function save_relatedList
Arguments:
Name Required Type Default
tablename Required string  
keyfield Required string  
keyvalue Required string  
multifield Required string  
multilist Required string  
reverse Optional boolean false
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SET_NESTEDAPPS
function set_nestedApps
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SAVE_ACTIVESCHEMA
function save_ActiveSchema
Arguments:
Name Required Type Default
version Optional Any true
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEDIRECTORY
function get_cacheDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TABLES
function get_tables
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ROUTE2ATTRIBUTES
function route2attributes
Arguments:
Name Required Type Default
attributes Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
TEMPLATE_EXISTS
function template_exists
Arguments:
Name Required Type Default
template Optional Any default
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEPATH
function get_templatePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATAPATH
function get_dataPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE_FROMAPPLIST
function remove_fromAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MODULEPATH
function get_modulePath
Arguments:
Name Required Type Default
module Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TEMPLATEDIRECTORY
function get_templateDirectory
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CACHEPATH
function get_cachePath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DEVICES
function get_devices
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNPATH
function get_cdnPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_TITLE
function get_title
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATADIRECTORY
function get_dataDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIADIRECTORY
function get_mediaDirectory
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ISAUTHORIZED
function isAuthorized
Arguments:
Name Required Type Default
roles Optional Any [empty string]
permissions Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_CDNMEDIAPATH
function get_cdnMediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_NAME
function get_name
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_DATACLASSPATH
function get_dataClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
LOAD_ACTIVESCHEMA
function load_ActiveSchema
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_MEDIAPATH
function get_mediaPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_METHODOLOGY
function get_methodology
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_OBJECTCLASSPATH
function get_objectClassPath
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_APPLIST
function get_appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_RECORDS
function get_records
Arguments:
Name Required Type Default
tablename Required string  
data Optional struct  
orderBy Optional string [empty string]
maxrows Optional numeric  
fieldlist Optional string [empty string]
advsql Optional struct  
filters Optional array  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_ROUTE
function get_route
Arguments:
Name Required Type Default
nestRoute Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ADD_TOAPPLIST
function add_toAppList
Arguments:
Name Required Type Default
apps Required Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_INCLUDEPATH
function get_includePath
Arguments:
Name Required Type Default
template Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__TICKET
function action__ticket
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETHANDLERS
function setHandlers
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__EMAIL
function action__email
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
PARAMEXCEPTION
function paramException
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
HANDLE
function handle
Arguments:
Name Required Type Default
exception Required Any  
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOGIN
function action__login
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__LOG
function action__log
Arguments:
Name Required Type Default
exception Required Any  
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_ACTIONLIST
function get_actionList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
STARTREQUEST
function startRequest
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_HANDLERLIST
function get_handlerList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__RALOGIN
function action__raLogin
Arguments:
Name Required Type Default
target Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
ACTION__REDIRECT
function action__redirect
Arguments:
Name Required Type Default
local Optional Any [empty string]
remote Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
SETACTIONS
function setActions
Arguments:none
ReturnType: Any
Roles:  
Access: private
Output: false
DisplayName:  
Hint:  
Description:  
GET_EXCEPTIONS
function get_exceptions
Arguments:none
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
RAISE
function raise
Arguments:
Name Required Type Default
type Optional Any  
message Optional Any  
detail Optional Any  
errorCode Optional Any  
extendedInfo Optional Any  
tagContext Optional Any  
realm Optional Any  
action Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
WASHANDLED
function wasHandled
Arguments:
Name Required Type Default
id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GET_FORUMSUBSCRIPTIONURL
function get_forumSubscriptionUrl
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
REMOVE
function remove
Arguments:
Name Required Type Default
topic_id Optional Any  
thread_id Optional Any  
post_id Optional Any  
subscription_id Optional Any  
auth_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output:  
DisplayName:  
Hint:  
Description:  
SAVE_TOPIC
function save_topic
Arguments:
Name Required Type Default
topic_main Optional Any  
topic_body Optional Any  
topic_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
SUBSCRIBE
function subscribe
Arguments:
Name Required Type Default
post_id Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
ONMISSINGMETHOD
function onMissingMethod
Arguments:
Name Required Type Default
missingMethodName Optional Any  
missingMethodArguments Optional Any  
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETTHREADSBYUSER
function getThreadsByUser
Arguments:
Name Required Type Default
topic_id Optional Any  
user Optional Any  
maxResults Optional Any all
includePost Optional Any false
startDate Optional Any [empty string]
endDate Optional Any [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETTHREADSBYTAG
function getThreadsByTag
Arguments:
Name Required Type Default
topic_id Optional Any  
tag_id Optional Any  
maxResults Optional Any all
includePost Optional Any false
startDate Optional Any [empty string]
endDate Optional Any [runtime expression]
ReturnType: Any
Roles:  
Access: public
Output: false
DisplayName:  
Hint:  
Description:  
GETFILTER
function getFilter
Arguments:
Name Required Type Default
filter Optional Any [runtime expression]
startDate Optional Any [empty string]
endDate Optional Any [empty string]
ReturnType: Any
Roles:  
Access: private
Output:</