Public Member Functions | |
| __construct ($aModule) | |
| isEnabled () | |
| getName () | |
| isLogged () | |
| getUserId () | |
| getUserPassword () | |
| serviceIsSafeService ($s) | |
| serviceGetSafeServices () | |
| serviceIsPublicService ($s) | |
| serviceGetPublicServices () | |
Static Public Member Functions | |
| static | getInstance ($sName) |
| static | getTitle ($sUri) |
| static | getTitleKey ($sUri) |
Public Attributes | |
| $_aModule | |
| $_oDb | |
| $_oTemplate | |
| $_oConfig | |
Detailed Description
Base class for Module classes in modules engine.
The object of the class contains major objects of the whole module. They are: a. An object of config class
- See also
- BxDolModuleConfig
b. An object of database class.
- See also
- BxDolModuleQuery
c. An object of template class.
- See also
- BxDolTemplate
Example of usage: refer to any BoonEx module
Static Methods:
Get an instance of a module's class.
- See also
- BxDolModule\getInstance($sClassName)
Memberships/ACL: Doesn't depend on user's membership.
Alerts: no alerts available
Constructor & Destructor Documentation
◆ __construct()
| BxDolModule::__construct | ( | $aModule | ) |
constructor
Reimplemented in BxAccntModule, BxAclModule, BxBaseModPaymentModule, BxContactModule, BxDevModule, BxDonationsModule, BxInvModule, BxMarkerIoModule, BxNtfsModule, BxPaymentModule, BxProfilerModule, BxReputationModule, BxTimelineModule, and BxXeroModule.
Member Function Documentation
◆ getInstance()
|
static |
Static method to get an instance of a module's class.
- Parameters
-
$sName module name.
◆ getName()
| BxDolModule::getName | ( | ) |
get module name
◆ getUserId()
| BxDolModule::getUserId | ( | ) |
Get currently logged in user ID.
- Returns
- integer user ID.
Reimplemented in BxAclModule, BxBaseModGeneralModule, and BxContactModule.
◆ getUserPassword()
| BxDolModule::getUserPassword | ( | ) |
Get currently logged in user password.
- Returns
- string user password.
◆ isEnabled()
| BxDolModule::isEnabled | ( | ) |
is module enabled
◆ isLogged()
| BxDolModule::isLogged | ( | ) |
Check whether user logged in or not.
- Returns
- boolean result of operation.
◆ serviceGetSafeServices()
| BxDolModule::serviceGetSafeServices | ( | ) |
Reimplemented in BxAclModule, BxContactModule, BxForumModule, BxInvModule, BxMassMailerModule, BxNtfsModule, BxPollsModule, BxQuoteOfDayModule, BxReputationModule, BxStripeConnectModule, and BxTimelineModule.
The documentation for this class was generated from the following file:
- inc/classes/BxDolModule.php
