Inheritance diagram for ChBaseMailBox:

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

	getCss ()

	getJs ()

	getBlockCode_ComposeMessage ()

	getBlockCode_Archives ()

	getBlockCode_ViewMessage ()

	getBlockCode_NewMessages ($bShowEmpty=true)

	getBlockCode_MailBox ()

	getBlockCode_Contacts ()

	genArchiveMessages ()

	genMessagesRows ()

	genReplayMessage ($iRecipientID, $iMessageID=0)

	addReToSubject ($sSubject)

	getAutoCompleteList ($sQuery, $iLimit=10)

Public Member Functions inherited from ChWsbMailBox
	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	get_member_menu_bubble_new_messages ($iMemberId, $iOldCount=0)

static	get_member_menu_messages_list ( $iMemberId=0)

Static Public Member Functions inherited from ChWsbMailBox
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
	$aUsedTemplates

	$sMessageIconPrefix = 'icon_'

	$sMessageIconExtension = '.png'

	$sMembersFlagExtension = '.gif'

	$iMessageSubjectLength = 30

	$iMessageDescrLength = 40

	$iArchivesSubjectLength = 22

Public Attributes inherited from ChWsbMailBox
	$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 11 of file ChBaseMailBox.php.

Constructor & Destructor Documentation

◆ __construct()

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

Class constructor ;

Parameters

:	$sPageName	(string) - page name (need for page builder);
:	$aMailBoxSettings	(array) - contain some necessary data ; [] member_id (integer) - 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 ; [] message_id (integer) - number of needed message ;

Reimplemented from ChWsbMailBox.

Reimplemented in ChTemplMailBox, ChTemplMailBox, and ChTemplMailBox.

Definition at line 45 of file ChBaseMailBox.php.

Member Function Documentation

◆ addReToSubject()

ChBaseMailBox::addReToSubject ( $sSubject )

Adds 'Re: ' or 'Re[n]: ' to the beginning of message subject

Parameters

$sSubject Message subject

Returns: string

Definition at line 1592 of file ChBaseMailBox.php.

◆ genArchiveMessages()

ChBaseMailBox::genArchiveMessages ( )

Function will generate archive messages rows;

Returns: : Html presentation data;

Function will generate the pagination's item ;

Parameters

:	$sItemType	(string) - item's name;
:	$oObject	(object) - link on current created object;

Returns: : Html presentation data;

Definition at line 876 of file ChBaseMailBox.php.

◆ genMessagesRows()

ChBaseMailBox::genMessagesRows ( )

Function will generate the messages rows ;

Returns: : Html presentation data ;

Definition at line 1045 of file ChBaseMailBox.php.

◆ genReplayMessage()

ChBaseMailBox::genReplayMessage	(	$iRecipientID,
		$iMessageID = `0`
	)

Function will generate window with reply message or new compose message;

Parameters

:	$iRecipientID	(integer) - recipient's ID ;
:	$iMessageID	(integer) - message ID (optional parameter);

Returns: : Html presentation data;

Definition at line 1459 of file ChBaseMailBox.php.

◆ get_member_menu_bubble_new_messages()

static ChBaseMailBox::get_member_menu_bubble_new_messages	(	$iMemberId,
		$iOldCount = `0`
	)

static

Function will send count of new messages with notifications;

Parameters

:	$iMemberId	(integer) - logged member's Id;
:	$iOldCount	(integer) - received old count of messages (if will difference will generate message)

Returns: : (array) [count] - (integer) number of new messages; [message] - (string) text message ( if will have a new messages );

Definition at line 1649 of file ChBaseMailBox.php.

◆ get_member_menu_messages_list()

static ChBaseMailBox::get_member_menu_messages_list ( $iMemberId = 0 )

static

Function will get messages list for member's extra menu;

Parameters

: $iMemberId (integer) - member's Id ;

Returns: : Html presentation data ;

Definition at line 1723 of file ChBaseMailBox.php.

◆ getAutoCompleteList()

ChBaseMailBox::getAutoCompleteList	(	$sQuery,
		$iLimit = `10`
	)

Function will get list with users nicknames ;

Parameters

:	$sQuery	(string) - any part of needed nickname ;
:	$iLimit	(integer) - limit of returned rows (optional parameter);

Returns: : Html presentation data ;

Definition at line 1614 of file ChBaseMailBox.php.

◆ getBlockCode_Archives()

ChBaseMailBox::getBlockCode_Archives ( )

Function will generate block with users message archive's list ;

Returns: : Html presentation data ;

Definition at line 219 of file ChBaseMailBox.php.

◆ getBlockCode_ComposeMessage()

ChBaseMailBox::getBlockCode_ComposeMessage ( )

Function will generate compose message block ;

Returns: : Html presentation data ;

Definition at line 82 of file ChBaseMailBox.php.

◆ getBlockCode_Contacts()

ChBaseMailBox::getBlockCode_Contacts ( )

Function will generate block with member's contacts ;

Returns: : html presentation data ;

Definition at line 714 of file ChBaseMailBox.php.

◆ getBlockCode_MailBox()

ChBaseMailBox::getBlockCode_MailBox ( )

Function will generate block with messages ;

Returns: : Html presentation data ;

Definition at line 664 of file ChBaseMailBox.php.

◆ getBlockCode_NewMessages()

ChBaseMailBox::getBlockCode_NewMessages ( $bShowEmpty = true )

Function will generate block with NEW messages. NOTE. The block is displayed on "My Account" page.

Returns: : Html presentation data

Definition at line 633 of file ChBaseMailBox.php.

◆ getBlockCode_ViewMessage()

ChBaseMailBox::getBlockCode_ViewMessage ( )

Function will generate the view message block ;

Returns: : Html presentation data ;

Definition at line 316 of file ChBaseMailBox.php.

◆ getCss()

ChBaseMailBox::getCss ( )

Definition at line 67 of file ChBaseMailBox.php.

◆ getJs()

ChBaseMailBox::getJs ( )

Definition at line 72 of file ChBaseMailBox.php.

Member Data Documentation

◆ $aUsedTemplates

ChBaseMailBox::$aUsedTemplates

Definition at line 14 of file ChBaseMailBox.php.

◆ $iArchivesSubjectLength

ChBaseMailBox::$iArchivesSubjectLength = 22

Definition at line 27 of file ChBaseMailBox.php.

◆ $iMessageDescrLength

ChBaseMailBox::$iMessageDescrLength = 40

Definition at line 24 of file ChBaseMailBox.php.

◆ $iMessageSubjectLength

ChBaseMailBox::$iMessageSubjectLength = 30

Definition at line 23 of file ChBaseMailBox.php.

◆ $sMembersFlagExtension

ChBaseMailBox::$sMembersFlagExtension = '.gif'

Definition at line 20 of file ChBaseMailBox.php.

◆ $sMessageIconExtension

ChBaseMailBox::$sMessageIconExtension = '.png'

Definition at line 18 of file ChBaseMailBox.php.

◆ $sMessageIconPrefix

ChBaseMailBox::$sMessageIconPrefix = 'icon_'

Definition at line 17 of file ChBaseMailBox.php.

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

templates/base/scripts/ChBaseMailBox.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addReToSubject()

◆ genArchiveMessages()

◆ genMessagesRows()

◆ genReplayMessage()

◆ get_member_menu_bubble_new_messages()

◆ get_member_menu_messages_list()

◆ getAutoCompleteList()

◆ getBlockCode_Archives()

◆ getBlockCode_ComposeMessage()

◆ getBlockCode_Contacts()

◆ getBlockCode_MailBox()

◆ getBlockCode_NewMessages()

◆ getBlockCode_ViewMessage()

◆ getCss()

◆ getJs()

Member Data Documentation

◆ $aUsedTemplates

◆ $iArchivesSubjectLength

◆ $iMessageDescrLength

◆ $iMessageSubjectLength

◆ $sMembersFlagExtension

◆ $sMessageIconExtension

◆ $sMessageIconPrefix