ChSimpleMessengerDb Class Reference

Inheritance diagram for ChSimpleMessengerDb:

Public Member Functions
	__construct (&$oConfig)
	createMessage ($iSenderId, $iRecipientId, $sMessage)
	closeChatWindow ($iRecipientId, $iLoggedMember)
	deleteAllMessagesHistory ($iProfileId)
	deleteMessagesHistory ($iSender, $iRecipient, $iAllowCountMessages)
	getLastMessagesId ($iRecipient, $iSender)
	getChatBoxesCount ($iSender)
	getMessagesCount ($iRecipient, $iSender)
	getHistoryList (&$aCoreSettings, $iRecipient, $iSender, $iLastMessageId=0, $iMessageLimit=0)
	getNewChatBoxes ($iRecipientId, $aRegBoxes=array())
	createPrivacyGroup ($iMemberId, $iGroupValue=0)
	getPrivacyGroupValue ($iMemberId)
	shieldData ($sData)
Public Member Functions inherited from ChWsbModuleDb
	__construct ($oConfig=null)
	getPrefix ()
	getModulesBy ($aParams=array())
	getModuleById ($iId)
	getModuleByUri ($sUri)
	isModule ($sUri)
	isModuleParamsUsed ($sUri, $sPath, $sPrefixDb, $sPrefixClass)
	getModules ()
	getDependent ($sUri)
	getSettingsCategoryId ($sCatName)
Public Member Functions inherited from ChWsbDb
	setTimezone ($sTimezone)
	getLink ()
	res ($sQuery, $aBindings=[], $bReplaying=false)
	getAll ($sQuery, $aBindings=[], $iFetchType=PDO::FETCH_ASSOC)
	getRow ($sQuery, $aBindings=[], $iFetchStyle=PDO::FETCH_ASSOC)
	getColumn ($sQuery, $aBindings=[])
	getOne ($sQuery, $aBindings=[], $iIndex=0)
	getFirstRow ($sQuery, $aBindings=[], $iFetchStyle=PDO::FETCH_ASSOC)
	getNextRow ()
	getAllWithKey ($sQuery, $sFieldKey, $aBindings=[], $iFetchType=PDO::FETCH_ASSOC)
	getPairs ($sQuery, $sFieldKey, $sFieldValue, $aBindings=[])
	query ($sQuery, $aBindings=[])
	getNumRows ($oStmt=null)
	getAffectedRows ($oStmt=null)
	fillArray ($oStmt, $iFetchType=PDO::FETCH_ASSOC)
	lastId ()
	getParam ($sName, $bCache=true)
	setParam ($sName, $sValue)
	listTables ()
	getFields ($sTable)
	isFieldExists ($sTable, $sFieldName)
	fetchField ($mixedQuery, $iField, $aBindings=[])
	getDbCacheObject ()
	genDbCacheKey ($sName)
	fromCache ($sName, $sFunc)
	cleanCache ($sName)
&	fromMemory ($sName, $sFunc)
	cleanMemory ($sName)
	arrayToSQL ($a, $sDiv=',')
	escape ($sText, $bReal=true)
	implode_escape ($mixed)
	unescape ($mixed)

Public Attributes
	$_oConfig
	$sTablePrefix
Public Attributes inherited from ChWsbModuleDb
	$_sPrefix
Public Attributes inherited from ChWsbDb
	$port
	$socket
	$dbname
	$user
	$password
	$oParams = null
	$oDbCacheObject = null

Additional Inherited Members
Static Public Member Functions inherited from ChWsbDb
static	getInstance ()
Protected Member Functions inherited from ChWsbDb
	__construct ()
	connect ()
	disconnect ()
Protected Attributes inherited from ChWsbDb
	$host
	$link
	$oCurrentStmt
	$iCurrentFetchStyle
Static Protected Attributes inherited from ChWsbDb
static	$instance

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/

Definition at line 10 of file ChSimpleMessengerDb.php.

Constructor & Destructor Documentation

__construct()

ChSimpleMessengerDb::__construct

(

&

$oConfig

)

Constructor.

Definition at line 19 of file ChSimpleMessengerDb.php.

Member Function Documentation

closeChatWindow()

ChSimpleMessengerDb::closeChatWindow	(		$iRecipientId,
			$iLoggedMember
	)

Function will close chat window;

Parameters

:	$iLoggedMember	(integer) - current's logged member;
:	$iRecipientId	(integer) - recepient's Id;

Returns

: (integer) - number of affected rows ;

Definition at line 62 of file ChSimpleMessengerDb.php.

createMessage()

ChSimpleMessengerDb::createMessage	(		$iSenderId,
			$iRecipientId,
			$sMessage
	)

Function will create new message ;

Parameters

:	$iSenderId	(integer) - sender Id;
:	$iRecipientId	(integer) - recipient Id;
:	$sMessage	(string) - message text;

Returns

: (integer) - number of affected rows ;

Definition at line 35 of file ChSimpleMessengerDb.php.

createPrivacyGroup()

ChSimpleMessengerDb::createPrivacyGroup	(		$iMemberId,
			$iGroupValue = 0
	)

Function will create member's privacy group;

Parameters

:	$iMemberId	(integer) - member's Id;
:	$iGroupValue	(integer) - privacy group's value;

Definition at line 492 of file ChSimpleMessengerDb.php.

deleteAllMessagesHistory()

ChSimpleMessengerDb::deleteAllMessagesHistory

(

$iProfileId

)

Function will delete profile's history;

Parameters

:

$iProfileId

(integer) - profile's Id;

Returns

: void;

Definition at line 126 of file ChSimpleMessengerDb.php.

deleteMessagesHistory()

ChSimpleMessengerDb::deleteMessagesHistory	(		$iSender,
			$iRecipient,
			$iAllowCountMessages
	)

Function will delete messages history ;

Parameters

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

Definition at line 151 of file ChSimpleMessengerDb.php.

getChatBoxesCount()

ChSimpleMessengerDb::getChatBoxesCount

(

$iSender

)

Function will get count of user's active chat boxes;

Parameters

:

$iSender

(integer) - sender's id;

Returns

: (array) - return array with all sender's chat boxes (recipients id); [RecipientID] - (string) recipient's Id;

Definition at line 249 of file ChSimpleMessengerDb.php.

getHistoryList()

ChSimpleMessengerDb::getHistoryList	(	&	$aCoreSettings,
			$iRecipient,
			$iSender,
			$iLastMessageId = 0,
			$iMessageLimit = 0
	)

Function will generate member's messages history ;

Parameters

:	$aCoreSettings	(array) - chat's core settings;
:	$iSender	(integer) - sender member's Id;
:	$iRecipient	(integer) - recipient member's Id;
:	$iLastMessageId	(integer) - last message's Id (query will return all rows after this value);
:	$iMessageLimit	(integer) - rows limit ;

Returns

: array; [ ID ] - (integer) message's Id ; [ Message ] - (string) message string ; [ SenderID ] - (integer) message's sender Id ; [ RecipientID ] - (integer) message's recipient Id ; [ Date ] - (string) when message was created ;

Definition at line 357 of file ChSimpleMessengerDb.php.

getLastMessagesId()

ChSimpleMessengerDb::getLastMessagesId	(		$iRecipient,
			$iSender
	)

Function will get the last message's id for current chat box;

Parameters

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

Returns

: (integer) - the last message's id;

Definition at line 213 of file ChSimpleMessengerDb.php.

getMessagesCount()

ChSimpleMessengerDb::getMessagesCount	(		$iRecipient,
			$iSender
	)

Function will get the chat box's number of messages;

Parameters

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

Returns

: (integer) - number of messages;

Definition at line 314 of file ChSimpleMessengerDb.php.

getNewChatBoxes()

ChSimpleMessengerDb::getNewChatBoxes	(		$iRecipientId,
			$aRegBoxes = array()
	)

Function will generate list of members;

Parameters

:	$iRecipientId	(integer) - recipient Id ;
:	$aRegBoxes	(array) - registered messages box;

Returns

: (array) - with members id ; [SenderID] (integer) - sender's id;

Definition at line 416 of file ChSimpleMessengerDb.php.

getPrivacyGroupValue()

ChSimpleMessengerDb::getPrivacyGroupValue

(

$iMemberId

)

Function will get privacy group value for member's Id;

Parameters

:

$iMemberId

(integer) - member's Id;

Returns

: (integer);

Definition at line 515 of file ChSimpleMessengerDb.php.

shieldData()

ChSimpleMessengerDb::shieldData

(

$sData

)

Function will protect received data with backlashes ;

Parameters

:

$sData

(string) - text data ;

Returns

: (string) - protected data ;

Definition at line 530 of file ChSimpleMessengerDb.php.

Member Data Documentation

$_oConfig

ChSimpleMessengerDb::$_oConfig

Definition at line 12 of file ChSimpleMessengerDb.php.

$sTablePrefix

ChSimpleMessengerDb::$sTablePrefix

Definition at line 14 of file ChSimpleMessengerDb.php.

---

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

• modules/cheetah/simple_messenger/classes/ChSimpleMessengerDb.php