Référence de la classe XoopsModule

Graphe d'héritage de XoopsModule:

Graphe de collaboration de XoopsModule:

Fonctions membres publiques
	__construct ()
	loadInfoAsVar ($dirname, $verbose=true)
	setMessage ($str)
	getMessages ()
	setInfo ($name, $value)
&	getInfo ($name=null)
	mainLink ()
	subLink ()
	loadAdminMenu ()
&	getAdminMenu ()
	loadInfo ($dirname, $verbose=true)
	search ($term='', $andor='AND', $limit=0, $offset=0, $userid=0)
	id ($format='N')
	mid ($format='')
	name ($format='')
	version ($format='')
	last_update ($format='')
	weight ($format='')
	isactive ($format='')
	dirname ($format='')
	hasmain ($format='')
	hasadmin ($format='')
	hassearch ($format='')
	hasconfig ($format='')
	hascomments ($format='')
	hasnotification ($format='')
	checkAccess ()
	loadLanguage ($type='main')
	loadErrorMessages ()
	getCurrentPage ()
	install ($admingroups=array(), $accessgroups=array())
	update ()
	insert ()
	executeSQL ()
	insertTemplates ()
	gettemplate ($template, $block=false)
	insertBlocks ()
	insertConfigCategories ()
	insertConfig ()
	insertProfileFields ()
	executeScript ($type, $state=2)
	insertGroupPermissions ($groups, $type)
Fonctions membres publiques hérités de XoopsObject
	XoopsObject ()
	setNew ()
	unsetNew ()
	isNew ()
	setDirty ()
	unsetDirty ()
	isDirty ()
	initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='', $enumerations='')
	assignVar ($key, $value)
	assignVars ($var_arr)
	setVar ($key, $value, $not_gpc=false)
	setVars ($var_arr, $not_gpc=false)
	destroyVars ($var)
	destoryVars ($var)
	setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
&	getVars ()
	getValues ($keys=null, $format='s', $maxDepth=1)
	getVar ($key, $format='s')
	cleanVars ()
	registerFilter ($filtername)
	_loadFilters ()
	loadFilters ($method)
	xoopsClone ()
	__clone ()
	setErrors ($err_str)
	getErrors ()
	getHtmlErrors ()
	toArray ()

Fonctions membres publiques statiques
static	getByDirname ($dirname)

Champs de données
	$modinfo
	$adminmenu
	$_msg
Champs de données hérités de XoopsObject
	$vars = array()
	$cleanVars = array()
	$_isNew = false
	$_isDirty = false
	$_errors = array()
	$_filters = array()

Documentation des constructeurs et destructeur

__construct()

__construct

(

)

Constructor

Réimplémentée à partir de XoopsObject.

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

checkAccess()

checkAccess

(

)

#+

Obsolète:

dirname()

dirname

(

$format = ''

)

Returns Class Base Variable dirname

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

executeScript()

executeScript	(		$type,
			$state = 2
	)

Paramètres

	$type
int	$state

Renvoie

bool

executeSQL()

executeSQL

(

)

Renvoie

bool

getAdminMenu()

& getAdminMenu

(

)

Get the admin menu for the module

Renvoie

string

Voici le graphe d'appel pour cette fonction :

getByDirname()

static getByDirname (   $dirname )

static

Paramètres

$dirname

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getCurrentPage()

getCurrentPage

(

)

Renvoie

bool

getInfo()

& getInfo

(

$name = null

)

Get module info

Paramètres

string

$name

Renvoie

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

getMessages()

getMessages

(

)

return the messages for this object as an array

Renvoie

array an array of messages @access public

gettemplate()

gettemplate	(		$template,
			$block = false
	)

Paramètres

	$template
bool	$block

Renvoie

bool

hasadmin()

hasadmin

(

$format = ''

)

Returns Class Base Variable hasadmin

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

hascomments()

hascomments

(

$format = ''

)

Returns Class Base Variable hascomments

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

hasconfig()

hasconfig

(

$format = ''

)

Returns Class Base Variable hasconfig

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

hasmain()

hasmain

(

$format = ''

)

Returns Class Base Variable hasmain

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

hasnotification()

hasnotification

(

$format = ''

)

Returns Class Base Variable hasnotification

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

hassearch()

hassearch

(

$format = ''

)

Returns Class Base Variable hassearch

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

id()

id

(

$format = 'N'

)

Returns Class Base Variable mid

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

insert()

insert

(

)

Renvoie

bool

insertBlocks()

insertBlocks

(

)

Renvoie

bool

insertConfig()

insertConfig

(

)

Renvoie

bool

insertConfigCategories()

insertConfigCategories

(

)

Renvoie

bool

insertGroupPermissions()

insertGroupPermissions	(		$groups,
			$type
	)

Paramètres

$groups
$type

Renvoie

bool

insertProfileFields()

insertProfileFields

(

)

Renvoie

bool

insertTemplates()

insertTemplates

(

)

Renvoie

bool

install()

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

Paramètres

array	$admingroups
array	$accessgroups

Renvoie

bool

isactive()

isactive

(

$format = ''

)

Returns Class Base Variable isactive

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

last_update()

last_update

(

$format = ''

)

Returns Class Base Variable last_update

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

loadAdminMenu()

loadAdminMenu

(

)

Load the admin menu for the module

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

loadErrorMessages()

loadErrorMessages

(

)

Renvoie

bool

loadInfo()

loadInfo	(		$dirname,
			$verbose = true
	)

Load the module info for this module

Paramètres

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

Renvoie

bool true if loaded

Voici le graphe des appelants de cette fonction :

loadInfoAsVar()

loadInfoAsVar	(		$dirname,
			$verbose = true
	)

Load module info

Paramètres

string	$dirname	Directory Name
boolean	$verbose

Voici le graphe d'appel pour cette fonction :

loadLanguage()

loadLanguage

(

$type = 'main'

)

Paramètres

string

$type

Renvoie

bool

mainLink()

mainLink

(

)

Get a link to the modules main page

Renvoie

string FALSE on fail

Voici le graphe d'appel pour cette fonction :

mid()

mid

(

$format = ''

)

Returns Class Base Variable mid

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

name()

name

(

$format = ''

)

Returns Class Base Variable name

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

search()

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

Search contents within a module

Paramètres

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

Renvoie

mixed Search result.

Voici le graphe d'appel pour cette fonction :

setInfo()

setInfo	(		$name,
			$value
	)

Set module info

Paramètres

string	$name
mixed	$value

Renvoie

bool

setMessage()

setMessage

(

$str

)

add a message

Paramètres

string

$str

message to add @access public

subLink()

subLink

(

)

Get links to the subpages

Renvoie

string

Voici le graphe d'appel pour cette fonction :

update()

update

(

)

Renvoie

bool

version()

version

(

$format = ''

)

Returns Class Base Variable version

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

weight()

weight

(

$format = ''

)

Returns Class Base Variable weight

Paramètres

string

$format

Renvoie

mixed

Voici le graphe d'appel pour cette fonction :

Documentation des champs

$_msg

$_msg

$adminmenu

$adminmenu

$modinfo

$modinfo

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/kernel/module.php