Class XoopsModule

A Module

XoopsObject

XoopsModule

Package: kernel
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at ernel/module.php

Methods summary
`public`	# `__construct( )` Constructor Constructor Overrides `XoopsObject::__construct()`
`public`	# `loadInfoAsVar( string $dirname, boolean $verbose = true )` Load module info Load module info Parameters `$dirname` Directory Name `$verbose`
`public`	# `setMessage( string $str )` add a message add a message Parameters `$str` message to add
`public array`	# `getMessages( )` return the messages for this object as an array return the messages for this object as an array Returns array an array of messages
`public boolean`	# `setInfo( string $name, mixed $value )` Set module info Set module info Parameters `$name` `$value` Returns boolean
`public array &`	# `getInfo( string $name = null )` Get module info Get module info Parameters `$name` Returns array \|string Array of module information. If `XoopsModule::name()` is set, returns a single module information item as string.
`public string`	# `mainLink( )` Get a link to the modules main page Get a link to the modules main page Returns string FALSE on fail
`public string`	# `subLink( )` Get links to the subpages Get links to the subpages Returns string
`public`	# `loadAdminMenu( )` Load the admin menu for the module Load the admin menu for the module
`public string &`	# `getAdminMenu( )` Get the admin menu for the module Get the admin menu for the module Returns string
`public boolean`	# `loadInfo( string $dirname, boolean $verbose = true )` Load the module info for this module Load the module info for this module Parameters `$dirname` Module directory `$verbose` Give an error on fail? Returns boolean true if loaded
`public mixed`	# `search( string $term = '', string $andor = 'AND', integer $limit = 0, integer $offset = 0, integer $userid = 0 )` Search contents within a module Search contents within a module Parameters `$term` `$andor` 'AND' or 'OR' `$limit` `$offset` `$userid` Returns mixed Search result.
`public mixed`	# `id( string $format = 'N' )` Returns Class Base Variable mid Returns Class Base Variable mid Parameters `$format` Returns mixed
`public mixed`	# `mid( string $format = '' )` Returns Class Base Variable mid Returns Class Base Variable mid Parameters `$format` Returns mixed
`public mixed`	# `name( string $format = '' )` Returns Class Base Variable name Returns Class Base Variable name Parameters `$format` Returns mixed
`public mixed`	# `version( string $format = '' )` Returns Class Base Variable version Returns Class Base Variable version Parameters `$format` Returns mixed
`public mixed`	# `last_update( string $format = '' )` Returns Class Base Variable last_update Returns Class Base Variable last_update Parameters `$format` Returns mixed
`public mixed`	# `weight( string $format = '' )` Returns Class Base Variable weight Returns Class Base Variable weight Parameters `$format` Returns mixed
`public mixed`	# `isactive( string $format = '' )` Returns Class Base Variable isactive Returns Class Base Variable isactive Parameters `$format` Returns mixed
`public mixed`	# `dirname( string $format = '' )` Returns Class Base Variable dirname Returns Class Base Variable dirname Parameters `$format` Returns mixed
`public mixed`	# `hasmain( string $format = '' )` Returns Class Base Variable hasmain Returns Class Base Variable hasmain Parameters `$format` Returns mixed
`public mixed`	# `hasadmin( string $format = '' )` Returns Class Base Variable hasadmin Returns Class Base Variable hasadmin Parameters `$format` Returns mixed
`public mixed`	# `hassearch( string $format = '' )` Returns Class Base Variable hassearch Returns Class Base Variable hassearch Parameters `$format` Returns mixed
`public mixed`	# `hasconfig( string $format = '' )` Returns Class Base Variable hasconfig Returns Class Base Variable hasconfig Parameters `$format` Returns mixed
`public mixed`	# `hascomments( string $format = '' )` Returns Class Base Variable hascomments Returns Class Base Variable hascomments Parameters `$format` Returns mixed
`public mixed`	# `hasnotification( string $format = '' )` Returns Class Base Variable hasnotification Returns Class Base Variable hasnotification Parameters `$format` Returns mixed
`public static mixed`	# `getByDirname( $dirname )` Parameters `$dirname` Returns mixed
`public`	# `checkAccess( )` Deprecated
`public boolean`	# `loadLanguage( string $type = 'main' )` Deprecated Parameters `$type` Returns boolean
`public boolean`	# `loadErrorMessages( )` Deprecated Returns boolean
`public boolean`	# `getCurrentPage( )` Deprecated Returns boolean
`public boolean`	# `install( array $admingroups = array(), array $accessgroups = array() )` Deprecated Parameters `$admingroups` `$accessgroups` Returns boolean
`public boolean`	# `update( )` Deprecated Returns boolean
`public boolean`	# `insert( )` Deprecated Returns boolean
`public boolean`	# `executeSQL( )` Deprecated Returns boolean
`public boolean`	# `insertTemplates( )` Deprecated Returns boolean
`public boolean`	# `gettemplate( $template, boolean $block = false )` Deprecated Parameters `$template` `$block` Returns boolean
`public boolean`	# `insertBlocks( )` Deprecated Returns boolean
`public boolean`	# `insertConfigCategories( )` Deprecated Returns boolean
`public boolean`	# `insertConfig( )` Deprecated Returns boolean
`public boolean`	# `insertProfileFields( )` Deprecated Returns boolean
`public boolean`	# `executeScript( $type, integer $state = 2 )` Deprecated Parameters `$type` `$state` Returns boolean
`public boolean`	# `insertGroupPermissions( $groups, $type )` Deprecated Parameters `$groups` `$type` Returns boolean

Methods inherited from XoopsObject
`XoopsObject(), __clone(), _loadFilters(), assignVar(), assignVars(), cleanVars(), destoryVars(), destroyVars(), getErrors(), getHtmlErrors(), getValues(), getVar(), getVars(), initVar(), isDirty(), isNew(), loadFilters(), registerFilter(), setDirty(), setErrors(), setFormVars(), setNew(), setVar(), setVars(), toArray(), unsetDirty(), unsetNew(), xoopsClone()`

Properties summary
`public string`	`$modinfo`	#
`public string`	`$adminmenu`	#
`public array`	`$_msg`	#

Properties inherited from XoopsObject
`$_errors, $_filters, $_isDirty, $_isNew, $cleanVars, $vars`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsModule

Overrides

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Deprecated

Parameters

Returns

Deprecated

Returns

Deprecated

Returns

Deprecated

Parameters

Returns

Deprecated

Returns

Deprecated

Returns

Deprecated

Returns

Deprecated

Returns

Deprecated

Parameters

Returns

Deprecated

Returns

Deprecated

Returns

Deprecated

Returns

Deprecated