Inheritance diagram for ChWsbModule:

Public Member Functions
	__construct ($aModule)

	isLogged ()

	getUserId ()

	getUserPassword ()

	getTitleKey ($sUri)

	serviceGetBaseUrl ()

Static Public Member Functions
static	getInstance ($sClassName)

static	getTitle ($sUri)

Public Attributes
	$_aModule

	$_oDb

	$_oTemplate

	$_oConfig

Detailed Description

This work, "Cheetah - https://www.cheetahwsb.com", is a derivative of "Dolphin Pro V7.4.2" by BoonEx Pty Limited - https://www.boonex.com/, used under CC-BY. "Cheetah" is licensed under CC-BY by Dean J. Bassett Jr. CC-BY License - http://creativecommons.org/licenses/by/3.0/ 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: ChWsbConfig

b. An object of database class.

See also: ChWsbModuleDb

c. An object of template class.

See also: ChWsbTemplate

Example of usage:

See also: any module included in the default Cheetah's package.

Static Methods:

Get an instance of a module's class.

See also: ChWsbModule::getInstance($sClassName)

Memberships/ACL: Doesn't depend on user's membership.

Alerts: no alerts available

Definition at line 40 of file ChWsbModule.php.

Constructor & Destructor Documentation

◆ __construct()

ChWsbModule::__construct ( $aModule )

constructor

Reimplemented in ChWallModule, ChSitesModule, ChSctrModule, ChSimpleMessengerModule, ChProfileCustomizeModule, ChPmtModule, ChPageACModule, ChNewsModule, ChMbpModule, ChFilesModule, ChFdbModule, ChCRSSModule, ChChatModule, ChBoardModule, ChBlogsModule, ChArlModule, ChAdsModule, ChWsbTextModule, and ChWsbConnectModule.

Definition at line 53 of file ChWsbModule.php.

Member Function Documentation

◆ getInstance()

static ChWsbModule::getInstance ( $sClassName )

static

Static method to get an instance of a module's class.

NOTE. The prefered usage is to get an instance of [ClassPrefix]Module class. But if it's needed an instance of class which has constructor without parameters or with one parameter(an array with module's info) it can be retrieved.

Parameters

$sClassName module's class name.

Definition at line 89 of file ChWsbModule.php.

◆ getTitle()

static ChWsbModule::getTitle ( $sUri )

static

Definition at line 136 of file ChWsbModule.php.

◆ getTitleKey()

ChWsbModule::getTitleKey ( $sUri )

Definition at line 141 of file ChWsbModule.php.

◆ getUserId()

ChWsbModule::getUserId ( )

Get currently logged in user ID.

Returns: integer user ID.

Definition at line 122 of file ChWsbModule.php.

◆ getUserPassword()

ChWsbModule::getUserPassword ( )

Get currently logged in user password.

Returns: string user password.

Definition at line 131 of file ChWsbModule.php.

◆ isLogged()

ChWsbModule::isLogged ( )

Check whether user logged in or not.

Returns: boolean result of operation.

Definition at line 113 of file ChWsbModule.php.

◆ serviceGetBaseUrl()

ChWsbModule::serviceGetBaseUrl ( )

Definition at line 146 of file ChWsbModule.php.

Member Data Documentation

◆ $_aModule

ChWsbModule::$_aModule

Definition at line 42 of file ChWsbModule.php.

◆ $_oConfig

ChWsbModule::$_oConfig

Definition at line 48 of file ChWsbModule.php.

◆ $_oDb

ChWsbModule::$_oDb

Definition at line 44 of file ChWsbModule.php.

◆ $_oTemplate

ChWsbModule::$_oTemplate

Definition at line 46 of file ChWsbModule.php.

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

inc/classes/ChWsbModule.php

Public Member Functions

Static Public Member Functions

Public Attributes