Inheritance diagram for ChWsbMailBox:

Public Member Functions
	__construct ( $sPageName, &$aMailBoxSettings)

	getArchivesList ($sSqlLimit)

	getFriendsList ( $sSqlLimit)

	getFavesList ( $sSqlLimit)

	getContactedList ( $sSqlLimit)

	getInboxMessagesCount ()

	getMessages ()

	setMarkMessage ( $iMessageID, $iMarkMode)

	setTrashedMessage ($iMessageID, $sField='Trash')

	setRestoredMessage ( $iMessageID)

	sendMessage ( $sMessageSubject, $sMessageBody, $vRecipientID, &$aComposeSettings, $isSimulateSending=false)

	isSendMessageAlowed ($iMemberId, $isPerformAction=false)

	_defineActions ()

Public Member Functions inherited from ChWsbPageView
	__construct ( $sPageName)

	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)

Static Public Member Functions
static	getCountSentMessages ($iMemberId, $sMessageStatus=null)

static	getCountInboxMessages ($iMemberId, $sMessageStatus=null)

static	getCountTrashedMessages ($iMemberId, $sMessageStatus=null)

Static Public Member Functions inherited from ChWsbPageView
static	getBlockCaptionItemCode ( $iBlockID, $aLinks)

static	getBlockCaptionMenu ( $iBlockID, $aLinks)

Public Attributes
	$iSendMessageStatusCode

	$iTotalMessageCount

	$iTotalContactsCount

	$iContactsPerPage = 8

	$aMailBoxSettings = array()

	$aSortCriterias = array()

	$aRegisteredMessageTypes = array()

	$aRegisteredContactTypes = array()

	$aRegisteredArchivesTypes = array()

	$aReceivedMessagesTypes = array()

	$iWaitMinutes = 1

Public Attributes inherited from ChWsbPageView
	$sPageName

	$aPage

	$sCode = ''

	$sWhoViews = 'non'

	$iMemberID = 0

	$bAjaxMode = false

	$aColumnsWidth = array ()

	$sTableName = 'sys_page_compose'

	$sCacheFile

	$oCacher = null

Detailed Description

Definition at line 19 of file ChWsbMailBox.php.

Constructor & Destructor Documentation

◆ __construct()

ChWsbMailBox::__construct	(		$sPageName,
		&	$aMailBoxSettings
	)

Class constructor;

Parameters

:	$sPageName	(string) - page name (need for page builder);
:	$aMailBoxSettings	(array) - contain some necessary data ; [] member_id (integer) - logged member's ID; [] recipient_id (integer) - message recipient's ID ; [] mailbox_mode (string) - inbox, outbox or trash switcher mode ; [] sort_mode (string) - message sort mode; [] page (integer) - number of current page ; [] per_page (integer) - number of messages for per page ; [] messages_types (string) - all needed types of messages ; [] contacts_mode (string) - type of contacts (friends, faves, contacted) ; [] contacts_page (integer) - number of current contact's page ; [] messageID (integer) - number of needed message ;

Reimplemented in ChTemplMailBox, ChTemplMailBox, ChTemplMailBox, and ChBaseMailBox.

Definition at line 70 of file ChWsbMailBox.php.

Member Function Documentation

◆ _defineActions()

ChWsbMailBox::_defineActions ( )

Definition at line 1024 of file ChWsbMailBox.php.

◆ getArchivesList()

ChWsbMailBox::getArchivesList ( $sSqlLimit )

Function will get array with all member's mail messages;

Parameters

: $sSqlLimit (string) - rows limit for sql query ;

Returns: : array;

Definition at line 188 of file ChWsbMailBox.php.

◆ getContactedList()

ChWsbMailBox::getContactedList ( $sSqlLimit )

Function will get array with all member's contacted persons ;

Parameters

: $sSqlLimit (string) - limit of returned rows ;

Returns: : array;

Definition at line 375 of file ChWsbMailBox.php.

◆ getCountInboxMessages()

static ChWsbMailBox::getCountInboxMessages	(	$iMemberId,
		$sMessageStatus = `null`
	)

static

Function will get count of inbox messages ;

Parameters

:	$iMemberId	(integer) - logged member's id;
:	$sMessageStatus	(string) - needed message's status (possible values - '1', '0');

Returns: : (integer) - number of inbox messages;

Definition at line 932 of file ChWsbMailBox.php.

◆ getCountSentMessages()

static ChWsbMailBox::getCountSentMessages	(	$iMemberId,
		$sMessageStatus = `null`
	)

static

Function will get count of sent messsages ;

Parameters

:	$iMemberId	(integer) - logged member's id;
:	$sMessageStatus	(string) - needed message's status (possible values - '1', '0');

Returns: : (integer) - number of sent messages;

Definition at line 902 of file ChWsbMailBox.php.

◆ getCountTrashedMessages()

static ChWsbMailBox::getCountTrashedMessages	(	$iMemberId,
		$sMessageStatus = `null`
	)

static

Function will get count of trashed messages ;

Parameters

:	$iMemberId	(integer) - logged member's id;
:	$sMessageStatus	(string) - needed message's status (possible values - '1', '0');

Returns: : (integer) - number of trashed messages;

Definition at line 962 of file ChWsbMailBox.php.

◆ getFavesList()

ChWsbMailBox::getFavesList ( $sSqlLimit )

Function will get array with all member's faves ;

Parameters

: $sSqlLimit (string) - rows limit for sql query ;

Returns: : array;

Definition at line 317 of file ChWsbMailBox.php.

◆ getFriendsList()

ChWsbMailBox::getFriendsList ( $sSqlLimit )

Function will get array with all member's friends ;

Parameters

: $sSqlLimit (string) - rows limit for sql query ;

Returns: : array;

Definition at line 281 of file ChWsbMailBox.php.

◆ getInboxMessagesCount()

ChWsbMailBox::getInboxMessagesCount ( )

function will get count of inbox messages ;

Returns: : (integer) - number of messages;

Definition at line 431 of file ChWsbMailBox.php.

◆ getMessages()

ChWsbMailBox::getMessages ( )

Function will get array with messages ;

Returns: : hash array with messages ;

Definition at line 455 of file ChWsbMailBox.php.

◆ isSendMessageAlowed()

ChWsbMailBox::isSendMessageAlowed	(	$iMemberId,
		$isPerformAction = `false`
	)

Function will check membership level for current type if users;

Parameters

:	$iMemberId	(integer) - member's Id;
:	$isPerformAction	(boolean) - if isset this parameter that function will amplify the old action's value;

Definition at line 1015 of file ChWsbMailBox.php.

◆ sendMessage()

ChWsbMailBox::sendMessage	(		$sMessageSubject,
			$sMessageBody,
			$vRecipientID,
		&	$aComposeSettings,
			$isSimulateSending = `false`
	)

Function will send the compose message ;

Parameters

:	$sMessageSubject	(string) - message's subject ;
:	$sMessageBody	(string) - message's body ;
:	$vRecipientID	(variant)- message's recipient ID or NickName;
:	$aComposeSettings	(array) - contain all needed settings for compose message ; [ send_copy ] (bolean) - allow to send message to phisical recipient's email ; [ notification ] (boolean) - allow to send notification to the recipient's email ; [ send_copy_to_me ] (boolean) - allow to send message to phisical sender's email ;

Returns: : signaling information with Html ;

Definition at line 729 of file ChWsbMailBox.php.

◆ setMarkMessage()

ChWsbMailBox::setMarkMessage	(	$iMessageID,
		$iMarkMode
	)

Function will set mark message with received mode ;

Parameters

:	$iMessageID	(integer) - message's ID ;
:	$iMarkMode	(integer) - 0 if message not new, else 1 ;

Returns: : (integer) - number of affected rows ;

Definition at line 595 of file ChWsbMailBox.php.

◆ setRestoredMessage()

ChWsbMailBox::setRestoredMessage ( $iMessageID )

Function will restore message from trash ;

Parameters

: $iMessageID (integer) - message's Id ;

Returns: : (integer) - number of affected rows ;

Definition at line 668 of file ChWsbMailBox.php.

◆ setTrashedMessage()

ChWsbMailBox::setTrashedMessage	(	$iMessageID,
		$sField = `'Trash'`
	)

Function will set the message in trash mode ;

Parameters

: $iMessageID (integer) - message's Id ; @paaram $sField string

Returns: : (integer) - number of affected rows ;

Definition at line 623 of file ChWsbMailBox.php.

Member Data Documentation

◆ $aMailBoxSettings

ChWsbMailBox::$aMailBoxSettings = array()

Definition at line 34 of file ChWsbMailBox.php.

◆ $aReceivedMessagesTypes

ChWsbMailBox::$aReceivedMessagesTypes = array()

Definition at line 49 of file ChWsbMailBox.php.

◆ $aRegisteredArchivesTypes

ChWsbMailBox::$aRegisteredArchivesTypes = array()

Definition at line 46 of file ChWsbMailBox.php.

◆ $aRegisteredContactTypes

ChWsbMailBox::$aRegisteredContactTypes = array()

Definition at line 43 of file ChWsbMailBox.php.

◆ $aRegisteredMessageTypes

ChWsbMailBox::$aRegisteredMessageTypes = array()

Definition at line 40 of file ChWsbMailBox.php.

◆ $aSortCriterias

ChWsbMailBox::$aSortCriterias = array()

Definition at line 37 of file ChWsbMailBox.php.

◆ $iContactsPerPage

ChWsbMailBox::$iContactsPerPage = 8

Definition at line 31 of file ChWsbMailBox.php.

◆ $iSendMessageStatusCode

ChWsbMailBox::$iSendMessageStatusCode

Definition at line 22 of file ChWsbMailBox.php.

◆ $iTotalContactsCount

ChWsbMailBox::$iTotalContactsCount

Definition at line 28 of file ChWsbMailBox.php.

◆ $iTotalMessageCount

ChWsbMailBox::$iTotalMessageCount

Definition at line 25 of file ChWsbMailBox.php.

◆ $iWaitMinutes

ChWsbMailBox::$iWaitMinutes = 1

Definition at line 52 of file ChWsbMailBox.php.

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

inc/classes/ChWsbMailBox.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _defineActions()

◆ getArchivesList()

◆ getContactedList()

◆ getCountInboxMessages()

◆ getCountSentMessages()

◆ getCountTrashedMessages()

◆ getFavesList()

◆ getFriendsList()

◆ getInboxMessagesCount()

◆ getMessages()

◆ isSendMessageAlowed()

◆ sendMessage()

◆ setMarkMessage()

◆ setRestoredMessage()

◆ setTrashedMessage()

Member Data Documentation

◆ $aMailBoxSettings

◆ $aReceivedMessagesTypes

◆ $aRegisteredArchivesTypes

◆ $aRegisteredContactTypes

◆ $aRegisteredMessageTypes

◆ $aSortCriterias

◆ $iContactsPerPage

◆ $iSendMessageStatusCode

◆ $iTotalContactsCount

◆ $iTotalMessageCount

◆ $iWaitMinutes