Docs For Class Thread

Class Overview

Thread Class

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

DataObject
   |
   --Thread

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

array	$contacts_list	Unblocked contacts IDs lazy filled
mixed	$datemodified
integer	$num_unread_messages	Number unread messages
mixed	$recipients
array	$recipients_list	Recipients IDs lazy filled
mixed	$title

[ Top ]

Method Summary

Thread	Thread()	Constructor
boolean	check_perm()	Check permission on a persona
true	check_thread_recipient()	Check if user is recipient of the current thread
void	dbdelete()	Delete thread and dependencies from database
contacts	load_contacts()	Load all of the non blocked contacts of current thread
boolean	load_from_Request()	Load data from Request form fields.
recipients	load_recipients()	Load recipients of the current thread
void	param_check__recipients()	Check are recipients available in database
boolean	set()	Set param value

[ Top ]

Properties

array $contacts_list [line 58]

Unblocked contacts IDs lazy filled

[ Top ]

mixed $datemodified [line 36]

[ Top ]

integer $num_unread_messages [line 43]

Number unread messages

[ Top ]

mixed $recipients = '' [line 37]

[ Top ]

array $recipients_list [line 50]

Recipients IDs lazy filled

[ Top ]

mixed $title = '' [line 35]

[ Top ]

Methods

Constructor Thread [line 65]

Thread Thread(
[db_row
$db_row = NULL] 
)

Constructor

Parameters:

db_row

$db_row:

database row

[ Top ]

check_perm [line 299]

boolean check_perm(

$action, [
$assert = true] 
)

Check permission on a persona

Parameters:

	$action:
	$assert:

API Tags:

Return:

true if granted

[ Top ]

check_thread_recipient [line 313]

true check_thread_recipient(
user
$user_ID 
)

Check if user is recipient of the current thread

Parameters:

user

$user_ID:

ID

API Tags:

Return:

is user is recipient, instead false

[ Top ]

dbdelete [line 206]

void dbdelete(
)

Delete thread and dependencies from database

Redefinition of:

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

[ Top ]

load_contacts [line 266]

contacts load_contacts(
)

Load all of the non blocked contacts of current thread

[ Top ]

load_from_Request [line 86]

boolean load_from_Request(
)

Load data from Request form fields.

API Tags:

Return:

true if loaded data seems valid.

[ Top ]

load_recipients [line 239]

recipients load_recipients(
)

Load recipients of the current thread

API Tags:

Return:

list

[ Top ]

param_check__recipients [line 133]

void param_check__recipients(
string
$var, 
$recipients 
)

Check are recipients available in database

Parameters:

string	$var:	recipients
	$recipients:

[ Top ]

set [line 114]

boolean set(
string
$parname, mixed
$parvalue, [boolean
$make_null = false] 
)

Set param value

By default, all values will be considered strings

Parameters:

string	$parname:	parameter name
mixed	$parvalue:	parameter value
boolean	$make_null:	true to set to NULL if empty value

API Tags:

Return:

true, if a value has been set; false if it has not changed

Redefinition of:

DataObject::set(): Set param value

[ Top ]

Multilingual multiuser multiblog engine

Class: Thread

Class Thread

Packages

Classes

Files