Class: Messages

Source Location: d:\website\PhpDocumentor\/messages/Messages.php

Class Overview

BitBase
   |
   --Messages

Messages base class

Methods

Inherited Variables

Class: BitBase

BitBase::$dType
BitBase::$mCacheTime
BitBase::$mDb
BitBase::$mErrors
BitBase::$mInfo
BitBase::$mLogs
BitBase::$mName
BitBase::$mSuccess

Inherited Methods

Class: BitBase

BitBase::BitBase(): During initialisation, we assign a name which is used by the class.
BitBase::debug(): Switch debug level in database
BitBase::display(): This method should be THE method used to display a template. php files should not access $gBitSmarty directly.
BitBase::getDb(): Return pointer to current Database
BitBase::getField(): Returns entry from the mInfo hash if field exists
BitBase::isDatabaseValid(): Determines if there is a valide database connection
BitBase::prepGetList(): Prepares parameters with default values for any getList function
BitBase::setDatabase(): Sets database mechanism for the instance
BitBase::verifyId(): Determines if any given variable exists and is a number

Class Details

[line 16]
Messages base class

[ Top ]

Class Methods

constructor Messages [line 17]

Messages Messages(
)

[ Top ]

method expunge [line 318]

void expunge(

$pUserId, 
$msg_id)

Parameters:

	$pUserId
	$msg_id

[ Top ]

method expungeSystemMessage [line 433]

void expungeSystemMessage(
[
$pMessageId = NULL])

Parameters:

$pMessageId

[ Top ]

method flagMessage [line 295]

void flagMessage(

$pFlagHash)

Parameters:

$pFlagHash

[ Top ]

method getList [line 123]

void getList(

&$pListHash)

Parameters:

&$pListHash

[ Top ]

method getMessage [line 369]

void getMessage(

$pUserId, 
$msg_id)

Parameters:

	$pUserId
	$msg_id

[ Top ]

method getNeighbourMessage [line 331]

void getNeighbourMessage(

&$pListHash)

Parameters:

&$pListHash

[ Top ]

method getSystemMessageList [line 423]

void getSystemMessageList(
)

[ Top ]

method isSystemMessage [line 443]

void isSystemMessage(
[
$pMessageId = NULL])

Parameters:

$pMessageId

[ Top ]

method postMessage [line 28]

TRUE postMessage(
array
$pParamHash)

postMessage

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array

$pParamHash

[ Top ]

method postSystemMessage [line 411]

void postSystemMessage(

$pParamHash)

Parameters:

$pParamHash

[ Top ]

method unreadMessages [line 398]

void unreadMessages(

$pUserId)

Parameters:

$pUserId

[ Top ]

method verifyMessage [line 59]

TRUE verifyMessage(

&$pParamHash, array
$pParamHash)

verifyMessage

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters:

array	$pParamHash
	&$pParamHash

[ Top ]

Documentation generated on Thu, 15 Feb 2007 20:43:49 +0000 by phpDocumentor 1.3.0