Docs For Class Message

Class Overview

Message Class

Located in /blogs/inc/messaging/model/_message.class.php [line 33]

DataObject
   |
   --Message

Author(s):

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From DataObject DataObject::$allow_ID_insert DataObject::$delete_cascades DataObject::$delete_restrictions DataObject::$ID	Inherited From DataObject DataObject::DataObject() Constructor DataObject::action_icon() Generate requested action icon depending on perm DataObject::action_link() Generate requested action link depending on perm DataObject::check_delete() Check relations for restrictions before deleting DataObject::check_relations() Check relations for restrictions or cascades. DataObject::confirm_delete() Displays form to confirm deletion of this object DataObject::dbchange() Records a change that will need to be updated in the db DataObject::dbdelete() Delete object from DB. DataObject::dbexists() Check existence of specified value in unique field. DataObject::dbinsert() Insert object into DB based on previously recorded changes. DataObject::dbsave() Inserts or Updates depending on object state. DataObject::dbupdate() Update the DB based on previously recorded changes DataObject::dget() Get a ready-to-display member param by its name DataObject::disp() Display a member param by its name DataObject::get() Get a member param by its name DataObject::get_action_title() Generate help title text for action DataObject::history_info_icon() Create icon with dataobject history DataObject::ID() Template function: Displays object ID. DataObject::set() Set param value DataObject::set_from_Request() Set a parameter from a Request form value. DataObject::set_param() Set param value. DataObject::set_string_from_param() Set a string parameter from a Request form value.

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObject

DataObject::$allow_ID_insert

DataObject::$delete_cascades

DataObject::$delete_restrictions

DataObject::$ID

Inherited From DataObject

DataObject::DataObject()

Constructor

DataObject::action_icon()

Generate requested action icon depending on perm

DataObject::action_link()

Generate requested action link depending on perm

DataObject::check_delete()

Check relations for restrictions before deleting

DataObject::check_relations()

Check relations for restrictions or cascades.

DataObject::confirm_delete()

Displays form to confirm deletion of this object

DataObject::dbchange()

Records a change that will need to be updated in the db

DataObject::dbdelete()

Delete object from DB.

DataObject::dbexists()

Check existence of specified value in unique field.

DataObject::dbinsert()

Insert object into DB based on previously recorded changes.

DataObject::dbsave()

Inserts or Updates depending on object state.

DataObject::dbupdate()

Update the DB based on previously recorded changes

DataObject::dget()

Get a ready-to-display member param by its name

DataObject::disp()

Display a member param by its name

DataObject::get()

Get a member param by its name

DataObject::get_action_title()

Generate help title text for action

DataObject::history_info_icon()

Create icon with dataobject history

DataObject::ID()

Template function: Displays object ID.

DataObject::set()

Set param value

DataObject::set_from_Request()

Set a parameter from a Request form value.

DataObject::set_param()

Set param value.

DataObject::set_string_from_param()

Set a string parameter from a Request form value.

[ Top ]

Property Summary

mixed	$AUTHOR	Available message statuses constants
mixed	$author_name
mixed	$author_user_ID
mixed	$datetime
mixed	$READ
mixed	$text
instance	$Thread	Thread lazy filled
mixed	$thread_ID
mixed	$UNREAD

[ Top ]

Method Summary

Message	Message()	Constructor
boolean	check_perm()	Check permission on a message
cloned	clone_message()	Clone current message and convert cloned message from 'individual' to 'discussion'.
void	dbdelete()	Delete message and dependencies from database
true	dbinsert_contacts()	Insert contacts into database
true	dbinsert_discussion()	Insert discussion (one thread for all recipients)
true	dbinsert_individual()	Insert new thread for each recipient
true	dbinsert_message()	Insert message in existing thread
true	dbinsert_threadstatus()	Insert recipients into database
true	dbupdate_last_contact_datetime()	Update last contact datetimes
void	&get_Thread()	Get Thread object
boolean	load_from_Request()	Load data from Request form fields.
boolean	send_email_notifications()	Send email notification to recipients on new thread or new message event.

[ Top ]

Properties

mixed $AUTHOR = 0 [line 40]

Available message statuses constants

[ Top ]

mixed $author_name = '' [line 46]

[ Top ]

mixed $author_user_ID [line 45]

[ Top ]

mixed $datetime = '' [line 47]

[ Top ]

mixed $READ = 1 [line 41]

[ Top ]

mixed $text = '' [line 48]

[ Top ]

instance $Thread [line 55]

Thread lazy filled

[ Top ]

mixed $thread_ID [line 44]

[ Top ]

mixed $UNREAD = 2 [line 42]

[ Top ]

Methods

Constructor Message [line 63]

Message Message(
[db_row
$db_row = NULL] 
)

Constructor

Parameters:

db_row

$db_row:

database row

[ Top ]

check_perm [line 400]

boolean check_perm(

$action, [
$assert = true] 
)

Check permission on a message

Parameters:

	$action:
	$assert:

API Tags:

Return:

true if granted

[ Top ]

clone_message [line 349]

cloned clone_message(
instance
$message 
)

Clone current message and convert cloned message from 'individual' to 'discussion'.

Parameters:

instance

$message:

of Message class

API Tags:

Return:

message

[ Top ]

dbdelete [line 368]

void dbdelete(
Log
0 
)

Delete message and dependencies from database

Parameters:

Log

0:

Log object where output gets added (by reference).

Redefinition of:

DataObject::dbdelete(): Delete object from DB.

[ Top ]

dbinsert_contacts [line 265]

true dbinsert_contacts(
recipients
$recipients 
)

Insert contacts into database

Parameters:

recipients

$recipients:

API Tags:

Return:

if success, instead false

[ Top ]

dbinsert_discussion [line 130]

true dbinsert_discussion(
)

Insert discussion (one thread for all recipients)

API Tags:

Return:

if success, false otherwise

[ Top ]

dbinsert_individual [line 172]

true dbinsert_individual(
)

Insert new thread for each recipient

API Tags:

Return:

if success, instead false

[ Top ]

dbinsert_message [line 195]

true dbinsert_message(
)

Insert message in existing thread

API Tags:

Return:

if success, instead false

[ Top ]

dbinsert_threadstatus [line 242]

true dbinsert_threadstatus(
recipients
$recipients_list 
)

Insert recipients into database

Parameters:

recipients

$recipients_list:

API Tags:

Return:

if success, instead false

[ Top ]

dbupdate_last_contact_datetime [line 314]

true dbupdate_last_contact_datetime(
)

Update last contact datetimes

API Tags:

Return:

if success

[ Top ]

get_Thread [line 113]

void &get_Thread(
)

Get Thread object

[ Top ]

load_from_Request [line 87]

boolean load_from_Request(
)

Load data from Request form fields.

API Tags:

Return:

true if loaded data seems valid.

[ Top ]

send_email_notifications [line 414]

boolean send_email_notifications(
[boolean
$new_thread = true] 
)

Send email notification to recipients on new thread or new message event.

Parameters:

boolean

$new_thread:

true if new thread, false if new message in the current thread

API Tags:

Return:

True if all messages could be sent, false if at least one error occurred.

[ Top ]

Multilingual multiuser multiblog engine

Class: Message

Class Message

Packages

Classes

Files