Legacy_AbstractModule Class Reference

Inherited by Legacy_ModuleAdapter.

Inheritance diagram for Legacy_AbstractModule:

[legend]
List of all members.

Public Member Functions

 setAttribute ($key, $value)
 hasAttribute ($key)
 getAttribute ($key)
 setXoopsModule (&$xoopsModule)
getXoopsModule ()
 setModuleConfig ($config)
 getModuleConfig ($key=null)
getCacheInfo ()
 _createCacheInfo ()
getRenderBuffer ()
 _createRenderBuffer ()
 getRenderSystemName ()
 isActive ()
 isEnableCache ()
createCacheInfo ()
 startup ()
 doActionSearch (&$searchArgs)
 doLegacyGlobalSearch ($queries, $andor, $max_hit, $start, $uid)
 hasAdminIndex ()
 getAdminIndex ()
 getAdminMenu ()

Detailed Description

This is an abstract class which has interfaces to connect with the controller about the module process. Legacy controller has a instance of the sub-class of this class. So module developers may define their sub-classes.

See also:
Legacy_Utils::createModule()

XoopsModule


Member Function Documentation

Legacy_AbstractModule::setAttribute ( key,
value 
)

Sets $value with $key to attributes. Use direct access to $mAttributes if references are must, because PHP4 can't handle reference in the signature of this member function.

Parameters:
string $key
mixed $value

Legacy_AbstractModule::hasAttribute ( key  ) 

Gets a value indicating whether the value specified by $key exists.

Parameters:
string $key
Returns:
mixed

Legacy_AbstractModule::getAttribute ( key  ) 

Gets a value of attributes with $key. If the value specified by $key doesn't exist in attributes, gets null.

Parameters:
string $key
Returns:
mixed

Legacy_AbstractModule::setXoopsModule ( &$  xoopsModule  ) 

Sets a instance of XoopsModule to the property.

Parameters:
XoopsModule $xoopsModule

& Legacy_AbstractModule::getXoopsModule (  ) 

Gets a instance of XoopsModule.

Returns:
XoopsModule

Legacy_AbstractModule::setModuleConfig ( config  ) 

Sets array of xoops module config to the property.

Parameters:
Array $config

Legacy_AbstractModule::getModuleConfig ( key = null  ) 

Gets a value form xoops module config with $key. If $key is specified null, returns array.

Parameters:
string $key
Returns:
mixed

& Legacy_AbstractModule::getCacheInfo (  ) 

Gets the cache information instance.

Returns:
Legacy_ModuleCaceInformation
See also:
Legacy_Module::_createChaceInfo()

Legacy_AbstractModule::_createCacheInfo (  ) 

Creates a cache information instance and returns it. This member function sets the created instance to mCacheInfo because this instance has to keep the instance for many callbacks. protected

Returns:
Legacy_ModuleCacheInformation
See also:
Legacy_Module::getCacheInfo()

& Legacy_AbstractModule::getRenderBuffer (  ) 

Gets the render target instance. public

Returns:
XCube_RenderTarget
See also:
Legacy_Module::_createRenderBuffer()

Legacy_AbstractModule::_createRenderBuffer (  ) 

Creates a render target instance and returns it. This member function sets the created instance to mRender because this instance has to keep the instance for many callbacks. protected

Returns:
XCube_RenderTarget
See also:
Legacy_Module::getRenderBuffer()

Legacy_AbstractModule::getRenderSystemName (  ) 

Gets a name of the dependency render system.

Returns:
string

Legacy_AbstractModule::isActive (  ) 

Gets a value indicating whether this modules is an active.

Returns:
bool

Legacy_AbstractModule::isEnableCache (  ) 

Gets a value indicating whether the current module has a option of configurations to use the cache system.

Returns:
bool

& Legacy_AbstractModule::createCacheInfo (  ) 

Initializes a cache information object, and returns it.

Returns:
Legacy_ModuleCacheInformation

Legacy_AbstractModule::startup (  ) 

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

Legacy_AbstractModule::doActionSearch ( &$  searchArgs  ) 

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

Parameters:
Legacy_ActionSearchArgs $searchArgs
See also:
Legacy_ActionSearchArgs

Reimplemented in Legacy_ModuleAdapter.

Legacy_AbstractModule::doLegacyGlobalSearch ( queries,
andor,
max_hit,
start,
uid 
)

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

Parameters:
Legacy_ActionSearchArgs $searchArgs
See also:
Legacy_ActionSearchArgs

Reimplemented in Legacy_ModuleAdapter.

Legacy_AbstractModule::hasAdminIndex (  ) 

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

Returns:
bool
Note:
Side menu blocks may not display the admin menu if this member function returns false.

Reimplemented in Legacy_ModuleAdapter.

Legacy_AbstractModule::getAdminIndex (  ) 

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

Returns:
string

Reimplemented in Legacy_ModuleAdapter.

Legacy_AbstractModule::getAdminMenu (  ) 

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

Returns:
array
See also:
/modules/legacy/admin/templates/blocks/legacy_admin_block_sidemenu.html

Reimplemented in Legacy_ModuleAdapter.


The documentation for this class was generated from the following file:
Generated on Thu Nov 2 00:27:10 2006 for XOOPS Cube Legacy by  doxygen 1.5.1