XoopsModule Class Reference

Inheritance diagram for XoopsModule:

Public Member Functions
	__construct ()
	loadInfoAsVar (string $dirname, bool $verbose=true)
&	getInfo ($name=null)
	mainLink ()
&	subLink ()
	loadAdminMenu ()
&	getAdminMenu ()
	loadInfo ($dirname, $verbose=true)
&	search ($term='', $andor='AND', $limit=0, $offset=0, $userid=0)
	getRenderedVersion ()
	hasHelp ()
	getHelp ()
	hasNeedUpdate ()
	mid ()
	dirname ()
	name ()
&	getByDirName ($dirname)
Public Member Functions inherited from XoopsObject
	setNew ()
	unsetNew ()
	isNew ()
	setDirty ()
	unsetDirty ()
	isDirty ()
	initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='')
	assignVar ($key, $value)
	assignVars ($var_arr)
	setVar ($key, $value, $not_gpc=false)
	setVars ($var_arr, $not_gpc=false)
	setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
&	getVars ()
&	getVar ($key, $format='s')
	getShow ($key)
	set ($key, $value)
	get ($key)
	getProperty ($key)
	getProperties ()
	cleanVars ()
	registerFilter ($filtername)
	_loadFilters ()
&	xoopsClone ()
	setErrors ($err_str)
	getErrors ()
	getHtmlErrors ()
Public Member Functions inherited from AbstractXoopsObject
	initVar ($key, $data_type, $default, $required, $size)

Data Fields
	$modinfo
	$adminmenu
Data Fields inherited from XoopsObject
	$vars = []
	$cleanVars = []
	$_isNew = false
	$_isDirty = false
	$_errors = []
	$_filters = []

Detailed Description

Definition at line 23 of file module.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

constructor

normally, this is called from child classes only @access public

Reimplemented from XoopsObject.

Definition at line 34 of file module.php.

Member Function Documentation

dirname()

dirname

(

)

Definition at line 304 of file module.php.

getAdminMenu()

& getAdminMenu

(

)

Get the admin menu for the module

Returns

string

Definition at line 171 of file module.php.

getByDirName()

& getByDirName

(

$dirname

)

Definition at line 312 of file module.php.

getHelp()

getHelp

(

)

Returns

string

Definition at line 278 of file module.php.

getInfo()

& getInfo

(

$name = null

)

Get module info

Parameters

string

$name

Returns

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

Definition at line 104 of file module.php.

getRenderedVersion()

getRenderedVersion

(

)

Returns

string

Definition at line 257 of file module.php.

hasHelp()

hasHelp

(

)

Returns

bool

Definition at line 265 of file module.php.

hasNeedUpdate()

hasNeedUpdate

(

)

Returns

bool

Definition at line 290 of file module.php.

loadAdminMenu()

loadAdminMenu

(

)

Load the admin menu for the module

Definition at line 152 of file module.php.

loadInfo()

loadInfo	(		$dirname,
			$verbose = true )

Load the module info for this module

Parameters

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

Definition at line 185 of file module.php.

loadInfoAsVar()

loadInfoAsVar	(	string	$dirname,
		bool	$verbose = true )

Load module info

Parameters

string	$dirname	Directory Name
bool	$verbose

Definition at line 67 of file module.php.

mainLink()

mainLink

(

)

Get a link to the modules main page

Returns

string FALSE on fail

Definition at line 124 of file module.php.

mid()

mid

(

)

#+ For backward compatibility only!

Deprecated

Definition at line 300 of file module.php.

name()

name

(

)

Definition at line 308 of file module.php.

search()

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

Search contents within a module

Parameters

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

Returns

mixed Search result.

Definition at line 232 of file module.php.

subLink()

& subLink

(

)

Get links to the subpages

Returns

array

Definition at line 138 of file module.php.

Field Documentation

$adminmenu

$adminmenu

Definition at line 32 of file module.php.

$modinfo

$modinfo

Definition at line 28 of file module.php.

---

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

• html/kernel/module.php