ADT Active Record service wrapper class This class expects a valid primary for all actions! More...

Inheritance diagram for ilADTActiveRecordWrapper:

Collaboration diagram for ilADTActiveRecordWrapper:

Public Member Functions
	__construct (ilADTGroupActiveRecordBridge $a_properties)
	Constructor. More...

	getConnectorContainerName ()
	@description Return the Name of your Connector Table More...

	getPrimaryFieldValue ()

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

Public Member Functions inherited from ActiveRecord
	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 Public Member Functions inherited from ActiveRecord
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
	getActiveRecordFieldTypeFromMDB2 (string $a_mdb2_type)

	initFieldList ()

Protected Member Functions inherited from ActiveRecord
	installDatabase ()

Protected Attributes
ilADTGroupActiveRecordBridge	$properties

arFieldList	$fields

arConnectorDB	$arConnector

array	$field_element_map = []

Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true

string	$connector_container_name = ''

bool	$is_new = true

Additional Inherited Members
Static Protected Member Functions inherited from ActiveRecord
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)

Detailed Description

ADT Active Record service wrapper class This class expects a valid primary for all actions!

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 12 of file class.ilADTActiveRecordWrapper.php.

Constructor & Destructor Documentation

◆ __construct()

ilADTActiveRecordWrapper::__construct ( ilADTGroupActiveRecordBridge $a_properties )

Constructor.

Parameters

ilADTGroupActiveRecordBridge $a_properties

Definition at line 23 of file class.ilADTActiveRecordWrapper.php.

    {
        $this->properties = $a_properties;
        $this->initFieldList();
        $this->arConnector = new arConnectorDB();
    }

References initFieldList().

Here is the call graph for this function:

Member Function Documentation

◆ getActiveRecordFieldTypeFromMDB2()

ilADTActiveRecordWrapper::getActiveRecordFieldTypeFromMDB2 ( string $a_mdb2_type )

protected

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

                                                                            : ?string
    {
        // currently they are all the same
        switch ($a_mdb2_type) {
            case "integer":
                return arField::FIELD_TYPE_INTEGER;
 
            case "float":
                return arField::FIELD_TYPE_FLOAT;
 
            case "text":
                return arField::FIELD_TYPE_TEXT;
 
            case "date":
                return arField::FIELD_TYPE_DATE;
 
            case "timestamp":
                return arField::FIELD_TYPE_TIMESTAMP;
        }
        return null;
    }

References arField\FIELD_TYPE_DATE, arField\FIELD_TYPE_FLOAT, arField\FIELD_TYPE_INTEGER, arField\FIELD_TYPE_TEXT, and arField\FIELD_TYPE_TIMESTAMP.

Referenced by initFieldList().

Here is the caller graph for this function:

◆ getConnectorContainerName()

ilADTActiveRecordWrapper::getConnectorContainerName ( )

@description Return the Name of your Connector Table

Reimplemented from ActiveRecord.

Definition at line 81 of file class.ilADTActiveRecordWrapper.php.

                                               : string
    {
        return $this->properties->getTable();
    }

◆ getPrimaryFieldValue()

ilADTActiveRecordWrapper::getPrimaryFieldValue ( )

Returns: mixed

Reimplemented from ActiveRecord.

Definition at line 91 of file class.ilADTActiveRecordWrapper.php.

                                          : string
    {
        $primaries = $this->properties->getPrimary();
        $primary = array_shift($primaries);
        return $primary[1];
    }

◆ initFieldList()

ilADTActiveRecordWrapper::initFieldList ( )

protected

Definition at line 52 of file class.ilADTActiveRecordWrapper.php.

                                      : void
    {
        $this->fields = new arFieldList($this);
 
        $fields = [];
        foreach ($this->properties->getActiveRecordFields() as $element_id => $element_fields) {
            foreach ($element_fields as $field) {
                $this->field_element_map[$field->getName()] = $element_id;
            }
            $fields = array_merge($fields, $element_fields);
        }
        $this->fields->setFields($fields);
 
        // primary
 
        if (count($this->properties->getPrimary()) > 1) {
            throw new ilException("ilADTActiveRecordWrapper - no complex primary keys supported yet");
        }
 
        foreach ($this->properties->getPrimary() as $primary_id => $primary_element) {
            $field = new arField();
            $field->setHasField(true);
            $field->setNotNull(true);
            $field->setFieldType($this->getActiveRecordFieldTypeFromMDB2($primary_element[0] ?? ''));
            $field->setName($primary_id);
            $this->fields->setPrimaryField($field);
        }
    }

References $fields, ActiveRecord\count(), fields, and getActiveRecordFieldTypeFromMDB2().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ returnDbTableName()

static ilADTActiveRecordWrapper::returnDbTableName ( )

static

Exceptions

arException

Deprecated:

Reimplemented from ActiveRecord.

Definition at line 86 of file class.ilADTActiveRecordWrapper.php.

                                              : string
    {
        throw new \RuntimeException('Not implemented yet');
    }

◆ sleep()

ilADTActiveRecordWrapper::sleep ( $field_name )

Todo:: types extended from ActiveRecord

Reimplemented from ActiveRecord.

Definition at line 101 of file class.ilADTActiveRecordWrapper.php.

    {
        if (array_key_exists($field_name, $this->field_element_map)) {
            $element = $this->properties->getElement($this->field_element_map[$field_name]);
            return $element->getFieldValue($field_name);
        }
        return false;
    }

◆ wakeUp()

ilADTActiveRecordWrapper::wakeUp	(	$field_name,
		$field_value
	)

Todo:: types extended from ActiveRecord

Reimplemented from ActiveRecord.

Definition at line 114 of file class.ilADTActiveRecordWrapper.php.

    {
        if (array_key_exists($field_name, $this->field_element_map)) {
            $element = $this->properties->getElement($this->field_element_map[$field_name]);
            $element->setFieldValue($field_name, $field_value);
            return true;
        }
        return false;
    }

Field Documentation

◆ $arConnector

arConnectorDB ilADTActiveRecordWrapper::$arConnector

protected

Definition at line 16 of file class.ilADTActiveRecordWrapper.php.

◆ $field_element_map

array ilADTActiveRecordWrapper::$field_element_map = []

protected

Definition at line 17 of file class.ilADTActiveRecordWrapper.php.

◆ $fields

arFieldList ilADTActiveRecordWrapper::$fields

protected

Definition at line 15 of file class.ilADTActiveRecordWrapper.php.

Referenced by initFieldList().

◆ $properties

ilADTGroupActiveRecordBridge ilADTActiveRecordWrapper::$properties

protected

Definition at line 14 of file class.ilADTActiveRecordWrapper.php.

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

Services/ADT/classes/ActiveRecord/class.ilADTActiveRecordWrapper.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActiveRecordFieldTypeFromMDB2()

◆ getConnectorContainerName()

◆ getPrimaryFieldValue()

◆ initFieldList()

◆ returnDbTableName()

◆ sleep()

◆ wakeUp()

Field Documentation

◆ $arConnector

◆ $field_element_map

◆ $fields

◆ $properties