Legacy_ModuleAdapter Class Reference

Used for adapting $xoopsModule to imitate XOOPS2 responses. More...

Inheritance diagram for Legacy_ModuleAdapter:

Public Member Functions
	__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.
	getAdminMenu ()
	Gets an array having menus for the side menu of the control panel.
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.

Data Fields
	$_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

Used for adapting $xoopsModule to imitate XOOPS2 responses.

Remarks

This class is the standard class implementing Legacy_AbstractModule, and is helpful to be used by Legacy_Controller. If a module doesn't define its sub-class of Legacy_AbstractModule, this class is used as generic Legacy_AbstractModule.

Definition at line 396 of file Legacy_Module.class.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$module,
			$loadConfig = true )

Definition at line 410 of file Legacy_Module.class.php.

Member Function Documentation

doActionSearch()

doActionSearch

(

&

$searchArgs

)

This method is called back by the action search feature in the control panel.

Parameters

Legacy_ActionSearchArgs

$searchArgs

Returns

void

See also

Legacy_ActionSearchArgs

Reimplemented from Legacy_AbstractModule.

Definition at line 423 of file Legacy_Module.class.php.

doLegacyGlobalSearch()

doLegacyGlobalSearch	(		$queries,
			$andor,
			$max_hit,
			$start,
			$uid )

This method is called back by the xoops global search feature.

Parameters

$queries
$andor
$max_hit
$start
$uid

Reimplemented from Legacy_AbstractModule.

Definition at line 600 of file Legacy_Module.class.php.

getAdminIndex()

getAdminIndex

(

)

Gets an absolute URL indicating the top page of this module for the control panel side.

Returns

string

Reimplemented from Legacy_AbstractModule.

Reimplemented in Message_Module.

Definition at line 655 of file Legacy_Module.class.php.

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_AbstractModule.

Reimplemented in Legacy_Module, LegacyRender_Module, Message_Module, and User_Module.

Definition at line 661 of file Legacy_Module.class.php.

hasAdminIndex()

hasAdminIndex

(

)

[Final] Gets a value indicating whether this module has the page controller in the control panel side.

Returns

bool

Reimplemented from Legacy_AbstractModule.

Reimplemented in Message_Module.

Definition at line 643 of file Legacy_Module.class.php.

Field Documentation

$_mAdminMenuLoadedFlag

$_mAdminMenuLoadedFlag = false

bool

Definition at line 402 of file Legacy_Module.class.php.

$mAdminMenu

$mAdminMenu = null

Complex Array - cached.

Definition at line 408 of file Legacy_Module.class.php.

---

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

• html/modules/legacy/kernel/Legacy_Module.class.php