Summary
- File
- Package hierarchy PHPBoost\Member
- Class hierarchy \PrivateMsg
This class provides methods to manage private message.
Class PrivateMsg
Methods
__static()
__static()
static
- Inherited from \PrivateMsg
Tags
| None found |
count_conversations()
count_conversations(integer $userid) : integerCounts the user's number of conversation.
Parameters
| integer | $userid | The user id. |
Returns
integer
—
number of user conversation.
static
- Inherited from \PrivateMsg
Tags
| None found |
start_conversation()
start_conversation(integer $pm_to, string $pm_objet, string $pm_contents, integer $pm_from, boolean $system_pm = false) Starts a conversation with another member.
Parameters
| integer | $pm_to | The member's user id destination. |
| string | $pm_objet | The object of the conversation. |
| string | $pm_contents | The content of the conversation. |
| integer | $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. |
static
- Inherited from \PrivateMsg
Tags
| None found |
send()
send(integer $pm_to, integer $pm_idconvers, string $pm_contents, integer $pm_from, integer $pm_status, boolean $check_pm_before_send = true) Answers to a conversation
Parameters
| integer | $pm_to | The member's user id destination. |
| integer | $pm_idconvers | |
| string | $pm_contents | The content of the answer. |
| integer | $pm_from | The member's user id author. |
| integer | $pm_status | |
| boolean | $check_pm_before_send |
static
- Inherited from \PrivateMsg
Tags
| None found |
delete_conversation()
delete_conversation(integer $pm_userid, integer $pm_idconvers, integer $pm_expd, boolean $pm_del, boolean $pm_update) Deletes a conversation.
Parameters
| integer | $pm_userid | |
| integer | $pm_idconvers | |
| integer | $pm_expd | |
| boolean | $pm_del | |
| boolean | $pm_update |
static
- Inherited from \PrivateMsg
Tags
| None found |
delete()
delete(integer $pm_to, integer $pm_idmsg, integer $pm_idconvers) : integerDeletes a private message, until the recipient has not read it.
Parameters
| integer | $pm_to | |
| integer | $pm_idmsg | |
| integer | $pm_idconvers |
Returns
integer
—
The previous message id.
static
- Inherited from \PrivateMsg
Tags
| None found |