ChWsbCommunicator Class Reference

Inheritance diagram for ChWsbCommunicator:

Public Member Functions
	__construct ($aCommunicatorSettings)
	getRequests ( $sTableName, &$aRequestTypes, $sAdditionalParam=null, $sAdditionalField=null)
	execFunction ( $sCallback, $sTableName, &$aMembersList, $aParameters=array())
	_deleteRequest ( $sTableName, $iMemberID, $iFromOwner=0, $iExtraDelete=0)
	_addRequest ( $sTableName, $iMemberID)
	_acceptFriendInvite ($sTableName, $iMemberID)
	_getJsObject ()
Public Member Functions inherited from ChWsbPageView
	checkAjaxMode ()
	createCache ()
	load ()
	isLoaded ()
	getPageTitle ()
	getPageWidth ()
	getPageClass ()
	getViewerInfo ()
	forcePageWidth ($iWidth)
	gen ()
	genPageEmpty ()
	genOnlyBlock ( $iBlockID, $sDynamicType='tab')
	getCode ()
	genColumnsHeader ()
	genColumnsFooter ()
	genColumn ( $iColumn)
	getBlockCode_Topest ($iColumn)
	genColumnHeader ( $iColumn, $fColumnWidth)
	genColumnFooter ( $iColumn)
	genBlock ( $iBlockID, $aBlock, $bStatic=true, $sDynamicType='tab')
	_getBlockCaptionCode ($iBlockID, $aBlock, $aBlockCode, $bStatic=true, $sDynamicType='tab')
	_getBlockTopCode ($iBlockID, $aBlock, $aBlockCode, $bStatic=true, $sDynamicType='tab')
	_getBlockBottomCode ($iBlockID, $aBlock, $aBlockCode, $bStatic=true, $sDynamicType='tab')
	isBlockVisible ( $sVisible)
	getBlockBottomCode ( $iBlockID, $aLinks)
	getBlockCode_MemberStat ()
	getBlockCode_Custom ( $iBlockID, $sContent)
	getBlockCode_Echo ( $iBlockID, $sContent)
	getBlockCode_TrueText ( $iBlockID, $sContent)
	getBlockCode_Text ($iBlockID, $sContent)
	getBlockCode_XML ( $iBlockID, $sContent)
	getBlockCode_PHP ( $iBlockID, $sContent)
	getBlockCode_Code ( $iBlockID, $sContent)
	getBlockCode_RSS ( $iBlockID, $sContent)
	getBlockCode_LoginSection ($iBlockID, $sParams='')
	GenFormWrap ($sMainContent, $sPage, $sFunctionName, $iMaxThumbWidth, $iThumbsCnt)
	getBlocksCacheObject ()
	genBlocksCacheKey ($sId)

Public Attributes
	$iTotalRequestsCount
	$aCommunicatorSettings = array()
Public Attributes inherited from ChWsbPageView
	$sPageName
	$aPage
	$sCode = ''
	$sWhoViews = 'non'
	$iMemberID = 0
	$bAjaxMode = false
	$aColumnsWidth = array ()
	$sTableName = 'sys_page_compose'
	$sCacheFile
	$oCacher = null

Additional Inherited Members
Static Public Member Functions inherited from ChWsbPageView
static	getBlockCaptionItemCode ( $iBlockID, $aLinks)
static	getBlockCaptionMenu ( $iBlockID, $aLinks)

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 12 of file ChWsbCommunicator.php.

Constructor & Destructor Documentation

__construct()

ChWsbCommunicator::__construct

(

$aCommunicatorSettings

)

Class constructor ;

Parameters

:

$aCommunicatorSettings

(array) - contain some necessary data ; [ member_id ] (integer) - logged member's ID; [ communicator_mode ] (string) - page mode ; [ person_switcher ] (string) - switch the person mode - from me or to me ; [ sorting ] (string) - type of message's sort ; [ page ] (integer) - contain number of current page ; [ per_page ] (integer) - contain per page number for current page ; [ alert_page ] (integer) - contain number of current alert's page

Reimplemented from ChWsbPageView.

Reimplemented in ChTemplCommunicator, ChTemplCommunicator, ChTemplCommunicator, and ChBaseCommunicator.

Definition at line 32 of file ChWsbCommunicator.php.

Member Function Documentation

_acceptFriendInvite()

ChWsbCommunicator::_acceptFriendInvite	(		$sTableName,
			$iMemberID
	)

Function will set status as accepted for friend request ;

Parameters

:	$sTableName	(string) - DB table's name ;
:	$iMemberID	(integer) - member's ID ;

Definition at line 325 of file ChWsbCommunicator.php.

_addRequest()

ChWsbCommunicator::_addRequest	(		$sTableName,
			$iMemberID
	)

Function will add request into received table's name ;

Parameters

:	$sTableName	(string) - DB table's name ;
:	$iMemberID	(integer) - member's ID ;

Returns

: (integer) - number of affected rows;

Definition at line 284 of file ChWsbCommunicator.php.

_deleteRequest()

ChWsbCommunicator::_deleteRequest	(		$sTableName,
			$iMemberID,
			$iFromOwner = 0,
			$iExtraDelete = 0
	)

Function will delete request from received table's name ;

Parameters

:	$sTableName	(string) - DB table's name ;
:	$iFromOwner	(integer) - swith mode to from owner or from recipent ;
:	$iMemberID	(integer) - member's ID ;

Returns

: (integer) - number of affected rows;

Definition at line 216 of file ChWsbCommunicator.php.

_getJsObject()

ChWsbCommunicator::_getJsObject

(

)

Definition at line 354 of file ChWsbCommunicator.php.

execFunction()

ChWsbCommunicator::execFunction	(		$sCallback,
			$sTableName,
		&	$aMembersList,
			$aParameters = array()
	)

Function will execute the received method name ;

Parameters

:	$sCallback	(string) - name of needed function name ;
:	$sTableName	(string) - DB table's name ;
:	$aMembersList	(array)- received members list ;
:	$aParameters	(array) - extended method parameters ;

Definition at line 193 of file ChWsbCommunicator.php.

getRequests()

ChWsbCommunicator::getRequests	(		$sTableName,
		&	$aRequestTypes,
			$sAdditionalParam = null,
			$sAdditionalField = null
	)

Function will return array with needed requests ;

Parameters

:	$sTableName	(string) - DB's table name;
:	$aRequestTypes	(array) - contain language keys for differences person's mode ; [ from ] - needed if person mode = 'from' ; [ to ] - needed if person mode = 'to' ;
:	$sAdditionalParam	(string) - additional SQL query ;
:	$sAdditionalField	(string) - additional table's field ;

Returns

: (array) array with all requests ; [ member_id ] - member's ID ; [ date ] - request's date ; [ type ] - type of request ;

Definition at line 72 of file ChWsbCommunicator.php.

Member Data Documentation

$aCommunicatorSettings

ChWsbCommunicator::$aCommunicatorSettings = array()

Definition at line 18 of file ChWsbCommunicator.php.

$iTotalRequestsCount

ChWsbCommunicator::$iTotalRequestsCount

Definition at line 15 of file ChWsbCommunicator.php.

---

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

• inc/classes/ChWsbCommunicator.php