Stud.IP  3.1 Revision 48552
 All Data Structures Namespaces Files Functions Variables Groups Pages
Message Class Reference
Inheritance diagram for Message:
Inheritance graph
Collaboration diagram for Message:
Collaboration graph

Public Member Functions

 getSender ()
 getRecipients ()
 getNumRecipients ()
 markAsRead ($user_id)
 markAsUnread ($user_id)
 isRead ($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)
 toArrayRecursive ($only_these_fields=null)
 getValue ($field)
 getRelationValue ($relation, $field)
 setValue ($field, $value)
 __get ($field)
 __set ($field, $value)
 __isset ($field)
 offsetExists ($offset)
 offsetGet ($offset)
 offsetSet ($offset, $value)
 offsetUnset ($offset)
 getIterator ()
 count ()
 isField ($field)
 isAdditionalField ($field)
 isAliasField ($field)
 setData ($data, $reset=false)
 haveData ()
 isNew ()
 isDeleted ()
 setNew ($is_new)
 getWhereQuery ()
 restore ()
 store ()
 triggerChdate ()
 delete ()
 isDirty ()
 isFieldDirty ($field)
 revertValue ($field)
 getPristineValue ($field)
 initRelation ($relation)
 resetRelation ($relation)

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 Public Member Functions inherited from SimpleORMap
static expireTableScheme ()
static find ($id)
static exists ($id)
static countBySql ($sql=1, $params=array())
static create ($data)
static build ($data, $is_new=true)
static buildExisting ($data)
static import ($data)
static findBySQL ($sql, $params=array())
static findByObject (SimpleORMap $object)
static findOneBySQL ($where, $params=array())
static findThru ($foreign_key_value, $options)
static findEachBySQL ($callable, $sql, $params=array())
static findMany ($pks=array(), $order= '', $order_params=array())
static findEachMany ($callable, $pks=array(), $order= '', $order_params=array())
static findAndMapBySQL ($callable, $where, $params=array())
static findAndMapMany ($callable, $pks=array(), $order= '', $order_params=array())
static deleteBySQL ($where, $params=array())
static toObject ($id_or_object)
static __callStatic ($name, $arguments)

Static Protected Member Functions

static configure ($config=array())
- Static Protected Member Functions inherited from SimpleORMap
static tableScheme ($db_table)

Additional Inherited Members

- 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)
 getTableScheme ()
 storeRelations ($only_these=null)
 deleteRelations ()
 initializeContent ()
 applyCallbacks ($type)
 registerCallback ($types, $cb)
 unregisterCallback ($types, $cb)
 cbAutoIncrementColumn ($type)
 cbAutoKeyCreation ()
 cbNotificationMapper ($cb_type)
 setSerializedValue ($field, $value)
- Protected Attributes inherited from SimpleORMap
 $content = array()
 $content_db = array()
 $is_new = true
 $db_table = ''
 $db_fields = null
 $pk = null
 $default_values = array()
 $serialized_fields = array()
 $alias_fields = array()
 $additional_fields = array()
 $relations = array()
 $has_many = array()
 $has_one = array()
 $belongs_to = array()
 $has_and_belongs_to_many = array()
 $registered_callbacks
 $known_slots = array()
 $reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')
 $notification_map = array()
 $additional_data = array()
- Static Protected Attributes inherited from SimpleORMap
static $schemes = null
static $config = array()

Member Function Documentation

addTag (   $tag,
  $user_id = null 
)

Here is the call graph for this function:

static configure (   $config = array())
staticprotected

set configuration data from subclass

Parameters
array$configconfiguration data
Returns
void

Reimplemented from SimpleORMap.

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

Here is the call graph for this function:

Here is the caller graph for this function:

getNumAttachments ( )
getNumRecipients ( )
getRecipients ( )

Here is the call graph for this function:

getSender ( )
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

Here is the call graph for this function:

static getUserTags (   $user_id = null)
static

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

markAsRead (   $user_id)

Here is the call graph for this function:

markAsUnread (   $user_id)
permissionToRead (   $user_id = null)
removeIfOrphaned ( )

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

Returns
bool
removeTag (   $tag,
  $user_id = null 
)

Here is the call graph for this function:

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

Here is the call graph for this function:


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