Message Class Reference

Inheritance diagram for Message:

Public Member Functions
	getSender ()
	getRecipients ()
	getNumRecipients ()
	markAsRead ($user_id)
	markAsUnread ($user_id)
	markAsAnswered ($user_id)
	isRead ($user_id=null)
	isAnswered ($user_id=null)
	permissionToRead ($user_id=null)
	getTags ($user_id=null)
	addTag ($tag, $user_id=null)
	removeTag ($tag, $user_id=null)
	getNumAttachments ()
	removeIfOrphaned ()
Public Member Functions inherited from SimpleORMap
	__construct ($id=null)
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toRawArray ($only_these_fields=null)
	toArrayRecursive ($only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $field)
	getDefaultValue ($field)
	setValue ($field, $value)
	__get ($field)
	__set ($field, $value)
	__isset ($field)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()
	count ()
	isField ($field)
	isRelation ($field)
	isAdditionalField ($field)
	isAliasField ($field)
	isI18nField ($field)
	setData ($data, $reset=false)
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	store ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	getPristineValue ($field)
	initRelation ($relation)
	resetRelation ($relation)
	cleanup ()

Static Public Member Functions
static	markAllAs ($user_id=null, $state_of_flag=1)
static	getUserTags ($user_id=null)
static	findNew ($user_id, $receiver=true, $since=0, $tag=null)
static	send ($sender, $recipients, $subject, $message)
static	exportUserData (StoredUserData $storage)
Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
static	expireTableScheme ()
static	exists ($id)
static	countBySql ($sql='1', $params=[])
static	create ($data)
static	build ($data, $is_new=true)
static	buildExisting ($data)
static	import ($data)
static	findBySQL ($sql, $params=[])
static	findOneBySQL ($where, $params=[])
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $sql, $params=[])
static	findMany ($pks=[], $order='', $order_params=[])
static	findEachMany ($callable, $pks=[], $order='', $order_params=[])
static	findAndMapBySQL ($callable, $where, $params=[])
static	findAndMapMany ($callable, $pks=[], $order='', $order_params=[])
static	deleteBySQL ($where, $params=[])
static	toObject ($id_or_object)
static	__callStatic (string $name, array $arguments)

Static Protected Member Functions
static	configure ($config=[])
Static Protected Member Functions inherited from SimpleORMap
static	db_table ()
static	db_fields ()
static	pk ()
static	default_values ()
static	serialized_fields ()
static	alias_fields ()
static	i18n_fields ()
static	additional_fields ()
static	has_many ()
static	has_one ()
static	belongs_to ()
static	has_and_belongs_to_many ()
static	registered_callbacks ()
static	known_slots ()
static	notification_map ()
static	getter_setter_map ()
static	configure ($config=[])
static	config ($key)
static	registerCallback ($types, $cb)
static	unregisterCallback ($types, $cb)

Additional Inherited Members
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'
Static Public Attributes inherited from SimpleORMap
static	$schemes = null
Protected Member Functions inherited from SimpleORMap
	_getId ($field)
	_setId ($field, $value)
	_getAdditionalValueFromRelation ($field)
	_setAdditionalValueFromRelation ($field, $value)
	_getAdditionalValue ($field)
	_setAdditionalValue ($field, $value)
	parseRelationOptions ($type, $name, $options)
	storeRelations ($only_these=null)
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	cbNotificationMapper ($cb_type)
	cbAfterInitialize ($cb_type)
	setSerializedValue ($field, $value)
	setI18nValue ($field, $value)
Protected Attributes inherited from SimpleORMap
	$content = []
	$content_db = []
	$is_new = true
	$is_deleted = false
	$relations = []
	$additional_data = []
Static Protected Attributes inherited from SimpleORMap
static	$config = []
static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']
static	$performs_batch_operation = false

Member Function Documentation

addTag()

addTag	(		$tag,
			$user_id = null
	)

configure()

static configure (   $config = [] )

staticprotected

exportUserData()

static exportUserData ( StoredUserData  $storage )

static

Export available data of a given user into a storage object (an instance of the StoredUserData class) for that user.

Parameters

StoredUserData

$storage

object to store data into

Implements PrivacyObject.

findNew()

static findNew (   $user_id,   $receiver = true,   $since = 0,   $tag = null  )

static

getNumAttachments()

getNumAttachments

(

)

getNumRecipients()

getNumRecipients

(

)

getRecipients()

getRecipients

(

)

getSender()

getSender

(

)

getTags()

getTags

(

$user_id = null

)

Returns all tags for the message for the given user.

Parameters

null

$user_id

: user-id of the user that tags should be related. null if it's the current user.

Returns

array of string : tags

getUserTags()

static getUserTags (   $user_id = null )

static

isAnswered()

isAnswered

(

$user_id = null

)

isRead()

isRead

(

$user_id = null

)

markAllAs()

static markAllAs (   $user_id = null,   $state_of_flag = 1  )

static

markAsAnswered()

markAsAnswered

(

$user_id

)

markAsRead()

markAsRead

(

$user_id

)

markAsUnread()

markAsUnread

(

$user_id

)

permissionToRead()

permissionToRead

(

$user_id = null

)

removeIfOrphaned()

removeIfOrphaned

(

)

Deletes the message if all references in message_user indicate 'deleted'

Returns

bool

removeTag()

removeTag	(		$tag,
			$user_id = null
	)

send()

static send (   $sender,   $recipients,   $subject,   $message  )

static

---

The documentation for this class was generated from the following file:

• lib/models/Message.class.php