API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsModule Class Reference
Inheritance diagram for XoopsModule:
Collaboration diagram for XoopsModule:

Public Member Functions

 __construct ()
 
 loadInfoAsVar ($dirname, $verbose=true)
 
 setMessage ($str)
 
 getMessages ()
 
 setInfo ($name, $value)
 
getInfo ($name=null)
 
 getStatus ()
 
 versionCompare ($version1='', $version2='', $operator='<')
 
 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)
 
- Public Member Functions inherited from XoopsObject
 __construct ()
 
 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=null)
 
 cleanVars ()
 
 registerFilter ($filtername)
 
 _loadFilters ()
 
 loadFilters ($method)
 
 xoopsClone ()
 
 __clone ()
 
 setErrors ($err_str)
 
 getErrors ()
 
 getHtmlErrors ()
 
 toArray ()
 

Static Public Member Functions

static getByDirname ($dirname)
 

Data Fields

 $modinfo
 
 $adminmenu
 
 $_msg
 
- Data Fields inherited from XoopsObject
 $vars = array()
 
 $cleanVars = array()
 
 $_isNew = false
 
 $_isDirty = false
 
 $_errors = array()
 
 $_filters = array()
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Constructor

Reimplemented from XoopsObject.

Here is the call graph for this function:

Member Function Documentation

◆ checkAccess()

checkAccess ( )

◆ dirname()

dirname (   $format = '')

Returns Class Base Variable dirname

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ executeScript()

executeScript (   $type,
  $state = 2 
)
Parameters
$type
int$state
Returns
bool

◆ executeSQL()

executeSQL ( )
Returns
bool

◆ getAdminMenu()

& getAdminMenu ( )

Get the admin menu for the module

Returns
string
Here is the call graph for this function:

◆ getByDirname()

static getByDirname (   $dirname)
static
Parameters
$dirname
Returns
mixed
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getCurrentPage()

getCurrentPage ( )
Returns
bool

◆ getInfo()

& 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.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getMessages()

getMessages ( )

return the messages for this object as an array

Returns
array an array of messages @access public

◆ getStatus()

getStatus ( )

Get statut

Returns
string
Here is the call graph for this function:

◆ gettemplate()

gettemplate (   $template,
  $block = false 
)
Parameters
$template
bool$block
Returns
bool

◆ hasadmin()

hasadmin (   $format = '')

Returns Class Base Variable hasadmin

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ hascomments()

hascomments (   $format = '')

Returns Class Base Variable hascomments

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ hasconfig()

hasconfig (   $format = '')

Returns Class Base Variable hasconfig

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ hasmain()

hasmain (   $format = '')

Returns Class Base Variable hasmain

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ hasnotification()

hasnotification (   $format = '')

Returns Class Base Variable hasnotification

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ hassearch()

hassearch (   $format = '')

Returns Class Base Variable hassearch

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ id()

id (   $format = 'N')

Returns Class Base Variable mid

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ insert()

insert ( )
Returns
bool

◆ insertBlocks()

insertBlocks ( )
Returns
bool

◆ insertConfig()

insertConfig ( )
Returns
bool

◆ insertConfigCategories()

insertConfigCategories ( )
Returns
bool

◆ insertGroupPermissions()

insertGroupPermissions (   $groups,
  $type 
)
Parameters
$groups
$type
Returns
bool

◆ insertProfileFields()

insertProfileFields ( )
Returns
bool

◆ insertTemplates()

insertTemplates ( )
Returns
bool

◆ install()

install (   $admingroups = array(),
  $accessgroups = array() 
)
Parameters
array$admingroups
array$accessgroups
Returns
bool

◆ isactive()

isactive (   $format = '')

Returns Class Base Variable isactive

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ last_update()

last_update (   $format = '')

Returns Class Base Variable last_update

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ loadAdminMenu()

loadAdminMenu ( )

Load the admin menu for the module

Here is the call graph for this function:
Here is the caller graph for this function:

◆ loadErrorMessages()

loadErrorMessages ( )
Returns
bool

◆ loadInfo()

loadInfo (   $dirname,
  $verbose = true 
)

Load the module info for this module

Parameters
string$dirnameModule directory
bool$verboseGive an error on fail?
Returns
bool true if loaded
Here is the caller graph for this function:

◆ loadInfoAsVar()

loadInfoAsVar (   $dirname,
  $verbose = true 
)

Load module info

Parameters
string$dirnameDirectory Name
boolean$verbose
Here is the call graph for this function:

◆ loadLanguage()

loadLanguage (   $type = 'main')
Parameters
string$type
Returns
bool

◆ mainLink()

mainLink ( )

Get a link to the modules main page

Returns
string FALSE on fail
Here is the call graph for this function:

◆ mid()

mid (   $format = '')

Returns Class Base Variable mid

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ name()

name (   $format = '')

Returns Class Base Variable name

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ search()

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.
Here is the call graph for this function:

◆ setInfo()

setInfo (   $name,
  $value 
)

Set module info

Parameters
string$name
mixed$value
Returns
bool

◆ setMessage()

setMessage (   $str)

add a message

Parameters
string$strmessage to add @access public

◆ subLink()

subLink ( )

Get links to the subpages

Returns
string
Here is the call graph for this function:

◆ update()

update ( )
Returns
bool

◆ version()

version (   $format = '')

Returns Class Base Variable version

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

◆ versionCompare()

versionCompare (   $version1 = '',
  $version2 = '',
  $operator = '<' 
)

Compares two "XOOPS-standardized" version number strings.

Parameters
string$version1
string$version2
string$operator
Returns
boolean The function will return true if the relationship is the one specified by the operator, false otherwise.

◆ weight()

weight (   $format = '')

Returns Class Base Variable weight

Parameters
string$format
Returns
mixed
Here is the call graph for this function:

Field Documentation

◆ $_msg

$_msg

◆ $adminmenu

$adminmenu

◆ $modinfo

$modinfo

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