members
Packages
Interfaces
Classes
Files

Class: PrivateMsg

Source Location: /members/pm.class.php [line 39]

Class Overview


This class provides methods to manage private message.

Author(s):



Class Details

This class provides methods to manage private message.

Tags:

[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]


Class Methods

method count_conversations [line 47]

int count_conversations( int $userid)
Counts the user's number of conversation.

Tags:

  • return: number of user conversation.

Parameters:

int   $userid   The user id.
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method delete [line 184]

int delete( int $pm_to, int $pm_idmsg, int $pm_idconvers)
Deletes a private message, until the recipient has not read it.

Tags:

  • return: The previous message id.

Parameters:

int   $pm_to  
int   $pm_idmsg  
int   $pm_idconvers  
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method delete_conversation [line 143]

void delete_conversation( int $pm_userid, int $pm_idconvers, int $pm_expd, boolean $pm_del, boolean $pm_update)
Deletes a conversation.

Parameters:

int   $pm_userid  
int   $pm_idconvers  
int   $pm_expd  
boolean   $pm_del  
boolean   $pm_update  
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method send [line 109]

void send( int $pm_to, int $pm_idconvers, string $pm_contents, int $pm_from, int $pm_status, [boolean $check_pm_before_send = true])
Answers to a conversation

Parameters:

int   $pm_to   The member's user id destination.
int   $pm_idconvers  
string   $pm_contents   The content of the answer.
int   $pm_from   The member's user id author.
int   $pm_status  
boolean   $check_pm_before_send  
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method start_conversation [line 80]

void start_conversation( int $pm_to, string $pm_objet, string $pm_contents, int $pm_from, [boolean $system_pm = false])
Starts a conversation with another member.

Parameters:

int   $pm_to   The member's user id destination.
string   $pm_objet   The object of the conversation.
string   $pm_contents   The content of the conversation.
int   $pm_from   The member's user id author.
boolean   $system_pm   If true, the conversation has been started by the system, and not by the private message interface.
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]


Class Variables

[line 207]   mixed  $pm_convers_id 
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
[line 208]   mixed  $pm_msg_id 
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
Documentation generated on Tue, 28 Jul 2009 22:43:41 +0200 by phpDocumentor 1.4.1