XoopsModule Class Reference

Inheritance diagram for XoopsModule:

Public Member Functions
	checkAccess ()
	dirname ($format= '')
	executeScript ($type, $state=2)
	executeSQL ()
&	getAdminMenu ()
&	getByDirName ($dirname)
	getCurrentPage ()
&	getInfo ($name=null)
	getMessages ()
	gettemplate ($template, $block=false)
	hasadmin ($format= '')
	hascomments ($format= '')
	hasconfig ($format= '')
	hasmain ($format= '')
	hasnotification ($format= '')
	hassearch ($format= '')
	id ($format= 'N')
	insert ()
	insertBlocks ()
	insertConfig ()
	insertConfigCategories ()
	insertGroupPermissions ($groups, $type)
	insertProfileFields ()
	insertTemplates ()
	install ($admingroups=array(), $accessgroups=array())
	isactive ($format= '')
	last_update ($format= '')
	loadAdminMenu ()
	loadErrorMessages ()
	loadInfo ($dirname, $verbose=true)
	loadInfoAsVar ($dirname, $verbose=true)
	loadLanguage ($type="main")
	mainLink ()
	mid ($format= '')
	name ($format= '')
	search ($term= '', $andor= 'AND', $limit=0, $offset=0, $userid=0)
	setInfo ($name, $value)
	setMessage ($str)
	subLink ()
	update ()
	version ($format= '')
	weight ($format= '')
	XoopsModule ()
Public Member Functions inherited from XoopsObject
	_loadFilters ()
	assignVar ($key, $value)
	assignVars ($var_arr)
	cleanVars ()
	destoryVars ($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= '', $enumerations= '')
	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 ()
	XoopsObject ()

Public Attributes
	$_msg
	$adminmenu
	$modinfo
Public Attributes inherited from XoopsObject
	$_errors = array()
	$_filters = array()
	$_isDirty = false
	$_isNew = false
	$cleanVars = array()
	$vars = array()

Detailed Description

Definition at line 26 of file module.php.

Member Function Documentation

XoopsModule::checkAccess

(

)

#@+

Deprecated:

Definition at line 397 of file module.php.

XoopsModule::dirname

(

$format = ''

)

Returns Class Base Variable dirname

Definition at line 332 of file module.php.

XoopsModule::executeScript	(		$type,
			$state = 2
	)

Definition at line 481 of file module.php.

XoopsModule::executeSQL

(

)

Definition at line 439 of file module.php.

& XoopsModule::getAdminMenu

(

)

Get the admin menu for the module

Returns

string

Definition at line 207 of file module.php.

References $adminmenu.

& XoopsModule::getByDirName

(

$dirname

)

Definition at line 385 of file module.php.

References $dirname, and xoops_gethandler().

Here is the call graph for this function:

XoopsModule::getCurrentPage

(

)

Definition at line 415 of file module.php.

& 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 143 of file module.php.

XoopsModule::getMessages

(

)

return the messages for this object as an array

Returns

array an array of messages public

Definition at line 114 of file module.php.

XoopsModule::gettemplate	(		$template,
			$block = false
	)

Definition at line 451 of file module.php.

XoopsModule::hasadmin

(

$format = ''

)

Returns Class Base Variable hasadmin

Definition at line 348 of file module.php.

XoopsModule::hascomments

(

$format = ''

)

Returns Class Base Variable hascomments

Definition at line 372 of file module.php.

XoopsModule::hasconfig

(

$format = ''

)

Returns Class Base Variable hasconfig

Definition at line 364 of file module.php.

XoopsModule::hasmain

(

$format = ''

)

Returns Class Base Variable hasmain

Definition at line 340 of file module.php.

XoopsModule::hasnotification

(

$format = ''

)

Returns Class Base Variable hasnotification

Definition at line 380 of file module.php.

XoopsModule::hassearch

(

$format = ''

)

Returns Class Base Variable hassearch

Definition at line 356 of file module.php.

XoopsModule::id

(

$format = 'N'

)

Returns Class Base Variable mid

Definition at line 276 of file module.php.

XoopsModule::insert

(

)

Definition at line 433 of file module.php.

XoopsModule::insertBlocks

(

)

Definition at line 457 of file module.php.

XoopsModule::insertConfig

(

)

Definition at line 469 of file module.php.

XoopsModule::insertConfigCategories

(

)

Definition at line 463 of file module.php.

XoopsModule::insertGroupPermissions	(		$groups,
			$type
	)

Definition at line 487 of file module.php.

XoopsModule::insertProfileFields

(

)

Definition at line 475 of file module.php.

XoopsModule::insertTemplates

(

)

Definition at line 445 of file module.php.

XoopsModule::install	(		$admingroups = array(),
			$accessgroups = array()
	)

Definition at line 421 of file module.php.

XoopsModule::isactive

(

$format = ''

)

Returns Class Base Variable isactive

Definition at line 324 of file module.php.

XoopsModule::last_update

(

$format = ''

)

Returns Class Base Variable last_update

Definition at line 308 of file module.php.

XoopsModule::loadAdminMenu

(

)

Load the admin menu for the module

Definition at line 193 of file module.php.

References $adminmenu.

XoopsModule::loadErrorMessages

(

)

Definition at line 409 of file module.php.

XoopsModule::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 221 of file module.php.

References $dirname, $file, $GLOBALS, $modversion, and $xoopsConfig.

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

Load module info

Parameters

string	$dirname	Directory Name
boolean	$verbose

Definition at line 72 of file module.php.

References $dirname.

XoopsModule::loadLanguage

(

$type = "main"

)

Definition at line 403 of file module.php.

XoopsModule::mainLink

(

)

Get a link to the modules main page

Returns

string FALSE on fail

Definition at line 163 of file module.php.

References $ret.

XoopsModule::mid

(

$format = ''

)

Returns Class Base Variable mid

Definition at line 284 of file module.php.

XoopsModule::name

(

$format = ''

)

Returns Class Base Variable name

Definition at line 292 of file module.php.

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

Search contents within a module

Parameters

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

Returns

mixed Search result.

Definition at line 252 of file module.php.

References $andor, $file, $GLOBALS, and $limit.

XoopsModule::setInfo	(		$name,
			$value
	)

Set module info

Parameters

string	$name
mix	$value

Returns

bool

Definition at line 126 of file module.php.

XoopsModule::setMessage

(

$str

)

add a message

Parameters

string

$str

message to add public

Definition at line 103 of file module.php.

XoopsModule::subLink

(

)

Get links to the subpages

Returns

string

Definition at line 177 of file module.php.

References $ret.

XoopsModule::update

(

)

Definition at line 427 of file module.php.

XoopsModule::version

(

$format = ''

)

Returns Class Base Variable version

Definition at line 300 of file module.php.

XoopsModule::weight

(

$format = ''

)

Returns Class Base Variable weight

Definition at line 316 of file module.php.

XoopsModule::XoopsModule

(

)

Constructor

Definition at line 47 of file module.php.

References XOBJ_DTYPE_INT, XOBJ_DTYPE_OTHER, and XOBJ_DTYPE_TXTBOX.

Member Data Documentation

XoopsModule::$_msg

Definition at line 42 of file module.php.

XoopsModule::$adminmenu

Definition at line 37 of file module.php.

XoopsModule::$modinfo

Definition at line 32 of file module.php.

---

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

• L:/0xoops/xoops-2.5.6/htdocs/kernel/module.php