functions.ini.php File Reference

Namespaces
namespace	Frameworks

Functions
	load_objectHandler ($handler='', $dirname='art')
	load_object ()
	load_functions ($group='', $dirname='art')
	mod_loadFunctions ($group='', $dirname='')
	mod_loadRenderer ($class, $dirname='')
	mod_message ($message)
	mod_getDirname ($current_path=null)
	mod_isModuleAction ($dirname='system')

Variables
const	FRAMEWORKS_ROOT_PATH XOOPS_ROOT_PATH . '/Frameworks'
if(!function_exists('mod_constant')) if(!function_exists( 'mod_DB_prefix')) if(!function_exists('xoops_message'))($message, $userlevel=0)	endif

Function Documentation

load_functions()

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

load_object()

load_object

(

)

Returns

bool

Here is the call graph for this function:

load_objectHandler()

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

Load declaration of an object handler

Parameters

string	$handler	handler name, optional
string	$dirname

Returns

bool

Here is the caller graph for this function:

mod_getDirname()

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

mod_isModuleAction()

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

mod_loadFunctions()

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+

Parameters

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

Returns

bool

mod_loadRenderer()

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

Parameters

$name

Returns

mixed

Parameters

	$name
bool	$isRel

Returns

string

mod_message()

mod_message

(

$message

)

Parameters

$message

Returns

bool

Variable Documentation

endif

endif

Get localized string if it is defined

Parameters

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

FRAMEWORKS_ROOT_PATH

const FRAMEWORKS_ROOT_PATH XOOPS_ROOT_PATH . '/Frameworks'