Inheritance diagram for Legacy_AbstractModule:
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 () |
XoopsModule
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.
string | $key | |
mixed | $value |
Legacy_AbstractModule::hasAttribute | ( | $ | key | ) |
Gets a value indicating whether the value specified by $key exists.
string | $key |
Legacy_AbstractModule::getAttribute | ( | $ | key | ) |
Gets a value of attributes with $key. If the value specified by $key doesn't exist in attributes, gets null.
string | $key |
Legacy_AbstractModule::setXoopsModule | ( | &$ | xoopsModule | ) |
Sets a instance of XoopsModule to the property.
XoopsModule | $xoopsModule |
& Legacy_AbstractModule::getXoopsModule | ( | ) |
Gets a instance of XoopsModule.
Legacy_AbstractModule::setModuleConfig | ( | $ | config | ) |
Sets array of xoops module config to the property.
Array | $config |
Legacy_AbstractModule::getModuleConfig | ( | $ | key = null |
) |
Gets a value form xoops module config with $key. If $key is specified null, returns array.
string | $key |
& Legacy_AbstractModule::getCacheInfo | ( | ) |
Gets the cache information instance.
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
& Legacy_AbstractModule::getRenderBuffer | ( | ) |
Gets the render target instance. public
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
Legacy_AbstractModule::getRenderSystemName | ( | ) |
Gets a name of the dependency render system.
Legacy_AbstractModule::isActive | ( | ) |
Gets a value indicating whether this modules is an active.
Legacy_AbstractModule::isEnableCache | ( | ) |
Gets a value indicating whether the current module has a option of configurations to use the cache system.
& Legacy_AbstractModule::createCacheInfo | ( | ) |
Initializes a cache information object, and returns it.
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.
Legacy_ActionSearchArgs | $searchArgs |
Reimplemented in Legacy_ModuleAdapter.
Legacy_AbstractModule::doLegacyGlobalSearch | ( | $ | queries, | |
$ | andor, | |||
$ | max_hit, | |||
$ | start, | |||
$ | uid | |||
) |
This method is called back by the xoops global search feature.
Legacy_ActionSearchArgs | $searchArgs |
Reimplemented in Legacy_ModuleAdapter.
Legacy_AbstractModule::hasAdminIndex | ( | ) |
Gets a value indicating whether this module has the page controller in the control panel side.
Reimplemented in Legacy_ModuleAdapter.
Legacy_AbstractModule::getAdminIndex | ( | ) |
Gets an absolute URL indicating the top page of this module for the control panel side.
Reimplemented in Legacy_ModuleAdapter.
Legacy_AbstractModule::getAdminMenu | ( | ) |
Gets an array having menus for the side menu of the control panel.
Reimplemented in Legacy_ModuleAdapter.