ActiveRecord Class Reference

Class ActiveRecord. 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 ($primary_key=0)
	storeObjectToCache ()
	asStdClass ()
	buildFromArray (array $array)
	fixDateField ($field_name, $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=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, array $fields=array(' *'), string $operator='=', $both_external=false)
static	innerjoin ( $tablename, $on_this, $on_external, array $fields=array(' *'), string $operator='=', bool $both_external=false)
static	leftjoin ( $tablename, $on_this, $on_external, array $fields=array(' *'), string $operator='=', bool $both_external=false)
static	orderBy ($orderBy, string $orderDirection='ASC')
static	dateFormat (string $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 (bool $set_raw=true)
static	getArray (?string $key=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

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

)

Parameters

mixed

$primary_key

Reimplemented in ilOrgUnitAuthority, and ilOrgUnitPermission.

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

    {
        $arFieldList = arFieldCache::get($this);
 
        $key = $arFieldList->getPrimaryFieldName();
        $this->{$key} = $primary_key;
        if ($primary_key !== 0 && $primary_key !== null && $primary_key !== false) {
            $this->read();
        }
    }

References ILIAS\LTI\ToolProvider\$key, 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 672 of file class.ActiveRecord.php.

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

References $name.

_toCamelCase()

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

static

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

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

References $c.

additionalParams()

static ActiveRecord::additionalParams ( array  $additional_params )

static

Returns

$this

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

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

affectedRows()

static ActiveRecord::affectedRows ( )

static

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

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

afterObjectLoad()

ActiveRecord::afterObjectLoad

(

)

Reimplemented in ilDclFieldProperty, ilOrgUnitPosition, ilOrgUnitPermission, and CachedActiveRecord.

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

                                     : void
    {
    }

asStdClass()

ActiveRecord::asStdClass

(

)

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

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

References getArFieldList().

Referenced by arConnectorSession\create(), and arConnectorCache\storeActiveRecordInCache().

Here is the call graph for this function:

Here is the caller graph for this function:

buildFromArray()

ActiveRecord::buildFromArray

(

array

$array

)

Reimplemented in ilAccessibilityDocument, and ilTermsOfServiceDocument.

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

                                                : \ActiveRecord
    {
        $class = get_class($this);
        $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  $connector )

static

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

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

copy()

ActiveRecord::copy

(

int

$new_id = 0

)

Exceptions

arException

Reimplemented in CachedActiveRecord.

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

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

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

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

Referenced by ilAccessibilityDocument\detachCriterion(), ilTermsOfServiceDocument\detachCriterion(), ilADTActiveRecordWrapper\initFieldList(), ilOrgUnitPosition\storeAuthorities(), and ilTermsOfServiceDocument\update().

Here is the caller graph for this function:

create()

ActiveRecord::create

(

)

Reimplemented in ilDclFieldProperty, ilOrgUnitPosition, ilOrgUnitOperation, ilOrgUnitOperationContext, ilOrgUnitPermission, ilOrgUnitUserAssignment, ilAccessibilityDocumentCriterionAssignment, CachedActiveRecord, ilADNNotification, ilMMItemStorage, ilTermsOfServiceDocumentCriterionAssignment, and ilTermsOfServiceDocument.

Definition at line 325 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 560 of file class.ActiveRecord.php.

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

debug()

static ActiveRecord::debug ( )

static

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

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

delete()

ActiveRecord::delete

(

)

Reimplemented in ilDclTableView, ilOrgUnitPosition, ilOrgUnitPermission, ilOrgUnitUserAssignment, CachedActiveRecord, and ilTermsOfServiceDocument.

Definition at line 381 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 ( string  $field_name )

staticfinal

Parameters

$field_name

Definition at line 238 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 = array()  )

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 445 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(), ilBiblFieldFilterFactory\findById(), ilBiblTranslationFactory\findById(), ilOrgUnitOperationQueries\findById(), and ilADNNotificationGUI\getNotificationFromRequest().

Here is the caller graph for this function:

findOrGetInstance()

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

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

    {
        $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 609 of file class.ActiveRecord.php.

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

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

Here is the caller graph for this function:

fixDateField()

ActiveRecord::fixDateField	(		$field_name,
			$value
	)

Parameters

$field_name
$value

Returns

string|mixed @noinspection NullPointerExceptionInspection

Definition at line 145 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 300 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 693 of file class.ActiveRecord.php.

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

References $c.

get()

static ActiveRecord::get ( )

static

Returns

ActiveRecord[]

Reimplemented in ilOrgUnitPosition.

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

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

Referenced by ilGlobalCacheMetricsCollectedObjective\collectFrom(), and ilBiblLibraryFactory\getAll().

Here is the caller graph for this function:

getArConnector()

ActiveRecord::getArConnector

(

)

Definition at line 30 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 35 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,   $values = null  )

static

Parameters

null

$values

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

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by ilMMItemInformation\__construct(), ilMMAbstractBaseTypeHandlerAction\__construct(), ilOrgUnitPositionTableGUI\buildData(), ilOrgUnitUserAssignmentGUI\getConfirmationGUI(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ilOrgUnitUserAssignmentGUI\index(), ilADNNotificationTableGUI\initData(), ilOrgUnitPositionFormGUI\initFormElements(), ILIAS\OrgUnit\Webservices\SOAP\PositionIds\run(), and ilPermissionGUI\savePositionsPermissions().

Here is the caller graph for this function:

getArrayForConnector()

ActiveRecord::getArrayForConnector ( )

final

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

                                                : array
    {
        $data = array();
        foreach ($this->getArFieldList()->getFields() as $field) {
            $field_name = $field->getName();
            $sleeped = $this->sleep($field_name);
            $var = $sleeped ?? ($this->{$field_name});
            $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:

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

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

Referenced by ilDclTableViewEditGUI\executeCommand(), and ilBiblFieldFactory\getCollectionForFilter().

Here is the caller graph for this function:

getConnectorContainerName()

ActiveRecord::getConnectorContainerName

(

)

@description Return the Name of your Connector Table

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

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

                                               : string
    {
        // WILL BE ABSTRACT TO REPLACE returnDbTableName() IN NEXT VERSION
        if ($this->connector_container_name) {
            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(), arConnectorDB\checkFieldExists(), arConnectorDB\checkTableExists(), arConnectorDB\create(), arBuilder\generateDBUpdateForInstallation(), CachedActiveRecord\getCacheIdentifier(), arConnectorDB\installDatabase(), arConnectorDB\nextID(), arConnectorDB\read(), arConnectorCache\read(), arConnectorDB\removeField(), arConnectorDB\renameField(), arConnectorDB\resetDatabase(), arConnectorCache\storeActiveRecordInCache(), 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 632 of file class.ActiveRecord.php.

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

getPrimaryFieldValue()

ActiveRecord::getPrimaryFieldValue

(

)

Returns

mixed

Reimplemented in ilADTActiveRecordWrapper.

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

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

References arFieldCache\getPrimaryFieldName().

Referenced by arConnectorSession\create(), CachedActiveRecord\getCacheIdentifier(), arObjectCache\purge(), arConnectorDB\read(), arConnectorCache\read(), arConnectorSession\read(), arObjectCache\store(), arConnectorCache\storeActiveRecordInCache(), 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, array  $fields = array('*'), string  $operator = '=', bool  $both_external = false  )

static

Parameters

$tablename
$on_this
$on_external

Returns

$this

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

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

Referenced by ilMStListCoursesTableGUI\fillRow(), and ilMStShowUserCoursesTableGUI\fillRow().

Here is the caller graph for this function:

innerjoinAR()

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

static

Parameters

$on_this
$on_external

Returns

$this

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

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

installConnector()

ActiveRecord::installConnector

(

)

Deprecated:

Do not use in Core DB-update.

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

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

installDatabase()

ActiveRecord::installDatabase ( )

finalprotected

Deprecated:

never use in ILIAS Core, Plugins only

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

                                              : bool
    {
        if (!self::tableExists()) {
            $fields = array();
            if (isset($this)) {
                foreach ($this->getArFieldList()->getFields() as $field) {
                    $fields[$field->getName()] = $field->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 208 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 622 of file class.ActiveRecord.php.

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

leftjoin()

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

static

Parameters

$tablename
$on_this
$on_external

Returns

$this

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

     : \ActiveRecordList {
        $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

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

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

orderBy()

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

static

Parameters

$orderBy

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

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

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

Here is the caller graph for this function:

preloadObjects()

static ActiveRecord::preloadObjects ( )

static

Returns

ActiveRecord[]

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

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

References ILIAS\Repository\get().

Here is the call graph for this function:

raw()

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

static

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

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

read()

ActiveRecord::read

(

)

Exceptions

arException

Reimplemented in ilAccessibilityDocument, CachedActiveRecord, and ilTermsOfServiceDocument.

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

                          : void
    {
        $records = $this->getArConnector()->read($this);
        if ($this->ar_safe_read === true && is_array($records) && count($records) === 0) {
            throw new arException(arException::RECORD_NOT_FOUND, $this->getPrimaryFieldValue());
        } elseif ($this->ar_safe_read === false && is_array($records) && count($records) === 0) {
            $this->is_new = true;
        }
        $records = is_array($records) ? $records : array();
        foreach ($records as $rec) {
            foreach ($this->getArrayForConnector() as $k => $v) {
                $waked = $this->wakeUp($k, $rec->{$k} ?? null);
                $this->{$k} = $waked ?? $rec->{$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 246 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 225 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 285 of file class.ActiveRecord.php.

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

returnDbTableName()

static ActiveRecord::returnDbTableName ( )

static

Exceptions

arException

Deprecated:

Reimplemented in ilBiblLibrary, ilBiblAttribute, ilBiblData, ilBiblEntry, ilBiblField, ilBiblFieldFilter, ilBiblOverviewModel, ilBiblTranslation, ilDclFieldProperty, ilDclSelectionOption, ilDclTableFieldSetting, ilDclTableView, ilDclTableViewDateDefaultValue, ilDclTableViewFieldSetting, ilDclTableViewNumberDefaultValue, ilDclTableViewTextDefaultValue, ilExAssWikiTeamAR, ilItemGroupAR, ilOrgUnitAuthority, ilOrgUnitPosition, ilOrgUnitOperation, ilOrgUnitOperationContext, ilOrgUnitPermission, ilOrgUnitUserAssignment, ilAccessibilityDocumentCriterionAssignment, ilAccessibilityDocument, ilADNDismiss, ilADNNotification, ilADTActiveRecordWrapper, ilMemcacheServer, ilTermsOfServiceDocumentCriterionAssignment, ilTermsOfServiceDocument, ilWACSecurePath, ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer, ILIAS\BackgroundTasks\Implementation\Persistence\TaskContainer, ILIAS\BackgroundTasks\Implementation\Persistence\ValueContainer, and ILIAS\BackgroundTasks\Implementation\Persistence\ValueToTaskContainer.

Definition at line 44 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 320 of file class.ActiveRecord.php.

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

setConnectorContainerName()

ActiveRecord::setConnectorContainerName

(

string

$connector_container_name

)

Definition at line 67 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 85 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, ilDclTableViewFieldSetting, ilOrgUnitPermission, and ilADTActiveRecordWrapper.

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

    {
        return null;
    }

store()

ActiveRecord::store

(

)

Reimplemented in ilOrgUnitPathStorage.

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

                           : void
    {
        $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 106 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 230 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 293 of file class.ActiveRecord.php.

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

update()

ActiveRecord::update

(

)

Reimplemented in ilDclFieldProperty, ilOrgUnitPosition, ilOrgUnitPermission, ilAccessibilityDocumentCriterionAssignment, CachedActiveRecord, ilTermsOfServiceDocumentCriterionAssignment, and ilTermsOfServiceDocument.

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

    {
        $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 272 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 ilDclTableView, ilDclTableViewFieldSetting, ilOrgUnitPermission, ilADNNotification, and ilADTActiveRecordWrapper.

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

    {
        return null;
    }

where()

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

static

Parameters

	$where
null	$operator

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

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

Referenced by ilOrgUnitPosition\afterObjectLoad(), ilDclTableView\createFieldSetting(), ilObjOrgUnit\delete(), ilMMAbstractItemFacade\deleteAssociatedTranslations(), ilBiblEntryFactory\deleteEntryById(), ilBiblFieldFilterFactory\filterItemsForTable(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\findAllUserAssingmentsByUserIds(), ilBiblFieldFilterFactory\findByFieldId(), ilBiblEntryFactory\findByIdAndTypeString(), ilOrgUnitOperationContextQueries\findByName(), ilOrgUnitOperationQueries\findByOperationString(), ilOrgUnitUserAssignment\findOrCreateAssignment(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\findOrCreateAssignment(), ilBiblFieldFactory\findOrCreateFieldOfAttribute(), ilBiblEntryFactory\getAllAttributesByEntryId(), ilDclSelectionOption\getAllForField(), ilBiblFieldFilterFactory\getAllForObjectId(), ilDclTableView\getAllForTableId(), ilBiblEntryFactory\getARInstance(), ilBiblFieldFactory\getARInstance(), ilObjOrgUnitTree\getAssignements(), ilOrgUnitUserAssignmentQueries\getAssignmentOrFail(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getAssignmentOrFail(), ilOrgUnitUserAssignmentQueries\getAssignmentsOfUserId(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getAssignmentsOfUserId(), ilOrgUnitUserAssignmentQueries\getAssignmentsOfUserIdAndPosition(), ilBiblAttributeFactory\getAttributesForEntry(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getBucketIdsByState(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getBucketIdsOfUser(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getBucketMetaOfUser(), ilBiblFieldFilterFactory\getByObjectIdAndField(), ilBiblTranslationFactory\getCollectionOfTranslationsForField(), ilOrgUnitPosition\getCorePosition(), ilDclTableView\getCountForTableId(), ilOrgUnitPosition\getDependentAuthorities(), ilAccessibilityDocumentGUI\getDocumentsByServerRequest(), ilTermsOfServiceDocumentGUI\getDocumentsByServerRequest(), ilDclCache\getFieldProperties(), ilDclTableView\getFieldSetting(), ilDclTableView\getFieldSettings(), ilDclTableView\getFilterableFieldSettings(), ilBiblDataFactory\getIlBiblDataById(), ilDclTableFieldSetting\getInstance(), ilOrgUnitOperationQueries\getOperationsForContextId(), ilOrgUnitOperationQueries\getOperationsForContextName(), ilOrgUnitUserAssignmentQueries\getOrgUnitIdsOfUsersPosition(), ilDclTableHelper\getStandardViewsByVisibleTables(), ilOrgUnitPermissionQueries\getTemplateSetForContextName(), ilMMItemRepository\getTopItems(), ilOrgUnitUserAssignmentQueries\getUserAssignmentsOfPosition(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserAssignmentsOfPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnit(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfOrgUnit(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnits(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfOrgUnits(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnitsInPosition(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfOrgUnitsInPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnitsOfUsersPosition(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfOrgUnitsOfUsersPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfPosition(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfPosition(), ilDclBaseFieldModel\getViewSettings(), ilDclTableView\getVisibleFields(), ilADNDismiss\hasDimissed(), ilOrgUnitPermissionQueries\hasLocalSet(), ilBiblEntryFactory\loadParsedAttributesByEntryId(), ilMMItemTranslationTableGUI\parseData(), ilDclCache\preloadFieldProperties(), ilOrgUnitOperationContextQueries\registerNewContext(), ilADNNotification\resetForAllUsers(), ILIAS\OrgUnit\Webservices\SOAP\RemoveUserIdFromPositionInOrgUnit\run(), ilObjTermsOfServiceGUI\showMissingDocuments(), ilOrgUnitSimpleUserImport\simpleUserImportElement(), and ilOrgUnitPosition\storeAuthorities().

Here is the caller graph for this function:

Field Documentation

$ar_safe_read

bool ActiveRecord::$ar_safe_read = true

protected

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

$connector_container_name

string ActiveRecord::$connector_container_name = ''

protected

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

Referenced by getConnectorContainerName(), and setConnectorContainerName().

$is_new

bool ActiveRecord::$is_new = true

protected

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

---

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

• Services/ActiveRecord/class.ActiveRecord.php