ActiveRecord Class Reference

Class ActiveRecord. More...

Inheritance diagram for ActiveRecord:

Collaboration diagram for ActiveRecord:

Public Member Functions
	getArConnector ()
	getArFieldList ()
	getConnectorContainerName ()
	setConnectorContainerName ($connector_container_name)
	getPrimaryFieldValue ()
	setPrimaryFieldValue ($value)
	__construct ($primary_key=0, arConnector $connector=null)
	storeObjectToCache ()
	__getConvertedDateFieldsAsArray ($format=null)
	__asCsv ($separator=';', $header=false)
	__asArray ()
	__asStdClass ()
	__asSerializedObject ()
	buildFromArray (array $array)
	fixDateField ($field_name, $value)
	sleep ($field_name)
	wakeUp ($field_name, $field_value)
	getArrayForDb ()
	getArrayForConnector ()
	installConnector ()
	store ()
	save ()
	create ()
	copy ($new_id=0)
	afterObjectLoad ()
	read ()
	update ()
	delete ()
	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()
static	installDB ()
static	renameDBField ($old_name, $new_name)
static	tableExists ()
static	fieldExists ($field_name)
static	removeDBField ($field_name)
static	updateDB ()
static	resetDB ()
static	truncateDB ()
static	flushDB ()
static	preloadObjects ()
static	additionalParams (array $additional_params)
static	findOrFail ($primary_key, array $add_constructor_args=array())
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...
static	findOrGetInstance ($primary_key, array $add_constructor_args=array())
static	where ($where, $operator=null)
static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	orderBy ($orderBy, $orderDirection='ASC')
static	dateFormat ($date_format='d.m.Y - H:i:s')
static	limit ($start, $end)
static	affectedRows ()
static	count ()
static	get ()
static	debug ()
static	first ()
static	getCollection ()
static	last ()
static	getFirstFromLastQuery ()
static	connector (arConnector $connector)
static	raw ($set_raw=true)
static	getArray ($key=null, $values=null)
static	_toCamelCase ($str, $capitalise_first_char=false)

Data Fields
const	ACTIVE_RECORD_VERSION = '2.0.7'

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

Static Protected Member Functions
static	getCalledClass ()
static	fromCamelCase ($str)

Protected Attributes
	$ar_safe_read = true
	$connector_container_name = ''

Detailed Description

Class ActiveRecord.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch @experimental @description

Version

2.0.7

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

Constructor & Destructor Documentation

__construct()

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

Parameters

int	$primary_key
arConnector	$connector

Reimplemented in CachedActiveRecord.

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

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

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

Here is the call graph for this function:

Member Function Documentation

__asArray()

ActiveRecord::__asArray

(

)

Returns

array

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

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

References getArFieldList().

Referenced by __asCsv().

Here is the call graph for this function:

Here is the caller graph for this function:

__asCsv()

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

Parameters

string	$separator
bool	$header

Returns

string

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

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

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

Here is the call graph for this function:

__asSerializedObject()

ActiveRecord::__asSerializedObject

(

)

Returns

string

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

    {
        return serialize($this);
    }

__asStdClass()

ActiveRecord::__asStdClass

(

)

Returns

stdClass

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

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

References getArFieldList().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__call()

ActiveRecord::__call	(		$name,
			$arguments
	)

Parameters

$name
$arguments

Returns

array

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

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

References $name.

__getConvertedDateFieldsAsArray()

ActiveRecord::__getConvertedDateFieldsAsArray

(

$format = null

)

Parameters

string

$format

Returns

array

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

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

References $format, $name, and getArFieldList().

Here is the call graph for this function:

_toCamelCase()

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

static

Parameters

string	$str
bool	$capitalise_first_char

Returns

string

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

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

References $c.

Referenced by arViewField\__construct().

Here is the caller graph for this function:

additionalParams()

static ActiveRecord::additionalParams ( array  $additional_params )

static

Parameters

array

$additional_params

Returns

$this

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

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

affectedRows()

static ActiveRecord::affectedRows ( )

static

Returns

int

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

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

afterObjectLoad()

ActiveRecord::afterObjectLoad

(

)

Reimplemented in ilDclFieldProperty, ilOrgUnitPosition, ilOrgUnitPermission, and CachedActiveRecord.

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

    {
    }

buildFromArray()

ActiveRecord::buildFromArray

(

array

$array

)

Parameters

array

$array

Returns

$this

Reimplemented in CachedActiveRecord, and ilTermsOfServiceDocument.

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

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

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

Here is the call graph for this function:

connector()

static ActiveRecord::connector ( arConnector  $connector )

static

Parameters

arConnector

$connector

Returns

ActiveRecordList

Reimplemented in CachedActiveRecord.

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

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

copy()

ActiveRecord::copy

(

$new_id = 0

)

Parameters

int

$new_id

Returns

ActiveRecord

Exceptions

arException

Reimplemented in CachedActiveRecord.

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

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

References arException\COPY_DESTINATION_ID_EXISTS.

count()

static ActiveRecord::count ( )

static

Returns

int

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

    {
        return self::affectedRows();
    }

Referenced by ilTermsOfServiceDocument\detachCriterion(), ilStudyProgrammeType\loadTranslation(), ilStudyProgrammeType\processAndStoreIconFile(), and ilOrgUnitPosition\storeAuthorities().

Here is the caller graph for this function:

create()

ActiveRecord::create

(

)

Reimplemented in ilDclFieldProperty, ilOrgUnitPosition, ilOrgUnitOperation, ilOrgUnitOperationContext, ilOrgUnitPermission, CachedActiveRecord, arStorage, ilGSIdentificationStorage, ilMMItemStorage, and ilTermsOfServiceDocumentCriterionAssignment.

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

dateFormat()

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

static

Parameters

string

$date_format

Returns

ActiveRecordList

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

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

debug()

static ActiveRecord::debug ( )

static

Returns

ActiveRecordList

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

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

delete()

ActiveRecord::delete

(

)

Reimplemented in ilDclTableView, ilOrgUnitPosition, ilOrgUnitPermission, and CachedActiveRecord.

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

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

References arObjectCache\purge().

Referenced by arObjectCache\purge().

Here is the call graph for this function:

Here is the caller graph for this function:

fieldExists()

static ActiveRecord::fieldExists (   $field_name )

staticfinal

Parameters

$field_name

Returns

bool

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

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

findOrFail()

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

static

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

Parameters

	$primary_key
array	$add_constructor_args

Exceptions

arException

Returns

ActiveRecord

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

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

References arException\RECORD_NOT_FOUND.

Referenced by ilBiblLibraryFactory\findById(), ilBiblFieldFilterFactory\findById(), ilBiblTranslationFactory\findById(), ilOrgUnitOperationQueries\findById(), and ilObjDefReader\handlerBeginTag().

Here is the caller graph for this function:

findOrGetInstance()

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

static

Parameters

	$primary_key
array	$add_constructor_args

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

Returns

ActiveRecord

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

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

Referenced by ilDclTableViewGUI\executeCommand().

Here is the caller graph for this function:

first()

static ActiveRecord::first ( )

static

Returns

ActiveRecord

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

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

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

Here is the caller graph for this function:

fixDateField()

ActiveRecord::fixDateField	(		$field_name,
			$value
	)

Parameters

$field_name
$value

Returns

string

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

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

flushDB()

static ActiveRecord::flushDB ( )

staticfinal

Returns

bool

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

    {
        return self::truncateDB();
    }

Referenced by ilMMTopItemGUI\restore().

Here is the caller graph for this function:

fromCamelCase()

static ActiveRecord::fromCamelCase (   $str )

staticprotected

Parameters

string

$str

Returns

string

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

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

References $c.

get()

static ActiveRecord::get ( )

static

Returns

ActiveRecord[]

Reimplemented in ilOrgUnitPosition.

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

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

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

Here is the caller graph for this function:

getArConnector()

ActiveRecord::getArConnector

(

)

Returns

\arConnectorDB

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

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

References arConnectorMap\get().

Referenced by arWhere\asSQLStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

getArFieldList()

ActiveRecord::getArFieldList

(

)

Returns

\arFieldList

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

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

References arFieldCache\get().

Referenced by __asArray(), __asCsv(), __asStdClass(), __getConvertedDateFieldsAsArray(), arWhere\asSQLStatement(), 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 (   $key = null,   $values = null  )

static

Parameters

null	$key
null	$values

Returns

array

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

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

References $key, and $values.

Referenced by ilMMItemInformation\__construct(), ilMMAbstractBaseTypeHandlerAction\__construct(), ilOrgUnitPositionTableGUI\buildData(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ilOrgUnitUserAssignmentGUI\index(), ilOrgUnitPositionFormGUI\initFormElements(), ilMemcacheServerTableGUI\parseData(), and ilPermissionGUI\savePositionsPermissions().

Here is the caller graph for this function:

getArrayForConnector()

ActiveRecord::getArrayForConnector ( )

final

Returns

array

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

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

References $data.

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

Here is the caller graph for this function:

getArrayForDb()

ActiveRecord::getArrayForDb ( )

final

Returns

array

Deprecated:

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

    {
        return $this->getArrayForConnector();
    }

getCalledClass()

static ActiveRecord::getCalledClass ( )

staticprotected

Returns

ActiveRecord

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

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

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

References arCalledClassCache\get().

Referenced by getConnectorContainerName().

Here is the call graph for this function:

Here is the caller graph for this function:

getCollection()

static ActiveRecord::getCollection ( )

static

Returns

ActiveRecordList

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

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

Referenced by ilBiblFieldFactory\getCollectionForFilter(), and arStorageRecordGUI\index().

Here is the caller graph for this function:

getConnectorContainerName()

ActiveRecord::getConnectorContainerName

(

)

Returns

string @description Return the Name of your Connector Table

Reimplemented in ilBiblLibrary, ilBiblAttribute, ilBiblData, ilBiblEntry, ilBiblField, ilBiblFieldFilter, ilBiblOverviewModel, ilBiblTranslation, ilOrgUnitPathStorage, arMixedKey, ilADTActiveRecordWrapper, and ilGSProviderStorage.

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

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

References $connector_container_name, and getCalledClass().

Referenced by arWhere\asSQLStatement(), arJoin\asStatementText(), arConnectorDB\checkFieldExists(), arConnectorDB\checkTableExists(), arConnectorDB\create(), CachedActiveRecord\getCacheIdentifier(), innerjoinAR(), ActiveRecordList\innerjoinAR(), arConnectorDB\installDatabase(), arConnectorDB\nextID(), arConnectorCache\read(), arConnectorDB\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

Returns

ActiveRecordList

Deprecated:

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

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

getPrimaryFieldValue()

ActiveRecord::getPrimaryFieldValue

(

)

Returns

mixed

Reimplemented in ilADTActiveRecordWrapper.

Definition at line 94 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(), arConnectorCache\read(), arConnectorDB\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,   $fields = array( '*' ),   $operator = '=',   $both_external = false  )

static

Parameters

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

Returns

$this

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

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

Referenced by ilMStListCoursesGUI\getActions().

Here is the caller graph for this function:

innerjoinAR()

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

static

Parameters

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

Returns

$this

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

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

References getConnectorContainerName().

Here is the call graph for this function:

installConnector()

ActiveRecord::installConnector

(

)

Returns

bool

Deprecated:

Do not use in Core DB-update.

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

    {
        return $this->installDatabase();
    }

installDatabase()

ActiveRecord::installDatabase ( )

finalprotected

Returns

bool

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

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

installDB()

static ActiveRecord::installDB ( )

staticfinal

Returns

bool

Deprecated:

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

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

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

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

Referenced by arConnectorDB\resetDatabase().

Here is the caller graph for this function:

last()

static ActiveRecord::last ( )

static

Returns

ActiveRecord

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

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

leftjoin()

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

static

Parameters

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

Returns

$this

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

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

limit()

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

static

Parameters

$start
$end

Returns

ActiveRecordList

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

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

References $end, and $start.

orderBy()

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

static

Parameters

	$orderBy
string	$orderDirection

Returns

ActiveRecordList

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

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

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

Here is the caller graph for this function:

preloadObjects()

static ActiveRecord::preloadObjects ( )

static

Returns

ActiveRecord[]

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

    {
        return self::get();
    }

References ILIAS\GlobalScreen\get().

Here is the call graph for this function:

raw()

static ActiveRecord::raw (   $set_raw = true )

static

Parameters

bool

$set_raw

Returns

ActiveRecordList

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

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

read()

ActiveRecord::read

(

)

Exceptions

arException

Reimplemented in CachedActiveRecord, arStorage, and ilTermsOfServiceDocument.

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

    {
        $records = $this->getArConnector()->read($this);
        if (is_array($records) && count($records) === 0 && $this->ar_safe_read === true) {
            throw new arException(arException::RECORD_NOT_FOUND, $this->getPrimaryFieldValue());
        } elseif (is_array($records) && count($records) === 0 && $this->ar_safe_read === false) {
            $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});
                $this->{$k} = ($waked === null) ? $rec->{$k} : $waked;
            }
            arObjectCache::store($this);
            $this->afterObjectLoad();
        }
    }

References $records, and arException\RECORD_NOT_FOUND.

Referenced by __construct().

Here is the caller graph for this function:

removeDBField()

static ActiveRecord::removeDBField (   $field_name )

staticfinal

Parameters

$field_name

Returns

bool

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

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

renameDBField()

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

staticfinal

Parameters

$old_name
$new_name

Returns

bool

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

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

resetDB()

static ActiveRecord::resetDB ( )

staticfinal

Returns

bool

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

    {
        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, ilDclTableViewFieldSetting, ilExAssWikiTeamAR, ilItemGroupAR, ilOrgUnitAuthority, ilOrgUnitPosition, ilOrgUnitOperation, ilOrgUnitOperationContext, ilOrgUnitPermission, ilOrgUnitUserAssignment, ilStudyProgramme, ilStudyProgrammeAdvancedMetadataRecord, ilStudyProgrammeAssignment, ilStudyProgrammeProgress, ilStudyProgrammeType, ilStudyProgrammeTypeTranslation, arConfig, arMessage, arUser, arMixedKey, arRealRecord, arStorageRecordStorage, 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 59 of file class.ActiveRecord.php.

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

References arException\UNKNONWN_EXCEPTION.

save()

ActiveRecord::save

(

)

Reimplemented in CachedActiveRecord.

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

    {
        $this->store();
    }

serializeToCSV()

ActiveRecord::serializeToCSV (   $field )

protected

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

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

Parameters

$field

string

Returns

mixed

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

    {
        return null;
    }

Referenced by __asCsv().

Here is the caller graph for this function:

setConnectorContainerName()

ActiveRecord::setConnectorContainerName

(

$connector_container_name

)

Parameters

string

$connector_container_name

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

    {
        $this->connector_container_name = $connector_container_name;
    }

References $connector_container_name.

setPrimaryFieldValue()

ActiveRecord::setPrimaryFieldValue

(

$value

)

Parameters

$value

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

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

References arFieldCache\getPrimaryFieldName().

Here is the call graph for this function:

sleep()

ActiveRecord::sleep

(

$field_name

)

Parameters

$field_name

Returns

mixed

Reimplemented in ilDclTableView, ilDclTableViewFieldSetting, ilOrgUnitPermission, and ilADTActiveRecordWrapper.

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

    {
        return null;
    }

store()

ActiveRecord::store

(

)

Reimplemented in ilOrgUnitPathStorage, and CachedActiveRecord.

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

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

References arFieldCache\getPrimaryFieldName(), and League\Flysystem\Adapter\Polyfill\update().

Here is the call graph for this function:

storeObjectToCache()

ActiveRecord::storeObjectToCache

(

)

Reimplemented in CachedActiveRecord.

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

    {
        arObjectCache::store($this);
    }

References arObjectCache\store().

Here is the call graph for this function:

tableExists()

static ActiveRecord::tableExists ( )

staticfinal

Returns

bool

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

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

truncateDB()

static ActiveRecord::truncateDB ( )

staticfinal

Returns

bool

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

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

update()

ActiveRecord::update

(

)

Reimplemented in ilDclFieldProperty, ilOrgUnitPosition, ilOrgUnitPermission, CachedActiveRecord, arStorage, and ilTermsOfServiceDocumentCriterionAssignment.

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

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

References arObjectCache\store().

Referenced by ilTermsOfServiceDocumentGUI\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

Returns

bool

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

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

wakeUp()

ActiveRecord::wakeUp	(		$field_name,
			$field_value
	)

Parameters

$field_name
$field_value

Returns

mixed

Reimplemented in ilDclTableView, ilDclTableViewFieldSetting, ilOrgUnitPermission, and ilADTActiveRecordWrapper.

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

    {
        return null;
    }

where()

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

static

Parameters

	$where
null	$operator

Returns

ActiveRecordList

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

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

Referenced by ilStudyProgrammeUserProgress\__construct(), ilOrgUnitPosition\afterObjectLoad(), ilDclTableView\createFieldSetting(), ilObjOrgUnit\delete(), ilStudyProgrammeTypeTranslation\deleteAllTranslations(), ilMMAbstractItemFacade\deleteAssociatedTranslations(), ilBiblEntryFactory\deleteEntryById(), ilObjBibliographic\doRead(), ilBiblFieldFilterFactory\filterItemsForTable(), ilBiblFieldFilterFactory\findByFieldId(), ilBiblEntryFactory\findByIdAndTypeString(), ilOrgUnitOperationContextQueries\findByName(), ilOrgUnitOperationQueries\findByOperationString(), ilOrgUnitUserAssignment\findOrCreateAssignment(), ilBiblFieldFactory\findOrCreateFieldOfAttribute(), ilBiblEntryFactory\getAllAttributesByEntryId(), ilBiblEntryFactory\getAllEntries(), ilDclSelectionOption\getAllForField(), ilBiblFieldFilterFactory\getAllForObjectId(), ilDclTableView\getAllForTableId(), ilBiblEntryFactory\getARInstance(), ilBiblFieldFactory\getARInstance(), ilStudyProgrammeType\getAssignedAdvancedMDRecords(), ilStudyProgrammeType\getAssignedStudyProgrammes(), ilObjOrgUnitTree\getAssignements(), ilOrgUnitUserAssignmentQueries\getAssignmentOrFail(), ilObjStudyProgramme\getAssignmentsOf(), ilOrgUnitUserAssignmentQueries\getAssignmentsOfUserId(), ilObjStudyProgramme\getAssignmentsRaw(), 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(), ilTermsOfServiceDocumentGUI\getDocumentsByServerRequest(), ilBiblEntryFactory\getEntryById(), ilDclCache\getFieldProperties(), ilDclBaseFieldModel\getFieldSettings(), ilDclTableView\getFieldSettings(), ilDclTableView\getFilterableFieldSettings(), ilBiblDataFactory\getIlBiblDataById(), ilDclTableFieldSetting\getInstance(), ilStudyProgrammeUserProgressDB\getInstanceForAssignment(), ilStudyProgrammeUserProgressDB\getInstancesForAssignment(), ilStudyProgrammeUserAssignment\getInstancesForProgram(), ilStudyProgrammeUserProgressDB\getInstancesForProgram(), ilStudyProgrammeUserProgressDB\getInstancesForUser(), ilStudyProgrammeUserAssignment\getInstancesOfUser(), ilOrgUnitUserAssignmentQueries\getOrgUnitIdsOfUsersPosition(), ilDclTableHelper\getStandardViewsByVisibleTables(), ilOrgUnitPermissionQueries\getTemplateSetForContextName(), ilMMItemRepository\getTopItems(), ilOrgUnitUserAssignmentQueries\getUserAssignmentsOfPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnit(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnits(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnitsInPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnitsOfUsersPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfUsersOrgUnitsInPosition(), ilDclTableView\getVisibleFields(), ilOrgUnitPermissionQueries\hasLocalSet(), ilBiblEntryFactory\loadParsedAttributesByEntryId(), ilStudyProgrammeType\loadTranslation(), ilMMItemTranslationTableGUI\parseData(), ilDclCache\preloadFieldProperties(), ilTermsOfServiceSettingsFormGUI\saveObject(), ilObjTermsOfServiceGUI\showMissingDocuments(), and ilOrgUnitPosition\storeAuthorities().

Here is the caller graph for this function:

Field Documentation

$ar_safe_read

ActiveRecord::$ar_safe_read = true

protected

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

$connector_container_name

ActiveRecord::$connector_container_name = ''

protected

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

Referenced by getConnectorContainerName(), and setConnectorContainerName().

ACTIVE_RECORD_VERSION

const ActiveRecord::ACTIVE_RECORD_VERSION = '2.0.7'

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

---

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

• Services/ActiveRecord/class.ActiveRecord.php