ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilADTActiveRecordWrapper Class Reference

ADT Active Record service wrapper class. More...

+ Inheritance diagram for ilADTActiveRecordWrapper:
+ Collaboration diagram for ilADTActiveRecordWrapper:

Public Member Functions

 __construct (ilADTGroupActiveRecordBridge $a_properties)
 Constructor. More...
 
 getConnectorContainerName ()
 
 getPrimaryFieldValue ()
 
 sleep ($field_name)
 
 wakeUp ($field_name, $field_value)
 
- 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 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)
 

Protected Member Functions

 getActiveRecordFieldTypeFromMDB2 ($a_mdb2_type)
 
 initFieldList ()
 Get field list instance for ADT group. More...
 
- Protected Member Functions inherited from ActiveRecord
 serializeToCSV ($field)
 This method is called for every field of your instance if you use __asCsv. More...
 
 installDatabase ()
 

Protected Attributes

 $properties
 
 $fields
 
 $field_element_map
 
- Protected Attributes inherited from ActiveRecord
 $ar_safe_read = true
 
 $connector_container_name = ''
 

Additional Inherited Members

- Data Fields inherited from ActiveRecord
const ACTIVE_RECORD_VERSION = '2.0.7'
 
- Static Protected Member Functions inherited from ActiveRecord
static getCalledClass ()
 
static fromCamelCase ($str)
 

Detailed Description

ADT Active Record service wrapper class.

:TODO: EXPERIMENTAL!

This class expects a valid primary for all actions!

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilADTActiveRecordWrapper::__construct ( ilADTGroupActiveRecordBridge  $a_properties)

Constructor.

Parameters
ilADTGroupActiveRecordBridge$a_properties
Returns
self

Definition at line 29 of file class.ilADTActiveRecordWrapper.php.

References initFieldList().

30  {
31  $this->properties = $a_properties;
32 
33  // see ActiveRecord::__construct();
34  $this->initFieldList();
35  $this->arConnector = new arConnectorDB();
36  }
initFieldList()
Get field list instance for ADT group.
Class arConnectorDB.
Class arConnector.
+ Here is the call graph for this function:

Member Function Documentation

◆ getActiveRecordFieldTypeFromMDB2()

ilADTActiveRecordWrapper::getActiveRecordFieldTypeFromMDB2 (   $a_mdb2_type)
protected

Definition at line 43 of file class.ilADTActiveRecordWrapper.php.

References arField\FIELD_TYPE_DATE, arField\FIELD_TYPE_FLOAT, arField\FIELD_TYPE_INTEGER, arField\FIELD_TYPE_TEXT, and arField\FIELD_TYPE_TIMESTAMP.

Referenced by initFieldList().

44  {
45  // currently they are all the same
46  switch($a_mdb2_type)
47  {
48  case "integer":
50 
51  case "float":
53 
54  case "text":
56 
57  case "date":
59 
60  case "timestamp":
62 
63  case "integer":
65 
66  /*
67  case "clob":
68  return arField::FIELD_TYPE_CLOB;
69 
70  case "time":
71  return arField::FIELD_TYPE_TIME;
72  */
73  }
74  }
const FIELD_TYPE_FLOAT
const FIELD_TYPE_TEXT
const FIELD_TYPE_INTEGER
const FIELD_TYPE_DATE
const FIELD_TYPE_TIMESTAMP
+ Here is the caller graph for this function:

◆ getConnectorContainerName()

ilADTActiveRecordWrapper::getConnectorContainerName ( )

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

123  {
124  return $this->properties->getTableName();
125  }

◆ getPrimaryFieldValue()

ilADTActiveRecordWrapper::getPrimaryFieldValue ( )

Definition at line 132 of file class.ilADTActiveRecordWrapper.php.

133  {
134  $primary = array_shift($this->properties->getPrimary());
135  return $primary[1];
136  }

◆ initFieldList()

ilADTActiveRecordWrapper::initFieldList ( )
protected

Get field list instance for ADT group.

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

References $fields, fields, and getActiveRecordFieldTypeFromMDB2().

Referenced by __construct().

80  {
81  require_once "Services/ActiveRecord/classes/Fields/class.arFieldList.php";
82  $this->fields = new arFieldList();
83 
84  // element => fields
85 
86  $fields = array();
87  foreach($this->properties->getActiveRecordFields() as $element_id => $element_fields)
88  {
89  foreach($element_fields as $field)
90  {
91  $this->field_element_map[$field->getName()] = $element_id;
92  }
93 
94  $fields = array_merge($fields, $element_fields);
95  }
96 
97  $this->fields->setFields($fields);
98 
99  // primary
100 
101  if(sizeof($this->properties->getPrimary()) > 1)
102  {
103  throw new ilException("ilADTActiveRecordWrapper - no complex primary keys supported yet");
104  }
105 
106  foreach($this->properties->getPrimary() as $primary_id => $primary_element)
107  {
108  $field = new arField();
109  $field->setHasField(true);
110  $field->setNotNull(true);
111  $field->setFieldType($this->getActiveRecordFieldTypeFromMDB2($primary_element[0]));
112  $field->setName($primary_id);
113  $this->fields->setPrimaryField($field);
114  }
115  }
Class arField.
Base class for ILIAS Exception handling.
$errors fields
Definition: imgupload.php:48
Class arFieldList.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ returnDbTableName()

static ilADTActiveRecordWrapper::returnDbTableName ( )
static

Definition at line 127 of file class.ilADTActiveRecordWrapper.php.

128  {
129  // :TODO: cannot be static
130  }

◆ sleep()

ilADTActiveRecordWrapper::sleep (   $field_name)

Definition at line 143 of file class.ilADTActiveRecordWrapper.php.

144  {
145  if(array_key_exists($field_name, $this->field_element_map))
146  {
147  $element = $this->properties->getElement($this->field_element_map[$field_name]);
148  return $element->getFieldValue($field_name);
149  }
150 
151  // returning NULL would result in direct property access!
152  return false;
153  }

◆ wakeUp()

ilADTActiveRecordWrapper::wakeUp (   $field_name,
  $field_value 
)

Definition at line 155 of file class.ilADTActiveRecordWrapper.php.

156  {
157  if(array_key_exists($field_name, $this->field_element_map))
158  {
159  $element = $this->properties->getElement($this->field_element_map[$field_name]);
160  return $element->setFieldValue($field_name, $field_value);
161  }
162 
163  // returning NULL would result in direct property access!
164  return false;
165  }

Field Documentation

◆ $field_element_map

ilADTActiveRecordWrapper::$field_element_map
protected

Definition at line 21 of file class.ilADTActiveRecordWrapper.php.

◆ $fields

ilADTActiveRecordWrapper::$fields
protected

Definition at line 20 of file class.ilADTActiveRecordWrapper.php.

Referenced by initFieldList().

◆ $properties

ilADTActiveRecordWrapper::$properties
protected

Definition at line 19 of file class.ilADTActiveRecordWrapper.php.


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