Class XoopsModule

A Module

Xoops\Core\Kernel\XoopsObject implements ArrayAccess

Xoops\Core\Kernel\Handlers\XoopsModule

Direct known subclasses

Namespace: Xoops\Core\Kernel\Handlers
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\XoopsModule
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Author: Taiwen Jiang phppp@users.sourceforge.net
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/Handlers/XoopsModule.php

Methods summary
`public`	# `__construct( )` Constructor Constructor
`public`	# `loadInfoAsVar( string $dirname, boolean $verbose = true )` Load module info Load module info Parameters `$dirname` module directory `$verbose` true for more information
`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` name `$value` value Returns boolean
`public string[]\|string`	# `getInfo( string $name = null )` Get module info Get module info Parameters `$name` If $name is set, returns a single module information item as string. Returns string[]\|string Array of module information, or just the single name requested
`public string\|false`	# `mainLink( )` Get a link to the modules main page Get a link to the modules main page Returns string\|false 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
`public mixed`	# `id( string $format = 'n' )` getter for mid getter for mid Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `mid( string $format = '' )` another getter for mid another getter for mid Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `name( string $format = '' )` getter for module name getter for module name Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `version( string $format = '' )` getter for module version getter for module version Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `last_update( string $format = '' )` getter for module last update getter for module last update Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `weight( string $format = '' )` getter for weight getter for weight Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `isactive( string $format = '' )` getter for isactive getter for isactive Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `dirname( string $format = '' )` getter for dirname getter for dirname Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `hasmain( string $format = '' )` getter for hasmain getter for hasmain Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `hasadmin( string $format = '' )` getter for hasadmin getter for hasadmin Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `hassearch( string $format = '' )` getter for hassearch getter for hassearch Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `hasconfig( string $format = '' )` getter for hasconfig getter for hasconfig Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `hascomments( string $format = '' )` getter for hascomments getter for hascomments Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public mixed`	# `hasnotification( string $format = '' )` getter for hasnotifications getter for hasnotifications Parameters `$format` Dtype::FORMAT_xxxx constant Returns mixed
`public Xoops\Core\Kernel\Handlers\XoopsModule`	# `getByDirname( string $dirname )` get module by dirname get module by dirname Parameters `$dirname` directory name Returns `Xoops\Core\Kernel\Handlers\XoopsModule`

Methods inherited from Xoops\Core\Kernel\XoopsObject
`__clone(), assignVar(), assignVars(), cleanVars(), destroyVars(), getErrors(), getHtmlErrors(), getValues(), getVar(), getVars(), initVar(), isDirty(), isNew(), loadFilters(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), registerFilter(), setDirty(), setErrors(), setFormVars(), setNew(), setVar(), setVars(), toArray(), unsetDirty(), unsetNew(), xoopsClone()`

Properties summary
`public string`	`$modinfo`	#
`public array`	`$adminmenu`	#
`protected`	`$xoops_url`	#
`protected`	`$xoops_root_path`	#

Properties inherited from Xoops\Core\Kernel\XoopsObject
`$cleanVars, $plugin_path, $vars`

Namespaces

Classes

Class XoopsModule

Direct known subclasses

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