XCL Web Application Platform 2.5.0
The XoopsCube Legacy Project
Loading...
Searching...
No Matches
User_Module Class Reference
Inheritance diagram for User_Module:
Legacy_ModuleAdapter Legacy_AbstractModule

Public Member Functions

 User_Module (&$xoopsModule)
 
 __construct (&$xoopsModule)
 
 getAdminMenu ()
 Gets an array having menus for the side menu of the control panel.
 
- Public Member Functions inherited from Legacy_ModuleAdapter
 __construct ($module, $loadConfig=true)
 
 doActionSearch (&$searchArgs)
 This method is called back by the action search feature in the control panel.
 
 doLegacyGlobalSearch ($queries, $andor, $max_hit, $start, $uid)
 This method is called back by the xoops global search feature.
 
 hasAdminIndex ()
 [Final] Gets a value indicating whether this module has the page controller in the control panel side.
 
 getAdminIndex ()
 Gets an absolute URL indicating the top page of this module for the control panel side.
 
- Public Member Functions inherited from Legacy_AbstractModule
 __construct (&$module, $loadConfig=true)
 constructor
 
 setAttribute ($key, $value)
 Sets $value with $key to attributes.
 
 hasAttribute ($key)
 Gets a value indicating whether the value specified by $key exists.
 
 getAttribute ($key)
 Gets a value of attributes with $key.
 
 setXoopsModule (&$xoopsModule)
 Binds an instance of XoopsModule to the property.
 
getXoopsModule ()
 Gets the binded XoopsModule instance.
 
 setModuleConfig ($config)
 Binds array of xoops module config to the property.
 
 getModuleConfig (string $key=null)
 Gets a value form xoops module config with $key.
 
getCacheInfo ()
 Gets the cache information instance.
 
 _createCacheInfo ()
 Creates a cache information instance and returns it.
 
getRenderTarget ()
 Gets the render target instance.
 
 _createRenderTarget ()
 Creates a render target instance and returns it.
 
 getRenderSystemName ()
 Gets a name of the dependency render system.
 
getRenderSystem ()
 Gets the dependency render system.
 
 isActive ()
 Gets a value indicating whether this modules is an active.
 
 isEnableCache ()
 Gets a value indicating whether the current module has a option of configurations to use the cache system.
 
createCacheInfo ()
 Initializes a cache information object, and returns it.
 
 startup ()
 [Abstract] This method is called by the controller strategy, if this module is the current module.
 

Protected Attributes

 $mGetAdminMenu
 

Additional Inherited Members

- Data Fields inherited from Legacy_ModuleAdapter
 $_mAdminMenuLoadedFlag = false
 bool
 
 $mAdminMenu = null
 Complex Array - cached.
 
- Data Fields inherited from Legacy_AbstractModule
 $mAttributes = []
 [READ ONLY] Map Array - std::map<string, mixed> - used freely for this module.
 
 $mXoopsModule = null
 [READ ONLY] XoopsModule
 
 $mModuleConfig = []
 [READ ONLY] Map Array - std::map<string, string>
 
 $mCacheInfo = null
 Legacy_AbstractCacheInformation - The cached instance.
 
 $mRender = null
 XCube_RenderTarget - The render target instance for this module.
 

Detailed Description

Definition at line 7 of file Module.class.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( & $xoopsModule)

Definition at line 17 of file Module.class.php.

Member Function Documentation

◆ getAdminMenu()

getAdminMenu ( )

Gets an array having menus for the side menu of the control panel.

Returns
void Array
See also
/modules/legacy/admin/templates/blocks/legacy_admin_block_sidemenu.html

Reimplemented from Legacy_ModuleAdapter.

Definition at line 24 of file Module.class.php.

◆ User_Module()

User_Module ( & $xoopsModule)

Definition at line 12 of file Module.class.php.

Field Documentation

◆ $mGetAdminMenu

$mGetAdminMenu
protected

Definition at line 10 of file Module.class.php.


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