ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
arMessage Class Reference

Class arMessage. More...

+ Inheritance diagram for arMessage:
+ Collaboration diagram for arMessage:

Public Member Functions

 setBody ($body)
 
 getBody ()
 
 setPriority ($priority)
 
 getPriority ()
 
 setReceiverId ($receiver_id)
 
 getReceiverId ()
 
 setSenderId ($sender_id)
 
 getSenderId ()
 
 setTitle ($title)
 
 getTitle ()
 
 setType ($type)
 
 getType ()
 
- Public Member Functions inherited from ActiveRecord
 getArConnector ()
 
 getArFieldList ()
 
 getConnectorContainerName ()
 
 setConnectorContainerName ($connector_container_name)
 
 getPrimaryFieldValue ()
 
 setPrimaryFieldValue ($value)
 
 __construct ($primary_key=0, arConnector $connector=null)
 
 storeObjectToCache ()
 
 __getConvertedDateFieldsAsArray ($format=null)
 
 __asCsv ($separator=';', $header=false)
 
 __asArray ()
 
 __asStdClass ()
 
 __asSerializedObject ()
 
 buildFromArray (array $array)
 
 fixDateField ($field_name, $value)
 
 sleep ($field_name)
 
 wakeUp ($field_name, $field_value)
 
 getArrayForDb ()
 
 getArrayForConnector ()
 
 installConnector ()
 
 store ()
 
 save ()
 
 create ()
 
 copy ($new_id=0)
 
 afterObjectLoad ()
 
 read ()
 
 update ()
 
 delete ()
 
 __call ($name, $arguments)
 

Static Public Member Functions

static returnDbTableName ()
 
- Static Public Member Functions inherited from ActiveRecord
static returnDbTableName ()
 
static installDB ()
 
static renameDBField ($old_name, $new_name)
 
static tableExists ()
 
static fieldExists ($field_name)
 
static removeDBField ($field_name)
 
static updateDB ()
 
static resetDB ()
 
static truncateDB ()
 
static flushDB ()
 
static preloadObjects ()
 
static additionalParams (array $additional_params)
 
static findOrFail ($primary_key, array $add_constructor_args=array())
 Tries to find the object and throws an Exception if object is not found, instead of returning null. More...
 
static findOrGetInstance ($primary_key, array $add_constructor_args=array())
 
static where ($where, $operator=null)
 
static innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
 
static innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
 
static leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
 
static orderBy ($orderBy, $orderDirection='ASC')
 
static dateFormat ($date_format='d.m.Y - H:i:s')
 
static limit ($start, $end)
 
static affectedRows ()
 
static count ()
 
static get ()
 
static debug ()
 
static first ()
 
static getCollection ()
 
static last ()
 
static getFirstFromLastQuery ()
 
static connector (arConnector $connector)
 
static raw ($set_raw=true)
 
static getArray ($key=null, $values=null)
 
static _toCamelCase ($str, $capitalise_first_char=false)
 

Data Fields

const TYPE_NEW = 1
 
const TYPE_READ = 2
 
const PRIO_LOW = 1
 
const PRIO_NORMAL = 5
 
const PRIO_HIGH = 9
 
- Data Fields inherited from ActiveRecord
const ACTIVE_RECORD_VERSION = '2.0.7'
 

Protected Attributes

 $id
 
 $title = ''
 
 $body = ''
 
 $sender_id = 0
 
 $receiver_id = 0
 
 $priority = self::PRIO_NORMAL
 
 $type = self::TYPE_NEW
 
- Protected Attributes inherited from ActiveRecord
 $ar_safe_read = true
 
 $connector_container_name = ''
 

Additional Inherited Members

- Protected Member Functions inherited from ActiveRecord
 serializeToCSV ($field)
 This method is called for every field of your instance if you use __asCsv. More...
 
 installDatabase ()
 
- Static Protected Member Functions inherited from ActiveRecord
static getCalledClass ()
 
static fromCamelCase ($str)
 

Detailed Description

Class arMessage.

Author
Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Version
2.0.7

Definition at line 11 of file class.arMessage.php.

Member Function Documentation

◆ getBody()

arMessage::getBody ( )
Returns
mixed

Definition at line 104 of file class.arMessage.php.

References $body.

105  {
106  return $this->body;
107  }

◆ getPriority()

arMessage::getPriority ( )
Returns
int

Definition at line 122 of file class.arMessage.php.

References $priority.

123  {
124  return $this->priority;
125  }

◆ getReceiverId()

arMessage::getReceiverId ( )
Returns
int

Definition at line 140 of file class.arMessage.php.

References $receiver_id.

141  {
142  return $this->receiver_id;
143  }

◆ getSenderId()

arMessage::getSenderId ( )
Returns
int

Definition at line 158 of file class.arMessage.php.

References $sender_id.

159  {
160  return $this->sender_id;
161  }

◆ getTitle()

arMessage::getTitle ( )
Returns
string

Definition at line 176 of file class.arMessage.php.

References $title.

177  {
178  return $this->title;
179  }

◆ getType()

arMessage::getType ( )
Returns
int

Definition at line 194 of file class.arMessage.php.

References $type.

195  {
196  return $this->type;
197  }

◆ returnDbTableName()

static arMessage::returnDbTableName ( )
static
Returns
string

Definition at line 23 of file class.arMessage.php.

24  {
25  return 'ar_message';
26  }

◆ setBody()

arMessage::setBody (   $body)
Parameters
mixed$body

Definition at line 95 of file class.arMessage.php.

References $body.

96  {
97  $this->body = $body;
98  }

◆ setPriority()

arMessage::setPriority (   $priority)
Parameters
int$priority

Definition at line 113 of file class.arMessage.php.

References $priority.

114  {
115  $this->priority = $priority;
116  }

◆ setReceiverId()

arMessage::setReceiverId (   $receiver_id)
Parameters
int$receiver_id

Definition at line 131 of file class.arMessage.php.

References $receiver_id.

132  {
133  $this->receiver_id = $receiver_id;
134  }

◆ setSenderId()

arMessage::setSenderId (   $sender_id)
Parameters
int$sender_id

Definition at line 149 of file class.arMessage.php.

References $sender_id.

150  {
151  $this->sender_id = $sender_id;
152  }

◆ setTitle()

arMessage::setTitle (   $title)
Parameters
string$title

Definition at line 167 of file class.arMessage.php.

References $title.

168  {
169  $this->title = $title;
170  }

◆ setType()

arMessage::setType (   $type)
Parameters
int$type

Definition at line 185 of file class.arMessage.php.

References $type.

186  {
187  $this->type = $type;
188  }

Field Documentation

◆ $body

arMessage::$body = ''
protected

Definition at line 54 of file class.arMessage.php.

Referenced by getBody(), and setBody().

◆ $id

arMessage::$id
protected

Definition at line 38 of file class.arMessage.php.

◆ $priority

arMessage::$priority = self::PRIO_NORMAL
protected

Definition at line 80 of file class.arMessage.php.

Referenced by getPriority(), and setPriority().

◆ $receiver_id

arMessage::$receiver_id = 0
protected

Definition at line 71 of file class.arMessage.php.

Referenced by getReceiverId(), and setReceiverId().

◆ $sender_id

arMessage::$sender_id = 0
protected

Definition at line 62 of file class.arMessage.php.

Referenced by getSenderId(), and setSenderId().

◆ $title

arMessage::$title = ''
protected

Definition at line 46 of file class.arMessage.php.

Referenced by getTitle(), and setTitle().

◆ $type

arMessage::$type = self::TYPE_NEW
protected

Definition at line 89 of file class.arMessage.php.

Referenced by getType(), and setType().

◆ PRIO_HIGH

const arMessage::PRIO_HIGH = 9

Definition at line 17 of file class.arMessage.php.

◆ PRIO_LOW

const arMessage::PRIO_LOW = 1

Definition at line 15 of file class.arMessage.php.

◆ PRIO_NORMAL

const arMessage::PRIO_NORMAL = 5

Definition at line 16 of file class.arMessage.php.

◆ TYPE_NEW

const arMessage::TYPE_NEW = 1

Definition at line 13 of file class.arMessage.php.

◆ TYPE_READ

const arMessage::TYPE_READ = 2

Definition at line 14 of file class.arMessage.php.


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