XOOPS 2.5.6
Final
|
Go to the source code of this file.
Namespaces | |
namespace | Frameworks |
Functions | |
load_functions ($group="", $dirname="art") | |
load_object () | |
load_objectHandler ($handler="", $dirname="art") | |
mod_getDirname ($current_path=null) | |
mod_isModuleAction ($dirname="system") | |
mod_loadFunctions ($group="", $dirname="") | |
mod_loadRenderer ($class, $dirname="") | |
mod_message ($message) | |
Variables | |
if(!function_exists("mod_constant")) if(!function_exists("mod_DB_prefix")) if(!function_exists("xoops_message"))($message, $userlevel=0) | endif |
const | FRAMEWORKS_ROOT_PATH XOOPS_ROOT_PATH . "/Frameworks" |
load_functions | ( | $group = "" , |
|
$dirname = "art" |
|||
) |
Load a collective functions of Frameworks
string | $group | name of the collective functions, empty for functions.php |
Definition at line 56 of file functions.ini.php.
References $dirname, and FRAMEWORKS_ROOT_PATH.
load_object | ( | ) |
Definition at line 45 of file functions.ini.php.
References load_objectHandler().
load_objectHandler | ( | $handler = "" , |
|
$dirname = "art" |
|||
) |
Load declaration of an object handler
string | $handler | handler name, optional |
Definition at line 30 of file functions.ini.php.
References $handler, and FRAMEWORKS_ROOT_PATH.
Referenced by load_object().
mod_getDirname | ( | $current_path = null | ) |
Get dirname of a module according to current path
string | $current_path | path to where the function is called |
Definition at line 189 of file functions.ini.php.
References $current_path, and DIRECTORY_SEPARATOR.
mod_isModuleAction | ( | $dirname = "system" | ) |
Is a module being installed, updated or uninstalled Used for setting module configuration default values or options
The function should be in functions.admin.php, however it requires extra inclusion in xoops_version.php if so
string | $dirname | dirname of current module |
Definition at line 205 of file functions.ini.php.
mod_loadFunctions | ( | $group = "" , |
|
$dirname = "" |
|||
) |
Load a collective functions of a module
The function file should be located in /modules/MODULE/functions.{$group}.php To avoid slowdown caused by include_once, a constant is suggested in the corresponding file: capitalized {$dirname}_{functions}[_{$group}]
The function is going to be formulated to use xos_kernel_Xoops2::loadService() in XOOPS 2.3+
string | $group | name of the collective functions, empty for functions.php |
string | $dirname | module dirname, optional |
Definition at line 77 of file functions.ini.php.
mod_loadRenderer | ( | $class, | |
$dirname = "" |
|||
) |
Load renderer for a class
The class file should be located in /modules/MODULE/{$class}.renderer.php The classf name should be defined as Capitalized(module_dirname)Capitalized(class_name)Renderer
string | $class | name of the classname |
string | $dirname | module dirname, optional |
Definition at line 96 of file functions.ini.php.
mod_message | ( | $message | ) |
Definition at line 168 of file functions.ini.php.
References $xoopsModuleConfig.
endif |
Get localized string if it is defined
string | $name | string to be localized Get completed DB prefix if it is defined |
string | $name | string to be completed |
boolean | $isRel | relative - do not add XOOPS->DB prefix Display contents of a variable, an array or an object or an array of objects |
mixed | $message | variable/array/object |
Definition at line 147 of file functions.ini.php.
const FRAMEWORKS_ROOT_PATH XOOPS_ROOT_PATH . "/Frameworks" |
Definition at line 21 of file functions.ini.php.
Referenced by load_functions(), load_objectHandler(), and XoopsArt\loadFunctions().