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 @experimental @description

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.

                                                                                     {
                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();
                }
        }

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

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.

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

References getArFieldList().

Referenced by __asCsv().

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.

                                                                   {
                $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;
        }

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

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.

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

References getArFieldList().

Referenced by arConnectorSession\create().

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.

                                                  {
                // 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();
                }
        }

◆ __getConvertedDateFieldsAsArray()

ActiveRecord::__getConvertedDateFieldsAsArray ( $format = null )

Parameters

string $format

Returns: array

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

                                                                        {
                $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;
        }

References date, and getArFieldList().

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.

                                                                                  {
                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);
        }

Referenced by arViewField\__construct().

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.

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

◆ 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 ( )

Reimplemented in ilDclFieldProperty.

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

501 {

502 }

◆ buildFromArray()

ActiveRecord::buildFromArray ( array $array )

Parameters

array $array

Returns: $this

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

                                                     {
                $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;
        }

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

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.

                                          {
                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;
        }

References arException\COPY_DESTINATION_ID_EXISTS.

◆ count()

static ActiveRecord::count ( )

static

Returns: int

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

                                       {
                return self::affectedRows();
        }

Referenced by ilStudyProgrammeType\loadTranslation(), and ilStudyProgrammeType\processAndStoreIconFile().

Here is the caller graph for this function:

◆ create()

ActiveRecord::create ( )

Reimplemented in ilDclFieldProperty, and arStorage.

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

                                 {
                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);
        }

References arFieldCache\getPrimaryFieldName(), and arObjectCache\store().

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

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

Reimplemented in ilDclTableView.

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

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

References arObjectCache\purge().

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.

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

References arException\RECORD_NOT_FOUND.

Referenced by ilObjDefReader\handlerBeginTag().

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

@description 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.

                                                                                                      {
                $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;
                }
        }

Referenced by ilDclTableViewGUI\executeCommand().

Here is the caller graph for this function:

◆ first()

static ActiveRecord::first ( )

static

Returns: ActiveRecord

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

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

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

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.

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

◆ 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.

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

Referenced by ilBibliographicSetting\getAll(), ilStudyProgrammeType\getAllTypes(), and arConfigFormGUI\getValuesForItem().

Here is the caller graph for this function:

◆ getArConnector()

ActiveRecord::getArConnector ( )

Returns: \arConnectorDB

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

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

References arConnectorMap\get().

Referenced by arWhere\asSQLStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getArFieldList()

ActiveRecord::getArFieldList ( )

Returns: \arFieldList

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

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

References arFieldCache\get().

Referenced by __asArray(), __asCsv(), __asStdClass(), __getConvertedDateFieldsAsArray(), arWhere\asSQLStatement(), arConnectorDB\installDatabase(), arConnectorDB\updateDatabase(), and arConnectorDB\updateIndices().

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.

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

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

Here is the caller graph for this function:

◆ getArrayForConnector()

ActiveRecord::getArrayForConnector ( )

final

Returns: array

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

                                                     {
                $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;
        }

References $data.

Referenced by arConnectorDB\create(), and arConnectorDB\update().

Here is the caller graph for this function:

◆ getArrayForDb()

ActiveRecord::getArrayForDb ( )

final

Returns: array

Deprecated:

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

                                              {
                return $this->getArrayForConnector();
        }

◆ getCalledClass()

static ActiveRecord::getCalledClass ( )

staticprotected

Returns: ActiveRecord

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

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

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

References arCalledClassCache\get().

Referenced by getConnectorContainerName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCollection()

static ActiveRecord::getCollection ( )

static

Returns: ActiveRecordList

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

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

Referenced by arStorageRecordGUI\index().

Here is the caller graph for this function:

◆ getConnectorContainerName()

ActiveRecord::getConnectorContainerName ( )

Returns: string @description Return the Name of your Connector Table

Reimplemented in ilBibliographicSetting, ilOrgUnitPathStorage, arMixedKey, and ilADTActiveRecordWrapper.

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

                                                    {
                // 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();
                }
        }

References $connector_container_name, and getCalledClass().

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

Here is the call graph for this function:

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

Reimplemented in ilADTActiveRecordWrapper.

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

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

References arFieldCache\getPrimaryFieldName().

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

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.

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

References getConnectorContainerName().

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.

                                           {
                return $this->installDatabase();
        }

◆ installDatabase()

ActiveRecord::installDatabase ( )

finalprotected

Returns: bool

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

                                                   {
                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);
                }
        }

◆ 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.

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

Referenced by arConnectorDB\resetDatabase().

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.

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

References $start.

◆ orderBy()

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

static

Parameters

	$orderBy
string	$orderDirection

Returns: ActiveRecordList

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

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

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

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();
        }

References Assetic\Cache\get().

Here is the call graph for this function:

◆ 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 ( )

Reimplemented in arStorage.

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

                               {
                $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();
                }
        }

References $records, and arException\RECORD_NOT_FOUND.

Referenced by __construct().

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

arException

Deprecated:

Reimplemented in ilBibliographicSetting, ilDclFieldProperty, ilDclTableFieldSetting, ilDclTableView, ilDclTableViewFieldSetting, ilItemGroupAR, ilStudyProgramme, ilStudyProgrammeAdvancedMetadataRecord, ilStudyProgrammeAssignment, ilStudyProgrammeProgress, ilStudyProgrammeType, ilStudyProgrammeTypeTranslation, arConfig, arMessage, arUser, arMixedKey, arRealRecord, arStorageRecordStorage, ilADTActiveRecordWrapper, ilMemcacheServer, and ilWACSecurePath.

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

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

References arException\UNKNONWN_EXCEPTION.

◆ save()

ActiveRecord::save ( )

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

                               {
                $this->store();
        }

◆ 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.

                                                  {
                return null;
        }

Referenced by __asCsv().

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.

                                                                             {
                $this->connector_container_name = $connector_container_name;
        }

References $connector_container_name.

◆ setPrimaryFieldValue()

ActiveRecord::setPrimaryFieldValue ( $value )

Parameters

$value

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

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

References arFieldCache\getPrimaryFieldName().

Here is the call graph for this function:

◆ sleep()

ActiveRecord::sleep ( $field_name )

Parameters

$field_name

Returns: mixed

Reimplemented in ilDclTableView, ilDclTableViewFieldSetting, and ilADTActiveRecordWrapper.

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

                                           {
                return null;
        }

◆ store()

ActiveRecord::store ( )

Reimplemented in ilOrgUnitPathStorage.

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

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

References arFieldCache\getPrimaryFieldName().

Here is the call graph for this function:

◆ storeObjectToCache()

ActiveRecord::storeObjectToCache ( )

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

                                             {
                arObjectCache::store($this);
        }

References arObjectCache\store().

Here is the call graph for this function:

◆ tableExists()

static ActiveRecord::tableExists ( )

staticfinal

Returns: bool

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

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

◆ 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 ( )

Reimplemented in ilDclFieldProperty, and arStorage.

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

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

References arObjectCache\store().

Referenced by ilOrgUnitPathStorage\store().

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

Reimplemented in ilDclTableView, ilDclTableViewFieldSetting, and ilADTActiveRecordWrapper.

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

                                                          {
                return null;
        }

◆ where()

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

static

Parameters

	$where
null	$operator

Returns: ActiveRecordList

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

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

Referenced by ilStudyProgrammeUserProgress\__construct(), ilDclTableView\createFieldSetting(), ilStudyProgrammeTypeTranslation\deleteAllTranslations(), ilDclTableView\getAllForTableId(), ilStudyProgrammeType\getAssignedAdvancedMDRecords(), ilStudyProgrammeType\getAssignedStudyProgrammes(), ilObjStudyProgramme\getAssignmentsOf(), ilObjStudyProgramme\getAssignmentsRaw(), ilDclTableView\getCountForTableId(), ilDclCache\getFieldProperties(), ilDclBaseFieldModel\getFieldSettings(), ilDclTableView\getFieldSettings(), ilDclTableView\getFilterableFieldSettings(), ilDclTableFieldSetting\getInstance(), ilStudyProgrammeUserProgress\getInstanceForAssignment(), ilStudyProgrammeUserProgress\getInstancesForAssignment(), ilStudyProgrammeUserAssignment\getInstancesForProgram(), ilStudyProgrammeUserProgress\getInstancesForProgram(), ilStudyProgrammeUserProgress\getInstancesForUser(), ilStudyProgrammeUserAssignment\getInstancesOfUser(), ilDclTableHelper\getStandardViewsByVisibleTables(), ilDclTableView\getVisibleFields(), ilStudyProgrammeType\loadTranslation(), and ilDclCache\preloadFieldProperties().

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