Inheritance diagram for ChSimpleMessengerModule:

Public Member Functions
	__construct ($aModule)

	actionGetOperation ($sActionName, $iRecipientId=0)

	getPrivacyPage ()

	getChatBox ($iSender)

	getMessagesHistory ($iRecipient, $iSender, $iLastMessageId=0, $bLimit=true)

	getSimpleMessengerCore ()

	serviceGetMessengerField ($iViewedMemberId)

	serviceGetMessengerCore ()

	serviceGetSettings ()

	isMessengerAlowed ($iMemberId, $isPerformAction=false)

	_defineActions ()

Public Member Functions inherited from ChWsbModule
	isLogged ()

	getUserId ()

	getUserPassword ()

	getTitleKey ($sUri)

	serviceGetBaseUrl ()

Public Attributes
	$sHomeUrl

	$sModuleName

	$aModuleInfo

	$aCoreSettings = array()

	$sMemberMenuPosition = null

	$iLoggedMemberId = 0

	$oPrivacy = null

	$iMaxNickLength = 10

Public Attributes inherited from ChWsbModule
	$_aModule

	$_oDb

	$_oTemplate

	$_oConfig

Additional Inherited Members
Static Public Member Functions inherited from ChWsbModule
static	getInstance ($sClassName)

static	getTitle ($sUri)

Detailed Description

Simple messenger module by Cheetah

Simple messenger allows members to send messages, the message's windows are available in member's menu. This is default module and Cheetah can not work properly without this module.

Profile's Wall: no wall events

Spy: no spy events

Memberships/ACL: use simple messenger - CH_USE_SIMPLE_MESSENGER

Service methods:

Generate messenger's input field into popup action window.

See also: ChSimpleMessengerModule::serviceGetMessengerField ChWsbService::call('simple_messenger', 'get_messenger_field', array($iViewedMemberId));

Generate messenger's core (javascript object);

See also: ChSimpleMessengerModule::serviceGetMessengerCore ChWsbService::call('simple_messenger', 'get_messenger_core', array());

Generate privacy form for the currently logged in member;

See also: ChSimpleMessengerModule::serviceGetSettings ChWsbService::call('simple_messenger', 'get_settings', array());

Alerts: no alerts here.

Definition at line 57 of file ChSimpleMessengerModule.php.

Constructor & Destructor Documentation

◆ __construct()

ChSimpleMessengerModule::__construct ( $aModule )

Class constructor ;

Parameters

: $aModule (array) - contain some information about this module; [ id ] - (integer) module's id ; [ title ] - (string) module's title ; [ vendor ] - (string) module's vendor ; [ path ] - (string) path to this module ; [ uri ] - (string) this module's URI ; [ class_prefix ] - (string) this module's php classes file prefix ; [ db_prefix ] - (string) this module's Db tables prefix ; [ date ] - (string) this module's date installation ;

Reimplemented from ChWsbModule.

Definition at line 92 of file ChSimpleMessengerModule.php.

Member Function Documentation

◆ _defineActions()

ChSimpleMessengerModule::_defineActions ( )

Definition at line 844 of file ChSimpleMessengerModule.php.

◆ actionGetOperation()

ChSimpleMessengerModule::actionGetOperation	(	$sActionName,
		$iRecipientId = `0`
	)

Function will return needed action result ;

Parameters

:	$sActionName	(string) - needed action ;
:	$iRecipientId,(integer)	- recipient's Id ;

Returns: : (text) Html presentation data;

Function will create new message;

Parameters

:	$oObject	(object) - current created object;
:	$iRecipientId	(integer) - recipient's Id ;
:	$sMessage	(string) - sender's message ;

Function will the check active chat box;

Parameters

:	$aChatBoxes	(array) - registered chat boxes;
:	$iMemberId	(integer) - recipient's Id;

Definition at line 155 of file ChSimpleMessengerModule.php.

◆ getChatBox()

ChSimpleMessengerModule::getChatBox ( $iSender )

Function will generate chat block for current member ;

Parameters

: $iSender (integer) - sender member's Id;

Returns: : (array);

Definition at line 526 of file ChSimpleMessengerModule.php.

◆ getMessagesHistory()

ChSimpleMessengerModule::getMessagesHistory	(	$iRecipient,
		$iSender,
		$iLastMessageId = `0`,
		$bLimit = `true`
	)

Function will generate member's messages history ;

Parameters

:	$iSender	(integer) - sender member's Id;
:	$iRecipient	(integer) - recipient member's Id;
:	$iLastMessageId	(integer) - last message's Id of current message Block ;
:	$bLimit	(boolean) - if isset this parameter function will return qualified messages;

Returns: : (array); [messages_list] - (text) messages list; [last_message] - (integer) last message's Id; [count_messages] - (integer) count of generated messages;

Definition at line 633 of file ChSimpleMessengerModule.php.