ActiveRecord Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ActiveRecord:

Collaboration diagram for ActiveRecord:

Public Member Functions
	getArConnector ()
	getArFieldList ()
	getConnectorContainerName ()
	Return the Name of your Connector Table More...
	setConnectorContainerName (string $connector_container_name)
	getPrimaryFieldValue ()
	setPrimaryFieldValue ($value)
	__construct (mixed $primary_key=0)
	storeObjectToCache ()
	asStdClass ()
	asArray ()
	buildFromArray (array $array)
	fixDateField ($field_name, string $value)
	sleep ($field_name)
	wakeUp ($field_name, $field_value)
	getArrayForConnector ()
	installConnector ()
	store ()
	save ()
	create ()
	copy (int $new_id=0)
	afterObjectLoad ()
	read ()
	update ()
	delete ()
	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()
static	installDB ()
static	renameDBField (string $old_name, string $new_name)
static	tableExists ()
static	fieldExists (string $field_name)
static	removeDBField (string $field_name)
static	updateDB ()
static	resetDB ()
static	truncateDB ()
static	flushDB ()
	never use in ILIAS Core, Plugins only More...
static	preloadObjects ()
static	additionalParams (array $additional_params)
static	findOrFail ($primary_key, array $add_constructor_args=[])
	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=[])
static	where ($where, $operator=null)
static	innerjoinAR (ActiveRecord $activeRecord, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
static	innerjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
static	leftjoin (string $tablename, $on_this, string $on_external, array $fields=[' *'], string $operator='=', bool $both_external=false)
static	orderBy (string $orderBy, string $orderDirection='ASC')
static	dateFormat (string $date_format='d.m.Y - H:i:s')
static	limit (int $start, int $end)
static	affectedRows ()
static	count ()
static	get ()
static	debug ()
static	first ()
static	getCollection ()
static	last ()
static	getFirstFromLastQuery ()
static	connector (arConnector $arConnector)
static	raw (bool $set_raw=true)
static	getArray (?string $key=null, string|array|null $values=null)
static	_toCamelCase (string $str, bool $capitalise_first_char=false)

Protected Member Functions
	installDatabase ()

Static Protected Member Functions
static	getCalledClass ()
	Returns an instance of the instatiated calling active record (needs to be done in static methods) : This should be cached somehow More...
static	fromCamelCase (string $str)

Protected Attributes
bool	$ar_safe_read = true
string	$connector_container_name = ''
bool	$is_new = true

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning This service is now deprecated and will be removed with ILIAS 12 or 13 (depending on how quickly users can replace their implementations). The ActiveRecord was a simple way of handling database operations and object mapping in its day. However, the pattern is not very lightweight and has a very large overhead. It also leads to many database queries and high memory consumption. For several releases now, the “Repository Pattern” has been propagated as a better alternative.

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

Constructor & Destructor Documentation

__construct()

ActiveRecord::__construct

(

mixed

$primary_key = 0

)

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

References arFieldCache\get(), null, and read().

    {
        $arFieldList = arFieldCache::get($this);

        $primaryFieldName = $arFieldList->getPrimaryFieldName();
        $this->{$primaryFieldName} = $primary_key;
        if ($primary_key === 0) {
            return;
        }
        if ($primary_key === null) {
            return;
        }
        if ($primary_key === false) {
            return;
        }
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

__call()

ActiveRecord::__call	(		$name,
			$arguments
	)

Parameters

$name
$arguments

Returns

mixed PhpInconsistentReturnPointsInspection since this a dynamic call

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

References count(), and null.

    {
        // Getter
        if (preg_match("/get([a-zA-Z]*)/u", (string) $name, $matches) && (is_countable($arguments) ? count(
            $arguments
        ) : 0) === 0) {
            return $this->{self::fromCamelCase($matches[1])};
        }
        // Setter
        if (!preg_match("/set([a-zA-Z]*)/u", (string) $name, $matches)) {
            return null;
        }
        if (count($arguments) !== 1) {
            return null;
        }
        $this->{self::fromCamelCase($matches[1])} = $arguments[0];
        return null;
    }

Here is the call graph for this function:

_toCamelCase()

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

static

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

References $c.

                                                                                         : ?string
    {
        if ($capitalise_first_char) {
            $str[0] = strtoupper($str[0]);
        }

        return preg_replace_callback('/_([a-z])/', fn($c): string => strtoupper($c[1]), $str);
    }

additionalParams()

static ActiveRecord::additionalParams ( array  $additional_params )

static

Returns

$this

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

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

                                                                     : \ActiveRecordList
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());
        $activeRecordList->additionalParams($additional_params);

        return $activeRecordList;
    }

Here is the call graph for this function:

affectedRows()

static ActiveRecord::affectedRows ( )

static

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

                                         : int
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->affectedRows();
    }

afterObjectLoad()

ActiveRecord::afterObjectLoad

(

)

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

                                     : void
    {
    }

asArray()

ActiveRecord::asArray

(

)

Returns

array<string, mixed>

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

References getArFieldList().

Referenced by arConnectorCache\storeActiveRecordInCache().

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

        return $return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

asStdClass()

ActiveRecord::asStdClass

(

)

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

References getArFieldList().

Referenced by arConnectorSession\create().

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

        return $return;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildFromArray()

ActiveRecord::buildFromArray

(

array

$array

)

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

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

                                                : static
    {
        $class = static::class;
        $primary = $this->getArFieldList()->getPrimaryFieldName();
        $primary_value = $array[$primary];
        if ($primary_value && arObjectCache::isCached($class, $primary_value)) {
            return arObjectCache::get($class, $primary_value);
        }
        foreach ($array as $field_name => $value) {
            $waked = $this->wakeUp($field_name, $value);
            $this->{$field_name} = $waked ?? $value;
        }
        arObjectCache::store($this);

        return $this;
    }

Here is the call graph for this function:

connector()

static ActiveRecord::connector ( arConnector  $arConnector )

static

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

                                                              : \ActiveRecordList
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->connector($arConnector);
    }

copy()

ActiveRecord::copy

(

int

$new_id = 0

)

Exceptions

arException

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

References arException\COPY_DESTINATION_ID_EXISTS, and getArFieldList().

                                         : self
    {
        if (self::where([$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

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

Referenced by __call(), ilAccessibilityDocument\buildFromArray(), ilAccessibilityDocument\detachCriterion(), and ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits().

                                  : int
    {
        return self::affectedRows();
    }

Here is the caller graph for this function:

create()

ActiveRecord::create

(

)

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

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

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

                            : void
    {
        if ($this->getArFieldList()->getPrimaryField()->getSequence()) {
            $primary_fieldname = arFieldCache::getPrimaryFieldName($this);
            $this->{$primary_fieldname} = $this->getArConnector()->nextID($this);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

dateFormat()

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

static

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

                                                                      :i:s'): \ActiveRecordList
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());
        $activeRecordList->dateFormat($date_format);

        return $activeRecordList;
    }

debug()

static ActiveRecord::debug ( )

static

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

                                  : \ActiveRecordList
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->debug();
    }

delete()

ActiveRecord::delete

(

)

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

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

Referenced by ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getValueContainerId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

fieldExists()

static ActiveRecord::fieldExists ( string  $field_name )

staticfinal

Parameters

$field_name

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

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

findOrFail()

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

static

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

Parameters

$primary_key

Exceptions

arException

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

References arException\RECORD_NOT_FOUND.

Referenced by ilSecurePathDefinitionProcessor\beginTag(), ilBiblLibraryFactory\findById(), ilBiblTranslationFactory\findById(), ilADNNotificationGUI\getNotificationsFromRequest(), and ilBiblFieldFactory\getType().

                                                                                     : \ActiveRecord
    {
        $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 = []  )

static

Parameters

$primary_key

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

Returns

|object|void

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

References null.

                                                                                            : \ActiveRecord
    {
        $obj = self::find($primary_key, $add_constructor_args);
        if ($obj !== null) {
            return $obj;
        }

        $class_name = static::class;
        $obj = arFactory::getInstance($class_name, 0, $add_constructor_args);
        $obj->setPrimaryFieldValue($primary_key);
        $obj->is_new = true;
        $obj->storeObjectToCache();

        return $obj;
    }

first()

static ActiveRecord::first ( )

static

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

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

                                  : ?\ActiveRecord
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->first();
    }

Here is the caller graph for this function:

fixDateField()

ActiveRecord::fixDateField	(		$field_name,
		string	$value
	)

Parameters

$field_name
$value

Returns

string|mixed NullPointerExceptionInspection

Definition at line 167 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

never use in ILIAS Core, Plugins only

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

Referenced by ilMMTopItemGUI\restore().

                                          : void
    {
        self::truncateDB();
    }

Here is the caller graph for this function:

fromCamelCase()

static ActiveRecord::fromCamelCase ( string  $str )

staticprotected

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

References $c.

                                                        : ?string
    {
        $str[0] = strtolower($str[0]);

        return preg_replace_callback('/([A-Z])/', fn($c): string => "_" . strtolower($c[1]), $str);
    }

get()

static ActiveRecord::get ( )

static

Returns

ActiveRecord[]

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

Referenced by ilBiblLibraryFactory\getAll(), ILIAS\GlobalScreen\ADNProvider\getNotifications(), and ilADNNotificationGUI\getNotificationsFromRequest().

                                : array
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->get();
    }

Here is the caller graph for this function:

getArConnector()

ActiveRecord::getArConnector

(

)

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

References arConnectorMap\get().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getArFieldList()

ActiveRecord::getArFieldList

(

)

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

References arFieldCache\get().

Referenced by asArray(), arWhere\asSQLStatement(), asStdClass(), buildFromArray(), CachedActiveRecord\buildHash(), copy(), create(), fixDateField(), getArrayForConnector(), CachedActiveRecord\getCacheIdentifier(), arConnectorDB\installDatabase(), installDatabase(), arConnectorDB\updateDatabase(), and arConnectorDB\updateIndices().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getArray()

static ActiveRecord::getArray ( ?string  $key = null, string|array|null  $values = null  )

static

Parameters

null

$values

Returns

mixed[]|mixed[][]|int[]|string[]|null[]

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

Referenced by ilMMAbstractBaseTypeHandlerAction\__construct(), ilMMItemInformation\__construct(), ILIAS\AdministrativeNotification\DataRetrieval\getRecords(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), and ILIAS\AdministrativeNotification\DataRetrieval\getTotalRowCount().

                                                                                          : array
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->getArray($key, $values);
    }

Here is the caller graph for this function:

getArrayForConnector()

ActiveRecord::getArrayForConnector ( )

final

Returns

array<string, mixed[]>

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

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

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

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

        return $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCalledClass()

static ActiveRecord::getCalledClass ( )

staticprotected

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

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

References arCalledClassCache\get().

                                              : \ActiveRecord
    {
        $class = static::class;

        return arCalledClassCache::get($class);
    }

Here is the call graph for this function:

getCollection()

static ActiveRecord::getCollection ( )

static

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

Referenced by ilDclTableViewBaseDefaultValue\findAll(), and ilBiblFieldFactory\getCollectionForFilter().

                                          : \ActiveRecordList
    {
        return new ActiveRecordList(self::getCalledClass());
        ;
    }

Here is the caller graph for this function:

getConnectorContainerName()

ActiveRecord::getConnectorContainerName

(

)

Return the Name of your Connector Table

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

References $connector_container_name.

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

                                               : string
    {
        // WILL BE ABSTRACT TO REPLACE returnDbTableName() IN NEXT VERSION
        if ($this->connector_container_name !== '' && $this->connector_container_name !== '0') {
            return $this->connector_container_name;
        }

        $ar = self::getCalledClass();

        return $ar::returnDbTableName();
    }

Here is the caller graph for this function:

getFirstFromLastQuery()

static ActiveRecord::getFirstFromLastQuery ( )

static

Deprecated:

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

                                                  : ?\ActiveRecord
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->getFirstFromLastQuery();
    }

getPrimaryFieldValue()

ActiveRecord::getPrimaryFieldValue

(

)

Returns

mixed

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

References arFieldCache\getPrimaryFieldName().

Referenced by arConnectorCache\buildCacheKey(), arConnectorSession\create(), CachedActiveRecord\getCacheIdentifier(), 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 ( string  $tablename,   $on_this, string  $on_external, array  $fields = ['*'], string  $operator = '=', bool  $both_external = false  )

static

Parameters

$tablename
$on_this
$on_external

Returns

$this

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

     : \ActiveRecordList {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->innerjoin($tablename, $on_this, $on_external, $fields, $operator, $both_external);
    }

innerjoinAR()

static ActiveRecord::innerjoinAR ( ActiveRecord  $activeRecord,   $on_this, string  $on_external, array  $fields = ['*'], string  $operator = '=', bool  $both_external = false  )

static

Parameters

$on_this
$on_external

Returns

$this

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

References getConnectorContainerName().

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

Here is the call graph for this function:

installConnector()

ActiveRecord::installConnector

(

)

Deprecated:

Do not use in Core DB-update.

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

References installDatabase().

                                      : bool
    {
        return $this->installDatabase();
    }

Here is the call graph for this function:

installDatabase()

ActiveRecord::installDatabase ( )

finalprotected

Deprecated:

never use in ILIAS Core, Plugins only

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

References getArConnector(), and getArFieldList().

Referenced by installConnector().

                                              : bool
    {
        if (!self::tableExists()) {
            $fields = [];
            foreach ($this->getArFieldList()->getFields() as $arField) {
                $fields[$arField->getName()] = $arField->getAttributesForConnector();
            }

            return $this->getArConnector()->installDatabase($this, $fields);
        }

        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

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 233 of file class.ActiveRecord.php.

Referenced by arConnectorDB\resetDatabase().

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

Here is the caller graph for this function:

last()

static ActiveRecord::last ( )

static

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

                                 : ?\ActiveRecord
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->last();
    }

leftjoin()

static ActiveRecord::leftjoin ( string  $tablename,   $on_this, string  $on_external, array  $fields = ['*'], string  $operator = '=', bool  $both_external = false  )

static

Parameters

$tablename
$on_this
$on_external

Returns

$this

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

     : \ActiveRecordList {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->leftjoin($tablename, $on_this, $on_external, $fields, $operator, $both_external);
    }

limit()

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

static

Parameters

$start
$end

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

                                                      : \ActiveRecordList
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());
        $activeRecordList->limit($start, $end);

        return $activeRecordList;
    }

orderBy()

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

static

Parameters

$orderBy

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

Referenced by ilDclTableView\createOrGetStandardView(), ilAccessibilityDocumentTableDataProvider\getList(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ilDclSelectionOption\getValues(), ilInitialisation\initAccessibilityControlConcept(), and ilAccessibilityDocumentFormGUI\saveObject().

                                                                                   : \ActiveRecordList
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());
        $activeRecordList->orderBy($orderBy, $orderDirection);

        return $activeRecordList;
    }

Here is the caller graph for this function:

preloadObjects()

static ActiveRecord::preloadObjects ( )

static

Returns

ActiveRecord[]

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

References ILIAS\GlobalScreen\get().

                                           : array
    {
        return self::get();
    }

Here is the call graph for this function:

raw()

static ActiveRecord::raw ( bool  $set_raw = true )

static

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

                                                    : \ActiveRecordList
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());

        return $activeRecordList->raw($set_raw);
    }

read()

ActiveRecord::read

(

)

Exceptions

arException

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

References getArConnector(), getArrayForConnector(), getPrimaryFieldValue(), null, arException\RECORD_NOT_FOUND, arObjectCache\store(), and wakeUp().

Referenced by __construct().

                          : void
    {
        $records = $this->getArConnector()->read($this);
        if ($this->ar_safe_read && is_array($records) && $records === []) {
            throw new arException(arException::RECORD_NOT_FOUND, $this->getPrimaryFieldValue());
        }
        if (!$this->ar_safe_read && is_array($records) && $records === []) {
            $this->is_new = true;
        }
        $records = is_array($records) ? $records : [];
        foreach ($records as $record) {
            foreach (array_keys($this->getArrayForConnector()) as $k) {
                $waked = $this->wakeUp($k, $record->{$k} ?? null);
                $this->{$k} = $waked ?? $record->{$k} ?? null;
            }
            arObjectCache::store($this);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeDBField()

static ActiveRecord::removeDBField ( string  $field_name )

staticfinal

Deprecated:

never use in ILIAS Core, Plugins only

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

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

renameDBField()

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

staticfinal

Parameters

$old_name
$new_name

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

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

resetDB()

static ActiveRecord::resetDB ( )

staticfinal

Deprecated:

never use in ILIAS Core, Plugins only

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

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

returnDbTableName()

static ActiveRecord::returnDbTableName ( )

static

Returns

never

Exceptions

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

References arException\UNKNONWN_EXCEPTION.

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

save()

ActiveRecord::save

(

)

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

References store().

Referenced by ilExAssTypeWikiTeam\cloneSpecificProperties(), and ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveTask().

                          : void
    {
        $this->store();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setConnectorContainerName()

ActiveRecord::setConnectorContainerName

(

string

$connector_container_name

)

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

References $connector_container_name.

                                                                               : void
    {
        $this->connector_container_name = $connector_container_name;
    }

setPrimaryFieldValue()

ActiveRecord::setPrimaryFieldValue

(

$value

)

Parameters

$value

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

References arFieldCache\getPrimaryFieldName().

                                                : void
    {
        $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

null

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

References null.

Referenced by getArrayForConnector(), and ilADNNotification\wakeUp().

    {
        return null;
    }

Here is the caller graph for this function:

store()

ActiveRecord::store

(

)

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

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

Referenced by save().

                           : void
    {
        $primary_fieldname = arFieldCache::getPrimaryFieldName($this);
        $primary_value = $this->getPrimaryFieldValue();

        if (!self::where([$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 114 of file class.ActiveRecord.php.

References arObjectCache\store().

                                        : void
    {
        arObjectCache::store($this);
    }

Here is the call graph for this function:

tableExists()

static ActiveRecord::tableExists ( )

staticfinal

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

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

truncateDB()

static ActiveRecord::truncateDB ( )

staticfinal

Deprecated:

never use in ILIAS Core, Plugins only

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

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

update()

ActiveRecord::update

(

)

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

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

Referenced by ilAccessibilityDocument\buildFromArray(), ilOrgUnitPathStorage\store(), and store().

                            : void
    {
        $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

Deprecated:

never use in ILIAS Core, Plugins only

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

                                           : bool
    {
        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

null

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

References null.

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

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

Referenced by ILIAS\MainMenu\Provider\CustomMainBarProvider\__construct(), ilDclTableView\createFieldSetting(), ilMMAbstractItemFacade\deleteAssociatedTranslations(), ilBiblEntryFactory\deleteEntryById(), ilAccessibilityDocument\detachCriterion(), ilObjBibliographic\doCreate(), ilBiblFieldFilterFactory\filterItemsForTable(), ilBiblFieldFilterFactory\findByFieldId(), ilBiblFieldFilterFactory\findById(), ilBiblEntryFactory\findByIdAndTypeString(), ilBiblFieldFactory\findOrCreateFieldOfAttribute(), ilBiblEntryFactory\getAllAttributesByEntryId(), ilBiblFieldFilterFactory\getAllForObjectId(), ilBiblEntryFactory\getARInstance(), ilBiblFieldFactory\getARInstance(), ilBiblAttributeFactory\getAttributesForEntry(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getBucketIdsByState(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getBucketIdsOfUser(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getBucketMetaOfUser(), ilBiblFieldFilterFactory\getByObjectIdAndField(), ilBiblTranslationFactory\getCollectionOfTranslationsForField(), ilAccessibilityDocumentGUI\getDocumentsByServerRequest(), ilDclCache\getFieldProperties(), ilDclTableView\getFieldSetting(), ilDclTableView\getFieldSettings(), ilDclTableView\getFilterableFieldSettings(), ilBiblDataFactory\getIlBiblDataById(), ilBiblEntryTableGUI\getRecordsOfCurrentPage(), ilMMItemRepository\getTopItems(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getValueContainerId(), ilDclBaseFieldModel\getViewSettings(), ilDclTableView\getVisibleFields(), ilBiblEntryFactory\loadParsedAttributesByEntryId(), ilMMItemTranslationTableGUI\parseData(), ilDclCache\preloadFieldProperties(), ilADNNotification\resetForAllUsers(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\saveTask(), and ilOrgUnitPathStorage\store().

                                                          : \ActiveRecordList
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());
        $activeRecordList->where($where, $operator);

        return $activeRecordList;
    }

Here is the caller graph for this function:

Field Documentation

$ar_safe_read

bool ActiveRecord::$ar_safe_read = true

protected

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

$connector_container_name

string ActiveRecord::$connector_container_name = ''

protected

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

Referenced by getConnectorContainerName(), and setConnectorContainerName().

$is_new

bool ActiveRecord::$is_new = true

protected

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

---

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

• components/ILIAS/ActiveRecord/class.ActiveRecord.php