Profile_Module Class Reference

Inheritance diagram for Profile_Module:

Public Member Functions
	startup ()
	[Abstract] This method is called by the controller strategy, if this module is the current module.
	setAdminMode ($flag)
	setActionName ($name)
	execute (&$controller)
	doPermissionError ()
	doActionNotFoundError ()
	doPreparationError ()
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.
	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.

Data Fields
	$mActionName = null
	$mAction = null
	$mAdminFlag = false
	$mAssetManager = null
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 30 of file Module.class.php.

Member Function Documentation

doActionNotFoundError()

doActionNotFoundError

(

)

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

doPermissionError()

doPermissionError

(

)

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

doPreparationError()

doPreparationError

(

)

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

execute()

execute

(

&

$controller

)

Parameters

$controller

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

setActionName()

setActionName

(

$name

)

Parameters

$name

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

setAdminMode()

setAdminMode

(

$flag

)

Parameters

$flag

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

startup()

startup

(

)

[Abstract] This method is called by the controller strategy, if this module is the current module.

Returns

void

Reimplemented from Legacy_AbstractModule.

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

Field Documentation

$mAction

$mAction = null

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

$mActionName

$mActionName = null

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

$mAdminFlag

$mAdminFlag = false

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

$mAssetManager

$mAssetManager = null

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

---

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

• html/modules/profile/class/Module.class.php