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 ()
	@description 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 ()
	@depracated 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 ()
	@description Returns an instance of the instatiated calling active record (needs to be done in static methods) @TODO : 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 @depracated 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.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ __call()

ActiveRecord::__call	(	$name,
		$arguments
	)

Parameters

$name
$arguments

Returns: mixed @noinspection PhpInconsistentReturnPointsInspection since this a dynamic call

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

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

◆ _toCamelCase()

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

static

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

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

References $c.

◆ additionalParams()

static ActiveRecord::additionalParams ( array $additional_params )

static

Returns: $this

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

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

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

Reimplemented in CachedActiveRecord, and ilDclFieldProperty.

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.

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

Referenced by arConnectorCache\storeActiveRecordInCache().

Here is the caller graph for this function:

◆ asStdClass()

ActiveRecord::asStdClass ( )

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

                                : \stdClass
    {
        $return = new stdClass();
        foreach ($this->getArFieldList()->getFields() as $arField) {
            $fieldname = $arField->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:

◆ buildFromArray()

ActiveRecord::buildFromArray ( array $array )

Reimplemented in ilAccessibilityDocument.

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

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

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

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.

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

References arException\COPY_DESTINATION_ID_EXISTS.

◆ count()

static ActiveRecord::count ( )

static

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

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

Referenced by ilAccessibilityDocument\detachCriterion(), and ILIAS\UI\Implementation\Component\Table\AbstractTable\getColumnCount().

Here is the caller graph for this function:

◆ create()

ActiveRecord::create ( )

Reimplemented in ilAccessibilityDocumentCriterionAssignment, CachedActiveRecord, ilADNNotification, ilDclFieldProperty, and ilMMItemStorage.

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

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

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

Reimplemented in CachedActiveRecord, and ilDclTableView.

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

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

References arObjectCache\purge().

Here is the call 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.

                                                                                     : \ActiveRecord
    {
        $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 ilSecurePathDefinitionProcessor\beginTag(), ilBiblLibraryFactory\findById(), ilBiblTranslationFactory\findById(), and ilADNNotificationGUI\getNotificationsFromRequest().

Here is the caller graph for this function:

◆ findOrGetInstance()

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

static

Parameters

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

Returns: \ActiveRecord|object|void

Reimplemented in ilDclTableView.

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

                                                                                            : \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.

                                  : ?\ActiveRecord
    {
        $activeRecordList = new ActiveRecordList(self::getCalledClass());
 
        return $activeRecordList->first();
    }

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

Here is the caller graph for this function:

◆ fixDateField()

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

Parameters

$field_name
$value

Returns: string|mixed @noinspection NullPointerExceptionInspection

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

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

◆ flushDB()

static ActiveRecord::flushDB ( )

staticfinal

@depracated never use in ILIAS Core, Plugins only

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

                                          : void
    {
        self::truncateDB();
    }

Referenced by ilMMTopItemGUI\restore().

Here is the caller graph for this function:

◆ fromCamelCase()

static ActiveRecord::fromCamelCase ( string $str )

staticprotected

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

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

References $c.

◆ get()

static ActiveRecord::get ( )

static

Returns: ActiveRecord[]

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

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

Referenced by ilBiblLibraryFactory\getAll(), and ilADNNotificationGUI\getNotificationsFromRequest().

Here is the caller graph for this function:

◆ getArConnector()

ActiveRecord::getArConnector ( )

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

                                    : \arConnector
    {
        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 ( )

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

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

References arFieldCache\get().

Referenced by arWhere\asSQLStatement(), asStdClass(), CachedActiveRecord\buildHash(), CachedActiveRecord\getCacheIdentifier(), 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	(	?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.

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

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

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.

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

References $data.

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

Here is the caller graph for this function:

◆ getCalledClass()

static ActiveRecord::getCalledClass ( )

staticprotected

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

                                              : \ActiveRecord
    {
        $class = static::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

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

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

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

Here is the caller graph for this function:

◆ getConnectorContainerName()

ActiveRecord::getConnectorContainerName ( )

@description Return the Name of your Connector Table

Reimplemented in ilADNDismiss, ilADNNotification, ilBiblLibrary, ilBiblAttribute, ilBiblData, ilBiblEntry, ilBiblField, ilBiblFieldFilter, ilBiblOverviewModel, ilBiblTranslation, and ilOrgUnitPathStorage.

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

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

References $connector_container_name, and getCalledClass().

Referenced by ActiveRecordList\__construct(), arWhere\asSQLStatement(), arJoin\asStatementText(), arConnectorCache\buildCacheKey(), arConnectorDB\checkFieldExists(), arConnectorDB\checkTableExists(), arConnectorDB\create(), arBuilder\generateDBUpdateForInstallation(), CachedActiveRecord\getCacheIdentifier(), 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

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.

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

References arFieldCache\getPrimaryFieldName().

Referenced by arConnectorCache\buildCacheKey(), arConnectorSession\create(), CachedActiveRecord\getCacheIdentifier(), 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	(	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.

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

◆ installConnector()

ActiveRecord::installConnector ( )

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

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

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

◆ installDatabase()

ActiveRecord::installDatabase ( )

finalprotected

Deprecated:: never use in ILIAS Core, Plugins only

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

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

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

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

Referenced by arConnectorDB\resetDatabase().

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.

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

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

Here is the caller graph for this function:

◆ preloadObjects()

static ActiveRecord::preloadObjects ( )

static

Returns: ActiveRecord[]

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

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

References ILIAS\GlobalScreen\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

Reimplemented in ilAccessibilityDocument, and CachedActiveRecord.

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

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

References arException\RECORD_NOT_FOUND.

Referenced by __construct().

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

arException

Deprecated:

Reimplemented in ilAccessibilityDocumentCriterionAssignment, ilAccessibilityDocument, ilADNDismiss, ilADNNotification, ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer, ILIAS\BackgroundTasks\Implementation\Persistence\TaskContainer, ILIAS\BackgroundTasks\Implementation\Persistence\ValueContainer, ILIAS\BackgroundTasks\Implementation\Persistence\ValueToTaskContainer, ilBiblLibrary, ilBiblAttribute, ilBiblData, ilBiblEntry, ilBiblField, ilBiblFieldFilter, ilBiblOverviewModel, ilBiblTranslation, ilDclFieldProperty, ilDclSelectionOption, ilDclTableFieldSetting, ilDclTableView, ilDclTableViewDateDefaultValue, ilDclTableViewFieldSetting, ilDclTableViewNumberDefaultValue, ilDclTableViewTextDefaultValue, ilExAssWikiTeamAR, ilItemGroupAR, and ilWACSecurePath.

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

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

References arException\UNKNONWN_EXCEPTION.

◆ save()

ActiveRecord::save ( )

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

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

◆ setConnectorContainerName()

ActiveRecord::setConnectorContainerName ( string $connector_container_name )

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

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

References $connector_container_name.

◆ setPrimaryFieldValue()

ActiveRecord::setPrimaryFieldValue ( $value )

Parameters

$value

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

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

Reimplemented in ilDclTableView, and ilDclTableViewFieldSetting.

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

    {
        return null;
    }

◆ store()

ActiveRecord::store ( )

Reimplemented in ilOrgUnitPathStorage.

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

                           : void
    {
        $primary_fieldname = arFieldCache::getPrimaryFieldName($this);
        $primary_value = $this->getPrimaryFieldValue();
 
        if (!self::where([$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 114 of file class.ActiveRecord.php.

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

References arObjectCache\store().

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

Reimplemented in ilAccessibilityDocumentCriterionAssignment, CachedActiveRecord, and ilDclFieldProperty.

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

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

References arObjectCache\store().

Referenced by ilAccessibilityDocumentGUI\detachCriterionAssignment(), and ilOrgUnitPathStorage\store().

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

Reimplemented in ilADNNotification, ilDclTableView, and ilDclTableViewFieldSetting.

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

    {
        return null;
    }

◆ where()

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

static

Parameters

	$where
null	$operator

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

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

Referenced by ilDclTableView\createFieldSetting(), ilMMAbstractItemFacade\deleteAssociatedTranslations(), ilBiblEntryFactory\deleteEntryById(), ilBiblFieldFilterFactory\filterItemsForTable(), ilBiblFieldFilterFactory\findByFieldId(), ilBiblFieldFilterFactory\findById(), ilBiblEntryFactory\findByIdAndTypeString(), ilBiblFieldFactory\findOrCreateFieldOfAttribute(), ilBiblEntryFactory\getAllAttributesByEntryId(), ilDclSelectionOption\getAllForField(), ilBiblFieldFilterFactory\getAllForObjectId(), ilDclTableView\getAllForTableId(), 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(), ilDclTableFieldSetting\getInstance(), ilMMItemRepository\getTopItems(), ilDclBaseFieldModel\getViewSettings(), ilDclTableView\getVisibleFields(), ilADNDismiss\hasDimissed(), ilBiblEntryFactory\loadParsedAttributesByEntryId(), ilDclCache\preloadFieldProperties(), and ilADNNotification\resetForAllUsers().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __call()

◆ _toCamelCase()

◆ additionalParams()

◆ affectedRows()

◆ afterObjectLoad()

◆ asArray()

◆ asStdClass()

◆ buildFromArray()

◆ connector()

◆ copy()

◆ count()

◆ create()

◆ dateFormat()

◆ debug()

◆ delete()

◆ fieldExists()

◆ findOrFail()

◆ findOrGetInstance()

◆ first()

◆ fixDateField()

◆ flushDB()

◆ fromCamelCase()

◆ get()

◆ getArConnector()

◆ getArFieldList()

◆ getArray()

◆ getArrayForConnector()

◆ getCalledClass()

◆ getCollection()

◆ getConnectorContainerName()

◆ getFirstFromLastQuery()

◆ getPrimaryFieldValue()

◆ innerjoin()

◆ innerjoinAR()

◆ installConnector()

◆ installDatabase()

◆ installDB()

◆ last()

◆ leftjoin()

◆ limit()

◆ orderBy()

◆ preloadObjects()

◆ raw()

◆ read()

◆ removeDBField()

◆ renameDBField()

◆ resetDB()

◆ returnDbTableName()

◆ save()

◆ setConnectorContainerName()

◆ setPrimaryFieldValue()

◆ sleep()

◆ store()

◆ storeObjectToCache()

◆ tableExists()

◆ truncateDB()

◆ update()

◆ updateDB()

◆ wakeUp()

◆ where()

Field Documentation

◆ $ar_safe_read

◆ $connector_container_name

◆ $is_new