Inheritance diagram for ActiveRecord:

Collaboration diagram for ActiveRecord:

Public Member Functions
	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	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	ACTIVE_RECORD_VERSION = '2.0.7'

Protected Member Functions
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...

	installDatabase ()

Static Protected Member Functions
static	getCalledClass ()

static	fromCamelCase ($str)

Protected Attributes
	$ar_safe_read = true

	$connector_container_name = ''

Detailed Description

Class ActiveRecord.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 2.0.7

Definition at line 24 of file class.ActiveRecord.php.

Constructor & Destructor Documentation

◆ __construct()

ActiveRecord::__construct	(		$primary_key = `0`,
		arConnector	$connector = `null`
	)

Parameters

int	$primary_key
arConnector	$connector

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

References arFieldCache\get(), read(), and arConnectorMap\register().

                                                                                      {
                 if ($connector == null) {
                         $connector = new arConnectorDB();
                 }
                 arConnectorMap::register($this, $connector);
 
                 $arFieldList = arFieldCache::get($this);
 
                 $key = $arFieldList->getPrimaryFieldName();
                 $this->{$key} = $primary_key;
                 if ($primary_key !== 0 AND $primary_key !== null AND $primary_key !== false) {
                         $this->read();
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ __asArray()

ActiveRecord::__asArray ( )

Returns: array

Definition at line 199 of file class.ActiveRecord.php.

References array, and getArFieldList().

Referenced by __asCsv().

                                     {
                 $return = array();
                 foreach ($this->getArFieldList()->getFields() as $field) {
                         $fieldname = $field->getName();
                         $return[$fieldname] = $this->{$fieldname};
                 }
 
                 return $return;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __asCsv()

ActiveRecord::__asCsv	(	$separator = `';'`,
		$header = `false`
	)

Parameters

string	$separator
bool	$header

Returns: string

Definition at line 162 of file class.ActiveRecord.php.

References $header, __asArray(), array, getArFieldList(), and serializeToCSV().

                                                                    {
                 $line = '';
                 if ($header) {
                         $line .= implode($separator, array_keys($this->getArFieldList()->getRawFields()));
                         $line .= "\n";
                 }
                 $array = array();
                 foreach ($this->__asArray() as $field_name => $value) {
                         $serialized = $this->serializeToCSV($field_name);
                         if ($serialized === null) {
                                 $array[$field_name] = $this->{$field_name};
                         } else {
                                 $array[$field_name] = $serialized;
                         }
                 }
                 $line .= implode($separator, array_values($array));
 
                 return $line;
         }

Here is the call graph for this function:

◆ __asSerializedObject()

ActiveRecord::__asSerializedObject ( )

Returns: string

Definition at line 227 of file class.ActiveRecord.php.

                                                {
                 return serialize($this);
         }

◆ __asStdClass()

ActiveRecord::__asStdClass ( )

Returns: stdClass

Definition at line 213 of file class.ActiveRecord.php.

References getArFieldList().

Referenced by arConnectorSession\create().

                                        {
                 $return = new stdClass();
                 foreach ($this->getArFieldList()->getFields() as $field) {
                         $fieldname = $field->getName();
                         $return->{$fieldname} = $this->{$fieldname};
                 }
 
                 return $return;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __call()

ActiveRecord::__call	(	$name,
		$arguments
	)

Parameters

$name
$arguments

Returns: array

Definition at line 862 of file class.ActiveRecord.php.

References array, and count().

                                                   {
                 // Getter
                 if (preg_match("/get([a-zA-Z]*)/u", $name, $matches) AND count($arguments) == 0) {
                         return $this->{self::fromCamelCase($matches[1])};
                 }
                 // Setter
                 if (preg_match("/set([a-zA-Z]*)/u", $name, $matches) AND count($arguments) == 1) {
                         $this->{self::fromCamelCase($matches[1])} = $arguments[0];
                 }
                 if (preg_match("/findBy([a-zA-Z]*)/u", $name, $matches) AND count($arguments) == 1) {
                         return self::where(array( self::fromCamelCase($matches[1]) => $arguments[0] ))->getFirst();
                 }
         }

Here is the call graph for this function:

◆ __getConvertedDateFieldsAsArray()

ActiveRecord::__getConvertedDateFieldsAsArray ( $format = null )

Parameters

string $format

Returns: array

Definition at line 136 of file class.ActiveRecord.php.

References array, date, and getArFieldList().

                                                                         {
                 $converted_dates = array();
                 foreach ($this->getArFieldList()->getFields() as $field) {
                         if ($field->isDateField()) {
                                 $name = $field->getName();
                                 $value = $this->{$name};
                                 $converted_dates[$name] = array(
                                         'unformatted' => $value,
                                         'unix'        => strtotime($value),
                                 );
                                 if ($format) {
                                         $converted_dates[$name]['formatted'] = date($format, strtotime($value));
                                 }
                         }
                 }
 
                 return $converted_dates;
         }

Here is the call graph for this function:

◆ _toCamelCase()

static ActiveRecord::_toCamelCase	(	$str,
		$capitalise_first_char = `false`
	)

static

Parameters

string	$str
bool	$capitalise_first_char

Returns: string

Definition at line 883 of file class.ActiveRecord.php.

Referenced by arViewField\__construct().

                                                                                   {
                 if ($capitalise_first_char) {
                         $str[0] = strtoupper($str[0]);
                 }
                 $func = create_function('$c', 'return strtoupper($c[1]);');
 
                 return preg_replace_callback('/_([a-z])/', $func, $str);
         }

Here is the caller graph for this function:

◆ additionalParams()

static ActiveRecord::additionalParams ( array $additional_params )

static

Parameters

array $additional_params

Returns: $this

Definition at line 555 of file class.ActiveRecord.php.

References array, arObjectCache\get(), and arObjectCache\isCached().

                                                                           {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
                 $srModelObjectList->additionalParams($additional_params);
 
                 return $srModelObjectList;
         }

Here is the call graph for this function:

◆ affectedRows()

static ActiveRecord::affectedRows ( )

static

Returns: int

Definition at line 741 of file class.ActiveRecord.php.

                                               {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->affectedRows();
         }

◆ afterObjectLoad()

ActiveRecord::afterObjectLoad ( )

Definition at line 501 of file class.ActiveRecord.php.

Referenced by buildFromArray(), and read().

501 {

502 }

Here is the caller graph for this function:

◆ buildFromArray()

ActiveRecord::buildFromArray ( array $array )

Parameters

array $array

Returns: $this

Definition at line 237 of file class.ActiveRecord.php.

References afterObjectLoad(), arObjectCache\get(), getArFieldList(), arObjectCache\isCached(), arObjectCache\store(), and wakeUp().

                                                      {
                 $class = get_class($this);
                 $primary = $this->getArFieldList()->getPrimaryFieldName();
                 $primary_value = $array[$primary];
                 if ($primary_value AND arObjectCache::isCached($class, $primary_value)) {
                         return arObjectCache::get($class, $primary_value);
                 }
                 foreach ($array as $field_name => $value) {
                         if ($this->wakeUp($field_name, $value) === null) {
                                 $this->{$field_name} = $value;
                         } else {
                                 $this->{$field_name} = $this->wakeUp($field_name, $value);
                         }
                 }
                 arObjectCache::store($this);
                 $this->afterObjectLoad();
 
                 return $this;
         }

Here is the call graph for this function:

◆ connector()

static ActiveRecord::connector ( arConnector $connector )

static

Parameters

arConnector $connector

Returns: ActiveRecordList

Definition at line 822 of file class.ActiveRecord.php.

                                                                  {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->connector($connector);
         }

◆ copy()

ActiveRecord::copy ( $new_id = 0 )

Parameters

int $new_id

Returns: ActiveRecord

Exceptions

arException

Definition at line 490 of file class.ActiveRecord.php.

References array, arException\COPY_DESTINATION_ID_EXISTS, and getArFieldList().

                                           {
                 if (self::where(array( $this->getArFieldList()->getPrimaryFieldName() => $new_id ))->hasSets()) {
                         throw new arException(arException::COPY_DESTINATION_ID_EXISTS);
                 }
                 $new_obj = clone($this);
                 $new_obj->setPrimaryFieldValue($new_id);
 
                 return $new_obj;
         }

Here is the call graph for this function:

◆ count()

static ActiveRecord::count ( )

static

Returns: int

Definition at line 751 of file class.ActiveRecord.php.

Referenced by __call(), ilStudyProgrammeType\getAllTypesArray(), ilStudyProgrammeType\getAvailableAdvancedMDRecords(), ilStudyProgrammeType\getIconPathByStudyProgrammObjId(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ilStudyProgrammeType\getTranslation(), ilStudyProgrammeType\loadTranslation(), ilStudyProgrammeType\processAndStoreIconFile(), and read().

                                        {
                 return self::affectedRows();
         }

Here is the caller graph for this function:

◆ create()

ActiveRecord::create ( )

Definition at line 473 of file class.ActiveRecord.php.

References getArConnector(), getArFieldList(), getArrayForConnector(), arFieldCache\getPrimaryFieldName(), and arObjectCache\store().

Referenced by ilDclTableViewFieldSetting\cloneStructure(), ilDclTableView\cloneStructure(), ilStudyProgrammeType\getAllTypesArray(), ilOrgUnitPathStorage\store(), and store().

                                  {
                 if ($this->getArFieldList()->getPrimaryField()->getSequence()) {
                         $primary_fieldname = arFieldCache::getPrimaryFieldName($this);
                         $this->{$primary_fieldname} = $this->getArConnector()->nextID($this);
                 }
 
                 $this->getArConnector()->create($this, $this->getArrayForConnector());
                 arObjectCache::store($this);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dateFormat()

static ActiveRecord::dateFormat ( $date_format = 'd.m.Y - H:i:s' )

static

Parameters

string $date_format

Returns: ActiveRecordList

Definition at line 716 of file class.ActiveRecord.php.

                                                                    :i:s') {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
                 $srModelObjectList->dateFormat($date_format);
 
                 return $srModelObjectList;
         }

◆ debug()

static ActiveRecord::debug ( )

static

Returns: ActiveRecordList

Definition at line 769 of file class.ActiveRecord.php.

                                        {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->debug();
         }

◆ delete()

ActiveRecord::delete ( )

Definition at line 532 of file class.ActiveRecord.php.

References getArConnector(), and arObjectCache\purge().

                                  {
                 $this->getArConnector()->delete($this);
                 arObjectCache::purge($this);
         }

Here is the call graph for this function:

◆ fieldExists()

static ActiveRecord::fieldExists ( $field_name )

staticfinal

Parameters

$field_name

Returns: bool

Definition at line 384 of file class.ActiveRecord.php.

                                                               {
                 return self::getCalledClass()->getArConnector()->checkFieldExists(self::getCalledClass(), $field_name);
         }

◆ findOrFail()

static ActiveRecord::findOrFail	(		$primary_key,
		array	$add_constructor_args = `array()`
	)

static

Tries to find the object and throws an Exception if object is not found, instead of returning null.

Parameters

	$primary_key
array	$add_constructor_args

Exceptions

arException

Returns: ActiveRecord

Definition at line 603 of file class.ActiveRecord.php.

References arException\RECORD_NOT_FOUND.

Referenced by ilObjDefReader\handlerBeginTag().

                                                                                                {
                 $obj = self::find($primary_key, $add_constructor_args);
                 if (is_null($obj)) {
                         throw new arException(arException::RECORD_NOT_FOUND);
                 }
 
                 return $obj;
         }

Here is the caller graph for this function:

◆ findOrGetInstance()

static ActiveRecord::findOrGetInstance	(		$primary_key,
		array	$add_constructor_args = `array()`
	)

static

Parameters

	$primary_key
array	$add_constructor_args	Returns an existing Object with given primary-key or a new Instance with given primary-key set but not yet created

Returns: ActiveRecord

Definition at line 621 of file class.ActiveRecord.php.

Referenced by ilDclTableViewGUI\executeCommand().

                                                                                                       {
                 $obj = self::find($primary_key, $add_constructor_args);
                 if ($obj !== null) {
                         return $obj;
                 } else {
                         $class_name = get_called_class();
                         $obj = arFactory::getInstance($class_name, 0, $add_constructor_args);
                         $obj->setPrimaryFieldValue($primary_key);
                         $obj->is_new = true;
                         $obj->storeObjectToCache();
 
                         return $obj;
                 }
         }

Here is the caller graph for this function:

◆ first()

static ActiveRecord::first ( )

static

Returns: ActiveRecord

Definition at line 779 of file class.ActiveRecord.php.

Referenced by ilDclTableView\createOrGetStandardView(), and ilDclTableViewFieldSetting\getInstance().

                                        {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->first();
         }

Here is the caller graph for this function:

◆ fixDateField()

ActiveRecord::fixDateField	(	$field_name,
		$value
	)

Parameters

$field_name
$value

Returns: string

Definition at line 263 of file class.ActiveRecord.php.

References getArConnector(), and getArFieldList().

                                                           {
                 if ($this->getArFieldList()->getFieldByName($field_name)->isDateField()) {
                         return $this->getArConnector()->fixDate($value);
                 }
 
                 return $value;
         }

Here is the call graph for this function:

◆ flushDB()

static ActiveRecord::flushDB ( )

staticfinal

Returns: bool

Definition at line 449 of file class.ActiveRecord.php.

                                                {
                 return self::truncateDB();
         }

◆ fromCamelCase()

static ActiveRecord::fromCamelCase ( $str )

staticprotected

Parameters

string $str

Returns: string

Definition at line 898 of file class.ActiveRecord.php.

                                                       {
                 $str[0] = strtolower($str[0]);
                 $func = create_function('$c', 'return "_" . strtolower($c[1]);');
 
                 return preg_replace_callback('/([A-Z])/', $func, $str);
         }

◆ get()

static ActiveRecord::get ( )

static

Returns: ActiveRecord[]

Definition at line 759 of file class.ActiveRecord.php.

Referenced by arConfigFormGUI\getValuesForItem().

                                      {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->get();
         }

Here is the caller graph for this function:

◆ getArConnector()

ActiveRecord::getArConnector ( )

Returns

Definition at line 40 of file class.ActiveRecord.php.

References arConnectorMap\get().

Referenced by arWhere\asSQLStatement(), create(), delete(), fixDateField(), installDatabase(), read(), and update().

                                          {
                 return arConnectorMap::get($this);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getArFieldList()

ActiveRecord::getArFieldList ( )

Returns

Definition at line 48 of file class.ActiveRecord.php.

References arFieldCache\get().

Referenced by __asArray(), __asCsv(), __asStdClass(), __getConvertedDateFieldsAsArray(), arWhere\asSQLStatement(), buildFromArray(), copy(), create(), fixDateField(), getArrayForConnector(), arConnectorDB\installDatabase(), installDatabase(), arStorage\mapFromActiveRecord(), arStorage\mapToActiveRecord(), arConnectorDB\updateDatabase(), and arConnectorDB\updateIndices().

                                          {
                 return arFieldCache::get($this);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getArray()

static ActiveRecord::getArray	(	$key = `null`,
		$values = `null`
	)

static

Parameters

null	$key
null	$values

Returns: array

Definition at line 847 of file class.ActiveRecord.php.

Referenced by ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), and ilMemcacheServerTableGUI\parseData().

                                                                      {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->getArray($key, $values);
         }

Here is the caller graph for this function:

◆ getArrayForConnector()

ActiveRecord::getArrayForConnector ( )

final

Returns: array

Definition at line 305 of file class.ActiveRecord.php.

References $data, array, getArFieldList(), and sleep().

Referenced by arConnectorDB\create(), create(), getArrayForDb(), arStorage\mapFromActiveRecord(), arStorage\mapToActiveRecord(), read(), and arConnectorDB\update().

                                                      {
                 $data = array();
                 foreach ($this->getArFieldList()->getFields() as $field) {
                         $field_name = $field->getName();
                         $sleeped = $this->sleep($field_name);
                         $var = ($sleeped === null) ? ($this->{$field_name}) : $sleeped;
                         $data[$field_name] = array( $field->getFieldType(), $var );
                 }
 
                 return $data;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getArrayForDb()

ActiveRecord::getArrayForDb ( )

final

Returns: array

Deprecated:

Definition at line 297 of file class.ActiveRecord.php.

References getArrayForConnector().

                                               {
                 return $this->getArrayForConnector();
         }

Here is the call graph for this function:

◆ getCalledClass()

static ActiveRecord::getCalledClass ( )

staticprotected

Returns: ActiveRecord

Returns an instance of the instatiated calling active record (needs to be done in static methods) : This should be cached somehow

Definition at line 330 of file class.ActiveRecord.php.

References arCalledClassCache\get().

                                                    {
                 $class = get_called_class();
 
                 return arCalledClassCache::get($class);
         }

Here is the call graph for this function:

◆ getCollection()

static ActiveRecord::getCollection ( )

static

Returns: ActiveRecordList

Definition at line 789 of file class.ActiveRecord.php.

Referenced by arStorageRecordGUI\index().

                                                {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList;
         }

Here is the caller graph for this function:

◆ getConnectorContainerName()

ActiveRecord::getConnectorContainerName ( )

Returns: string Return the Name of your Connector Table

Definition at line 66 of file class.ActiveRecord.php.

References $connector_container_name.

Referenced by ActiveRecordList\__construct(), arWhere\asSQLStatement(), arJoin\asStatementText(), arConnectorDB\checkFieldExists(), arConnectorDB\checkTableExists(), arConnectorDB\create(), ActiveRecordList\innerjoinAR(), innerjoinAR(), arConnectorDB\installDatabase(), arConnectorDB\nextID(), arConnectorDB\read(), arConnectorDB\removeField(), arConnectorDB\renameField(), arConnectorDB\resetDatabase(), arConnectorDB\truncateDatabase(), arConnectorDB\update(), arConnectorDB\updateDatabase(), and arConnectorDB\updateIndices().

                                                     {
                 // WILL BE ABSTRACT TO REPLACE returnDbTableName() IN NEXT VERSION
                 if ($this->connector_container_name) {
                         return $this->connector_container_name;
                 } else {
                         $ar = self::getCalledClass();
 
                         return $ar::returnDbTableName();
                 }
         }

Here is the caller graph for this function:

◆ getFirstFromLastQuery()

static ActiveRecord::getFirstFromLastQuery ( )

static

Returns: ActiveRecordList

Deprecated:

Definition at line 810 of file class.ActiveRecord.php.

                                                        {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->getFirstFromLastQuery();
         }

◆ getPrimaryFieldValue()

ActiveRecord::getPrimaryFieldValue ( )

Returns: mixed

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

References arFieldCache\getPrimaryFieldName().

Referenced by arConnectorSession\create(), arObjectCache\purge(), arConnectorSession\read(), arConnectorDB\read(), read(), arObjectCache\store(), store(), and arConnectorDB\update().

                                                {
                 $primary_fieldname = arFieldCache::getPrimaryFieldName($this);
 
                 return $this->{$primary_fieldname};
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ innerjoin()

static ActiveRecord::innerjoin	(	$tablename,
		$on_this,
		$on_external,
		$fields = `array( '*' )`,
		$operator = `'='`,
		$both_external = `false`
	)

static

Parameters

	$tablename
	$on_this
	$on_external
array	$fields
string	$operator

Returns: $this

Definition at line 674 of file class.ActiveRecord.php.

                                                                                                                                               {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->innerjoin($tablename, $on_this, $on_external, $fields, $operator, $both_external);
         }

◆ innerjoinAR()

static ActiveRecord::innerjoinAR	(	ActiveRecord	$ar,
			$on_this,
			$on_external,
			$fields = `array( '*' )`,
			$operator = `'='`,
			$both_external = `false`
	)

static

Parameters

ActiveRecord	$ar
	$on_this
	$on_external
array	$fields
string	$operator

Returns: $this

Definition at line 660 of file class.ActiveRecord.php.

References getConnectorContainerName().

                                                                                                                                                       {
                 return self::innerjoin($ar->getConnectorContainerName(), $on_this, $on_external, $fields, $operator, $both_external);
         }

Here is the call graph for this function:

◆ installConnector()

ActiveRecord::installConnector ( )

Returns: bool

Deprecated:: Do not use in Core DB-update.

Definition at line 355 of file class.ActiveRecord.php.

References installDatabase().

                                            {
                 return $this->installDatabase();
         }

Here is the call graph for this function:

◆ installDatabase()

ActiveRecord::installDatabase ( )

finalprotected

Returns: bool

Definition at line 402 of file class.ActiveRecord.php.

References array, getArConnector(), getArFieldList(), and tableExists().

Referenced by installConnector().

                                                    {
                 if (!$this->tableExists()) {
                         $fields = array();
                         foreach ($this->getArFieldList()->getFields() as $field) {
                                 $fields[$field->getName()] = $field->getAttributesForConnector();
                         }
 
                         return $this->getArConnector()->installDatabase($this, $fields);
                 } else {
                         return $this->getArConnector()->updateDatabase($this);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ installDB()

static ActiveRecord::installDB ( )

staticfinal

Returns: bool

Deprecated:: Do not use in Core DB-update. Please generate the manual installation script by using:

        $arBuilder = new arBuilder(new ilYourARBasedClass());
        $arBuilder->generateDBUpdateForInstallation();

Definition at line 345 of file class.ActiveRecord.php.

Referenced by arConnectorDB\resetDatabase().

                                                  {
                 return self::getCalledClass()->installDatabase();
         }

Here is the caller graph for this function:

◆ last()

static ActiveRecord::last ( )

static

Returns: ActiveRecord

Definition at line 799 of file class.ActiveRecord.php.

                                       {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->last();
         }

◆ leftjoin()

static ActiveRecord::leftjoin	(	$tablename,
		$on_this,
		$on_external,
		$fields = `array( '*' )`,
		$operator = `'='`,
		$both_external = `false`
	)

static

Parameters

	$tablename
	$on_this
	$on_external
array	$fields
string	$operator

Returns: $this

Definition at line 690 of file class.ActiveRecord.php.

                                                                                                                                              {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->leftjoin($tablename, $on_this, $on_external, $fields, $operator, $both_external);
         }

◆ limit()

static ActiveRecord::limit	(	$start,
		$end
	)

static

Parameters

$start
$end

Returns: ActiveRecordList

Definition at line 730 of file class.ActiveRecord.php.

References $start.

                                                    {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
                 $srModelObjectList->limit($start, $end);
 
                 return $srModelObjectList;
         }

◆ orderBy()

static ActiveRecord::orderBy	(	$orderBy,
		$orderDirection = `'ASC'`
	)

static

Parameters

	$orderBy
string	$orderDirection

Returns: ActiveRecordList

Definition at line 703 of file class.ActiveRecord.php.

Referenced by ilDclTableView\createOrGetStandardView(), and ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits().

                                                                           {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
                 $srModelObjectList->orderBy($orderBy, $orderDirection);
 
                 return $srModelObjectList;
         }

Here is the caller graph for this function:

◆ preloadObjects()

static ActiveRecord::preloadObjects ( )

static

Returns: ActiveRecord[]

Definition at line 545 of file class.ActiveRecord.php.

                                                 {
                 return self::get();
         }

◆ raw()

static ActiveRecord::raw ( $set_raw = true )

static

Parameters

bool $set_raw

Returns: ActiveRecordList

Definition at line 834 of file class.ActiveRecord.php.

                                                     {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
 
                 return $srModelObjectList->raw($set_raw);
         }

◆ read()

ActiveRecord::read ( )

Definition at line 505 of file class.ActiveRecord.php.

References $records, afterObjectLoad(), count(), getArConnector(), getArrayForConnector(), getPrimaryFieldValue(), arException\RECORD_NOT_FOUND, arObjectCache\store(), and wakeUp().

Referenced by __construct().

                                {
                 $records = $this->getArConnector()->read($this);
                 if (count($records) == 0 AND $this->ar_safe_read == true) {
                         throw new arException(arException::RECORD_NOT_FOUND, $this->getPrimaryFieldValue());
                 } elseif (count($records) == 0 AND $this->ar_safe_read == false) {
                         $this->is_new = true;
                 }
                 foreach ($records as $rec) {
                         foreach ($this->getArrayForConnector() as $k => $v) {
                                 if ($this->wakeUp($k, $rec->{$k}) === null) {
                                         $this->{$k} = $rec->{$k};
                                 } else {
                                         $this->{$k} = $this->wakeUp($k, $rec->{$k});
                                 }
                         }
                         arObjectCache::store($this);
                         $this->afterObjectLoad();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeDBField()

static ActiveRecord::removeDBField ( $field_name )

staticfinal

Parameters

$field_name

Returns: bool

Definition at line 394 of file class.ActiveRecord.php.

                                                                 {
                 return self::getCalledClass()->getArConnector()->removeField(self::getCalledClass(), $field_name);
         }

◆ renameDBField()

static ActiveRecord::renameDBField	(	$old_name,
		$new_name
	)

staticfinal

Parameters

$old_name
$new_name

Returns: bool

Definition at line 366 of file class.ActiveRecord.php.

                                                                          {
                 return self::getCalledClass()->getArConnector()->renameField(self::getCalledClass(), $old_name, $new_name);
         }

◆ resetDB()

static ActiveRecord::resetDB ( )

staticfinal

Returns: bool

Definition at line 433 of file class.ActiveRecord.php.

                                                {
                 return self::getCalledClass()->getArConnector()->resetDatabase(self::getCalledClass());
         }

◆ returnDbTableName()

static ActiveRecord::returnDbTableName ( )

static

Exceptions

Definition at line 57 of file class.ActiveRecord.php.

References arException\UNKNONWN_EXCEPTION.

                                                    {
                 throw new arException(arException::UNKNONWN_EXCEPTION, 'Implement getConnectorContainerName in your child-class');
         }

◆ save()

ActiveRecord::save ( )

Definition at line 468 of file class.ActiveRecord.php.

References store().

                                {
                 $this->store();
         }

Here is the call graph for this function:

◆ serializeToCSV()

ActiveRecord::serializeToCSV ( $field )

protected

This method is called for every field of your instance if you use __asCsv.

You can use it to customize your export into csv. (e.g. serialize an array).

Parameters

$field string

Returns: mixed

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

Referenced by __asCsv().

                                                   {
                 return null;
         }

Here is the caller graph for this function:

◆ setConnectorContainerName()

ActiveRecord::setConnectorContainerName ( $connector_container_name )

Parameters

string $connector_container_name

Definition at line 81 of file class.ActiveRecord.php.

References $connector_container_name.

                                                                              {
                 $this->connector_container_name = $connector_container_name;
         }

◆ setPrimaryFieldValue()

ActiveRecord::setPrimaryFieldValue ( $value )

Parameters

$value

Definition at line 99 of file class.ActiveRecord.php.

References arFieldCache\getPrimaryFieldName().

                                                      {
                 $primary_fieldname = arFieldCache::getPrimaryFieldName($this);
 
                 $this->{$primary_fieldname} = $value;
         }

Here is the call graph for this function:

◆ sleep()

ActiveRecord::sleep ( $field_name )

Parameters

$field_name

Returns: mixed

Definition at line 277 of file class.ActiveRecord.php.

Referenced by getArrayForConnector().

                                            {
                 return null;
         }

Here is the caller graph for this function:

◆ store()

ActiveRecord::store ( )

Definition at line 456 of file class.ActiveRecord.php.

References array, create(), arFieldCache\getPrimaryFieldName(), getPrimaryFieldValue(), and update().

Referenced by save().

                                 {
                 $primary_fieldname = arFieldCache::getPrimaryFieldName($this);
                 $primary_value = $this->getPrimaryFieldValue();
 
                 if (!self::where(array( $primary_fieldname => $primary_value ))->hasSets()) {
                         $this->create();
                 } else {
                         $this->update();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeObjectToCache()

ActiveRecord::storeObjectToCache ( )

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

References arObjectCache\store().

                                              {
                 arObjectCache::store($this);
         }

Here is the call graph for this function:

◆ tableExists()

static ActiveRecord::tableExists ( )

staticfinal

Returns: bool

Definition at line 374 of file class.ActiveRecord.php.

Referenced by installDatabase().

                                                    {
                 return self::getCalledClass()->getArConnector()->checkTableExists(self::getCalledClass());
         }

Here is the caller graph for this function:

◆ truncateDB()

static ActiveRecord::truncateDB ( )

staticfinal

Returns: bool

Definition at line 441 of file class.ActiveRecord.php.

                                                   {
                 return self::getCalledClass()->getArConnector()->truncateDatabase(self::getCalledClass());
         }

◆ update()

ActiveRecord::update ( )

Definition at line 526 of file class.ActiveRecord.php.

References getArConnector(), and arObjectCache\store().

Referenced by ilStudyProgrammeType\getAllTypesArray(), ilOrgUnitPathStorage\store(), and store().

                                  {
                 $this->getArConnector()->update($this);
                 arObjectCache::store($this);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateDB()

static ActiveRecord::updateDB ( )

staticfinal

Returns: bool

Definition at line 419 of file class.ActiveRecord.php.

                                                 {
                 if (!self::tableExists()) {
                         self::getCalledClass()->installDatabase();
 
                         return true;
                 }
 
                 return self::getCalledClass()->getArConnector()->updateDatabase(self::getCalledClass());
         }

◆ wakeUp()

ActiveRecord::wakeUp	(	$field_name,
		$field_value
	)

Parameters

$field_name
$field_value

Returns: mixed

Definition at line 288 of file class.ActiveRecord.php.

Referenced by buildFromArray(), and read().

                                                           {
                 return null;
         }

Here is the caller graph for this function:

◆ where()

static ActiveRecord::where	(	$where,
		$operator = `null`
	)

static

Parameters

	$where
null	$operator

Returns: ActiveRecordList

Definition at line 643 of file class.ActiveRecord.php.

Referenced by ilStudyProgrammeUserProgress\__construct(), ilDclTableView\createFieldSetting(), ilStudyProgrammeType\getAllTypesArray(), ilStudyProgrammeType\getAssignedAdvancedMDRecords(), ilStudyProgrammeType\getAssignedStudyProgrammes(), ilObjStudyProgramme\getAssignmentsOf(), ilObjStudyProgramme\getAssignmentsRaw(), ilStudyProgrammeType\getAvailableAdvancedMDRecords(), ilDclCache\getFieldProperties(), ilDclTableView\getFieldSettings(), ilDclBaseFieldModel\getFieldSettings(), ilDclTableView\getFilterableFieldSettings(), ilStudyProgrammeUserProgress\getInstanceForAssignment(), ilStudyProgrammeUserProgress\getInstancesForAssignment(), ilStudyProgrammeUserAssignment\getInstancesForProgram(), ilStudyProgrammeUserProgress\getInstancesForProgram(), ilStudyProgrammeUserProgress\getInstancesForUser(), ilStudyProgrammeUserAssignment\getInstancesOfUser(), ilDclTableHelper\getStandardViewsByVisibleTables(), ilStudyProgrammeType\getTranslation(), ilStudyProgrammeType\getTranslations(), ilDclTableView\getVisibleFields(), ilStudyProgrammeType\loadTranslation(), ilDclCache\preloadFieldProperties(), and ilOrgUnitPathStorage\store().

                                                                {
                 $srModelObjectList = new ActiveRecordList(self::getCalledClass());
                 $srModelObjectList->where($where, $operator);
 
                 return $srModelObjectList;
         }

Here is the caller graph for this function:

Field Documentation

◆ $ar_safe_read

ActiveRecord::$ar_safe_read = true

protected

Definition at line 30 of file class.ActiveRecord.php.

◆ $connector_container_name

ActiveRecord::$connector_container_name = ''

protected

Definition at line 34 of file class.ActiveRecord.php.

Referenced by getConnectorContainerName(), and setConnectorContainerName().

◆ ACTIVE_RECORD_VERSION

const ActiveRecord::ACTIVE_RECORD_VERSION = '2.0.7'

Definition at line 26 of file class.ActiveRecord.php.

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

Services/ActiveRecord/class.ActiveRecord.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __asArray()

◆ __asCsv()

◆ __asSerializedObject()

◆ __asStdClass()

◆ __call()

◆ __getConvertedDateFieldsAsArray()

◆ _toCamelCase()

◆ additionalParams()

◆ affectedRows()

◆ afterObjectLoad()

◆ buildFromArray()

◆ connector()

◆ copy()

◆ count()

◆ create()

◆ dateFormat()

◆ debug()

◆ delete()

◆ fieldExists()

◆ findOrFail()

◆ findOrGetInstance()

◆ first()

◆ fixDateField()

◆ flushDB()

◆ fromCamelCase()

◆ get()

◆ getArConnector()

◆ getArFieldList()

◆ getArray()

◆ getArrayForConnector()

◆ getArrayForDb()

◆ getCalledClass()

◆ getCollection()

◆ getConnectorContainerName()

◆ getFirstFromLastQuery()

◆ getPrimaryFieldValue()

◆ innerjoin()

◆ innerjoinAR()

◆ installConnector()

◆ installDatabase()

◆ installDB()

◆ last()

◆ leftjoin()

◆ limit()

◆ orderBy()

◆ preloadObjects()

◆ raw()

◆ read()

◆ removeDBField()

◆ renameDBField()

◆ resetDB()

◆ returnDbTableName()

◆ save()

◆ serializeToCSV()

◆ setConnectorContainerName()

◆ setPrimaryFieldValue()

◆ sleep()

◆ store()

◆ storeObjectToCache()

◆ tableExists()

◆ truncateDB()

◆ update()

◆ updateDB()

◆ wakeUp()

◆ where()

Field Documentation

◆ $ar_safe_read

◆ $connector_container_name

◆ ACTIVE_RECORD_VERSION