functions.ini.php File Reference

Go to the source code of this file.

Namespaces
	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 \XoopsBaseConfig::get('root-path') . "/Frameworks"

Function Documentation

load_functions	(		$group = "",
			$dirname = "art"
	)

Load a collective functions of Frameworks

Parameters

string	$group	name of the collective functions, empty for functions.php
string	$dirname

Returns

bool|mixed

Definition at line 59 of file functions.ini.php.

References $dirname, and FRAMEWORKS_ROOT_PATH.

load_object

(

)

Returns

bool

Definition at line 47 of file functions.ini.php.

References load_objectHandler().

Here is the call graph for this function:

load_objectHandler	(		$handler = "",
			$dirname = "art"
	)

Load declaration of an object handler

Parameters

string	$handler
string	$dirname

Returns

bool

Definition at line 30 of file functions.ini.php.

References FRAMEWORKS_ROOT_PATH.

Referenced by load_object().

Here is the caller graph for this function:

mod_getDirname

(

$current_path = null

)

Get dirname of a module according to current path

Parameters

string

$current_path

path to where the function is called

Returns

string $dirname

Definition at line 218 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

Parameters

string

$dirname

dirname of current module

Returns

bool

Definition at line 237 of file functions.ini.php.

References $dirname, $xoops, and Xoops\getInstance().

Here is the call graph for this function:

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 Xoops::loadService() in XOOPS 2.3+

Parameters

string	$group	name of the collective functions, empty for functions.php
string	$dirname	module dirname, optional

Returns

bool

Definition at line 82 of file functions.ini.php.

References $dirname, $xoops, XoopsBaseConfig\get(), and Xoops\getInstance().

Here is the call graph for this function:

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

Parameters

string	$class	name of the classname
string	$dirname	module dirname, optional

Returns

bool

Get localized string if it is defined

Parameters

string

$name

string to be localized

Returns

mixed

Get completed DB prefix if it is defined

Parameters

string	$name	string to be completed
boolean	$isRel	relative - do not add XOOPS->DB prefix

Returns

string

Definition at line 105 of file functions.ini.php.

References $dirname, $xoops, and Xoops\getInstance().

Here is the call graph for this function:

mod_message

(

$message

)

Parameters

$message

Returns

bool

Definition at line 197 of file functions.ini.php.

References $xoops, and Xoops\getInstance().

Here is the call graph for this function:

Variable Documentation

endif

Definition at line 159 of file functions.ini.php.

const FRAMEWORKS_ROOT_PATH \XoopsBaseConfig::get('root-path') . "/Frameworks"

Definition at line 21 of file functions.ini.php.

Referenced by load_functions(), load_objectHandler(), and XoopsArt\loadFunctions().