ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Attributes
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 ()
 __construct ($primary_key=0, $dev=false)
- 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)
 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 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.
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.
 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.

Constructor & Destructor Documentation

arMessage::__construct (   $primary_key = 0,
  $dev = false 
)
Parameters
int$primary_key
bool$dev

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

{
parent::__construct($primary_key, new arConnectorSession());
}

Member Function Documentation

arMessage::getBody ( )
Returns
mixed

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

References $body.

{
return $this->body;
}
arMessage::getPriority ( )
Returns
int

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

References $priority.

{
return $this->priority;
}
arMessage::getReceiverId ( )
Returns
int

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

References $receiver_id.

{
return $this->receiver_id;
}
arMessage::getSenderId ( )
Returns
int

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

References $sender_id.

{
return $this->sender_id;
}
arMessage::getTitle ( )
Returns
string

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

References $title.

{
return $this->title;
}
arMessage::getType ( )
Returns
int

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

References $type.

{
return $this->type;
}
static arMessage::returnDbTableName ( )
static
Returns
string

Reimplemented from ActiveRecord.

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

{
return 'ar_message';
}
arMessage::setBody (   $body)
Parameters
mixed$body

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

References $body.

{
$this->body = $body;
}
arMessage::setPriority (   $priority)
Parameters
int$priority

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

References $priority.

{
$this->priority = $priority;
}
arMessage::setReceiverId (   $receiver_id)
Parameters
int$receiver_id

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

References $receiver_id.

{
$this->receiver_id = $receiver_id;
}
arMessage::setSenderId (   $sender_id)
Parameters
int$sender_id

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

References $sender_id.

{
$this->sender_id = $sender_id;
}
arMessage::setTitle (   $title)
Parameters
string$title

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

References $title.

{
$this->title = $title;
}
arMessage::setType (   $type)
Parameters
int$type

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

References $type.

{
$this->type = $type;
}

Field Documentation

arMessage::$body = ''
protected

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

Referenced by getBody(), and setBody().

arMessage::$id
protected

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

arMessage::$priority = self::PRIO_NORMAL
protected

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

Referenced by getPriority(), and setPriority().

arMessage::$receiver_id = 0
protected

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

Referenced by getReceiverId(), and setReceiverId().

arMessage::$sender_id = 0
protected

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

Referenced by getSenderId(), and setSenderId().

arMessage::$title = ''
protected

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

Referenced by getTitle(), and setTitle().

arMessage::$type = self::TYPE_NEW
protected

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

Referenced by getType(), and setType().

const arMessage::PRIO_HIGH = 9

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

const arMessage::PRIO_LOW = 1

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

const arMessage::PRIO_NORMAL = 5

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

const arMessage::TYPE_NEW = 1

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

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: