ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
arStorage Class Reference

Class arStorage. More...

+ Inheritance diagram for arStorage:
+ Collaboration diagram for arStorage:

Public Member Functions

 create ()
 
 update ()
 
 read ()
 
 getValueForStorage ($key)
 
 setValueToModel ($key, $value)
 
 setExternalModelForStorage ($model)
 
 getExternalModelForStorage ()
 
- 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)
 

Protected Member Functions

 mapToActiveRecord ()
 
 mapFromActiveRecord ()
 
- 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

 $external_model_for_storage
 
- Protected Attributes inherited from ActiveRecord
 $ar_safe_read = true
 
 $connector_container_name = ''
 

Additional Inherited Members

- 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 inherited from ActiveRecord
const ACTIVE_RECORD_VERSION = '2.0.7'
 
- Static Protected Member Functions inherited from ActiveRecord
static getCalledClass ()
 
static fromCamelCase ($str)
 

Detailed Description

Class arStorage.

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.arStorage.php.

Member Function Documentation

◆ create()

arStorage::create ( )

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

References mapToActiveRecord().

43  {
44  $this->mapToActiveRecord();
45  parent::create();
46  }
+ Here is the call graph for this function:

◆ getExternalModelForStorage()

arStorage::getExternalModelForStorage ( )
Returns
arTestRecord

Definition at line 117 of file class.arStorage.php.

References $external_model_for_storage.

Referenced by getValueForStorage(), and setValueToModel().

117  {
119  }
+ Here is the caller graph for this function:

◆ getValueForStorage()

arStorage::getValueForStorage (   $key)
Parameters
$key
Returns
mixed

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

References getExternalModelForStorage().

Referenced by mapToActiveRecord().

80  {
81  $method = self::_toCamelCase('get_' . $key);
82 
83  return $this->getExternalModelForStorage()->{$method}();
84  }
getExternalModelForStorage()
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mapFromActiveRecord()

arStorage::mapFromActiveRecord ( )
protected

Definition at line 68 of file class.arStorage.php.

References ActiveRecord\getArFieldList(), ActiveRecord\getArrayForConnector(), and setValueToModel().

Referenced by read().

68  {
69  foreach (array_keys($this->getArFieldList()->getArrayForConnector()) as $key) {
70  $this->setValueToModel($key, $this->{$key});
71  }
72  }
setValueToModel($key, $value)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mapToActiveRecord()

arStorage::mapToActiveRecord ( )
protected

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

References ActiveRecord\getArFieldList(), ActiveRecord\getArrayForConnector(), and getValueForStorage().

Referenced by create(), and update().

61  {
62  foreach (array_keys($this->getArFieldList()->getArrayForConnector()) as $key) {
63  $this->{$key} = $this->getValueForStorage($key);
64  }
65  }
getValueForStorage($key)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ read()

arStorage::read ( )

Definition at line 55 of file class.arStorage.php.

References mapFromActiveRecord().

55  {
56  parent::read();
57  $this->mapFromActiveRecord();
58  }
+ Here is the call graph for this function:

◆ setExternalModelForStorage()

arStorage::setExternalModelForStorage (   $model)
Parameters
arTestRecord$model

Definition at line 109 of file class.arStorage.php.

109  {
110  $this->external_model_for_storage = $model;
111  }

◆ setValueToModel()

arStorage::setValueToModel (   $key,
  $value 
)
Parameters
$key
$value
Returns
mixed

Definition at line 93 of file class.arStorage.php.

References getExternalModelForStorage().

Referenced by mapFromActiveRecord().

93  {
94  $method = self::_toCamelCase('set_' . $key);
95 
96  return $this->getExternalModelForStorage()->{$method}($value);
97  }
getExternalModelForStorage()
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ update()

arStorage::update ( )

Definition at line 49 of file class.arStorage.php.

References mapToActiveRecord().

49  {
50  $this->mapToActiveRecord();
51  parent::update();
52  }
+ Here is the call graph for this function:

Field Documentation

◆ $external_model_for_storage

arStorage::$external_model_for_storage
protected

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

Referenced by getExternalModelForStorage().


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