Inheritance diagram for XoopsModule:

Public Member Functions
	__construct ()

	dirname ($format= '')

	getAdminMenu ()

	getByDirName ($dirname)

	getInfo ($name=null)

	getMessages ()

	hasadmin ($format= '')

	hascomments ($format= '')

	hasconfig ($format= '')

	hasmain ($format= '')

	hasnotification ($format= '')

	hassearch ($format= '')

	id ($format= 'n')

	isactive ($format= '')

	last_update ($format= '')

	loadAdminMenu ()

	loadInfo ($dirname, $verbose=true)

	loadInfoAsVar ($dirname, $verbose=true)

	mainLink ()

	mid ($format= '')

	name ($format= '')

	search ($term= '', $andor= 'AND', $limit=0, $offset=0, $userid=0)

	setInfo ($name, $value)

	setMessage ($str)

	subLink ()

	version ($format= '')

	weight ($format= '')

Public Member Functions inherited from Xoops\Core\Kernel\XoopsObject
	assignVar ($key, $value)

	assignVars ($var_arr)

	cleanVars ($quote=true)

	destroyVars ($var)

	getErrors ()

	getHtmlErrors ()

	getValues ($keys=null, $format= 's', $maxDepth=1)

	getVar ($key, $format= 's')

	getVars ()

	initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options= '')

	isDirty ()

	isNew ()

	loadFilters ($method)

	registerFilter ($filtername)

	setDirty ()

	setErrors ($err_str)

	setFormVars ($var_arr=null, $pref= 'xo_', $not_gpc=false)

	setNew ()

	setVar ($key, $value, $not_gpc=false)

	setVars ($var_arr, $not_gpc=false)

	toArray ()

	unsetDirty ()

	unsetNew ()

	xoopsClone ()

Public Attributes
	$adminmenu

	$modinfo

Public Attributes inherited from Xoops\Core\Kernel\XoopsObject
	$cleanVars = array()

	$plugin_path

	$vars = array()

Protected Attributes
	$xoops_root_path

	$xoops_url

Private Attributes
	$_msg = array()

Detailed Description

Definition at line 31 of file module.php.

Constructor & Destructor Documentation

XoopsModule::__construct ( )

Constructor

Definition at line 55 of file module.php.

References XoopsBaseConfig\get(), Xoops\Core\Kernel\XoopsObject\initVar(), Xoops\Core\Kernel\XOBJ_DTYPE_INT, Xoops\Core\Kernel\XOBJ_DTYPE_OTHER, and Xoops\Core\Kernel\XOBJ_DTYPE_TXTBOX.

Here is the call graph for this function:

Member Function Documentation

XoopsModule::dirname ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 349 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::getAdminMenu ( )

Get the admin menu for the module

Returns: string

Definition at line 218 of file module.php.

References $adminmenu, and loadAdminMenu().

Here is the call graph for this function:

XoopsModule::getByDirName ( $dirname )

Parameters

$dirname

Returns: XoopsModule

Definition at line 412 of file module.php.

References $dirname, and Xoops\getInstance().

Here is the call graph for this function:

XoopsModule::getInfo ( $name = null )

Get module info

Parameters

string $name

Returns: array |string Array of module information. If $name is set, returns a single module information item as string.

Definition at line 153 of file module.php.

References $modinfo, $name, Xoops\Core\Kernel\XoopsObject\getVar(), and loadInfo().

Referenced by SystemPreferencesForm\getForm(), SystemModule\installBlocks(), SystemModule\installconfigs(), SystemModule\installTemplates(), loadAdminMenu(), and subLink().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsModule::getMessages ( )

return the messages for this object as an array

Returns: array an array of messages public

Definition at line 124 of file module.php.

References $_msg.

XoopsModule::hasadmin ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 367 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::hascomments ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 394 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::hasconfig ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 385 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::hasmain ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 358 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::hasnotification ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 403 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::hassearch ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 376 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::id ( $format = 'n' )

Parameters

string $format

Returns: mixed

Definition at line 286 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::isactive ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 340 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::last_update ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 322 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::loadAdminMenu ( )

Load the admin menu for the module

Definition at line 203 of file module.php.

References $adminmenu, $file, XoopsLoad\fileExists(), and getInfo().

Referenced by getAdminMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsModule::loadInfo	(	$dirname,
		$verbose = `true`
	)

Load the module info for this module

Parameters

string	$dirname	Module directory
bool	$verbose	Give an error on fail?

Returns: bool

Todo:: the $modVersions array should be built once when modules are installed/updated and then cached

Definition at line 236 of file module.php.

References $dirname, $file, $modversion, $xoops, and XoopsLoad\fileExists().

Referenced by getInfo(), and loadInfoAsVar().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsModule::loadInfoAsVar	(	$dirname,
		$verbose = `true`
	)

Load module info

Parameters

string	$dirname	Directory Name
boolean	$verbose

Definition at line 82 of file module.php.

References $dirname, loadInfo(), and Xoops\Core\Kernel\XoopsObject\setVar().

Here is the call graph for this function:

XoopsModule::mainLink ( )

Get a link to the modules main page

Returns: string FALSE on fail

Definition at line 173 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::mid ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 295 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::name ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 304 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::search	(	$term = `''`,
		$andor = `'AND'`,
		$limit = `0`,
		$offset = `0`,
		$userid = `0`
	)

Search contents within a module

Deprecated:: Use search module instead

Parameters

string	$term
string	$andor	'AND' or 'OR'
integer	$limit
integer	$offset
integer	$userid

Returns: boolean Search result.

Definition at line 277 of file module.php.

XoopsModule::setInfo	(	$name,
		$value
	)

Set module info

Parameters

string	$name
mixed	$value

Returns: bool

Definition at line 136 of file module.php.

References $name.

XoopsModule::setMessage ( $str )

add a message

Parameters

string $str message to add public

Definition at line 113 of file module.php.

XoopsModule::subLink ( )

Get links to the subpages

Returns: string

Definition at line 187 of file module.php.

References getInfo().

Here is the call graph for this function:

XoopsModule::version ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 313 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsModule::weight ( $format = '' )

Parameters

string $format

Returns: mixed

Definition at line 331 of file module.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

Member Data Documentation

XoopsModule::$_msg = array()

private

Definition at line 47 of file module.php.

Referenced by getMessages().

XoopsModule::$adminmenu

Definition at line 42 of file module.php.

Referenced by getAdminMenu(), and loadAdminMenu().

XoopsModule::$modinfo

Definition at line 36 of file module.php.

Referenced by getInfo().

XoopsModule::$xoops_root_path

protected

Definition at line 50 of file module.php.

XoopsModule::$xoops_url

protected

Definition at line 49 of file module.php.

The documentation for this class was generated from the following file:

C:/usr64/htdocs/kernel/module.php

Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation