ilADTGroupDBBridge Class Reference

Inheritance diagram for ilADTGroupDBBridge:

Collaboration diagram for ilADTGroupDBBridge:

Public Member Functions
	getElements ()
	getElement ($a_element_id)
	setTable ($a_table)
	Set table name. More...
	setPrimary (array $a_value)
	Set primary fields (in MDB2 format) More...
	readRecord (array $a_row)
	Import DB values to ADT. More...
	prepareInsert (array &$a_fields)
	Prepare ADT values for insert. More...
	afterInsert ()
	After insert hook to enable sub-tables. More...
	afterUpdate ()
	After update hook to enable sub-tables. More...
	afterUpdateElement (string $field_type, string $field_name, int $field_id)
	afterDelete ()
	After delete hook to enable sub-tables. More...
Public Member Functions inherited from ilADTDBBridge
	__construct (ilADT $a_adt)
	Constructor. More...
	getADT ()
	Get ADT. More...
	setTable ($a_table)
	Set table name. More...
	getTable ()
	Get table name. More...
	setElementId ($a_value)
	Set element id (aka DB column[s] [prefix]) More...
	getElementId ()
	Get element id. More...
	setPrimary (array $a_value)
	Set primary fields (in MDB2 format) More...
	getPrimary ()
	Get primary fields. More...
	buildPrimaryWhere ()
	Convert primary keys array to sql string. More...
	readRecord (array $a_row)
	Import DB values to ADT. More...
	prepareInsert (array &$a_fields)
	Prepare ADT values for insert. More...
	afterInsert ()
	After insert hook to enable sub-tables. More...
	prepareUpdate (array &$a_fields)
	Prepare ADT values for update. More...
	afterUpdate ()
	After update hook to enable sub-tables. More...
	afterDelete ()
	After delete hook to enable sub-tables. More...
	supportsDefaultValueColumn ()
	true if table storage relies on the default 'value' column More...

Protected Member Functions
	isValidADT (ilADT $a_adt)
	Check if given ADT is valid. More...
	prepareElements ()
Protected Member Functions inherited from ilADTDBBridge
	isValidADT (ilADT $a_adt)
	Check if given ADT is valid. More...
	setADT (ilADT $a_adt)
	Set ADT. More...

Protected Attributes
	$elements = []
Protected Attributes inherited from ilADTDBBridge
	$adt
	$table
	$id
	$primary = []

Detailed Description

Definition at line 5 of file class.ilADTGroupDBBridge.php.

Member Function Documentation

afterDelete()

ilADTGroupDBBridge::afterDelete

(

)

After delete hook to enable sub-tables.

Reimplemented from ilADTDBBridge.

Definition at line 132 of file class.ilADTGroupDBBridge.php.

    {
        foreach ($this->getElements() as $element) {
            $element->afterDelete();
        }
    }

References getElements().

Here is the call graph for this function:

afterInsert()

ilADTGroupDBBridge::afterInsert

(

)

After insert hook to enable sub-tables.

Reimplemented from ilADTDBBridge.

Definition at line 94 of file class.ilADTGroupDBBridge.php.

    {
        foreach ($this->getElements() as $element) {
            $element->afterInsert();
        }
    }

References getElements().

Here is the call graph for this function:

afterUpdate()

ilADTGroupDBBridge::afterUpdate

(

)

After update hook to enable sub-tables.

Reimplemented from ilADTDBBridge.

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

    {
        foreach ($this->getElements() as $element) {
            $element->afterUpdate();
        }
    }

References getElements().

Here is the call graph for this function:

afterUpdateElement()

ilADTGroupDBBridge::afterUpdateElement	(	string	$field_type,
		string	$field_name,
		int	$field_id
	)

Parameters

string	$field_type
string	$field_name
int	$field_id

Definition at line 113 of file class.ilADTGroupDBBridge.php.

    {
        $element = $this->getElement($field_id);
        if (!$element) {
            return;
        }
        $element->setPrimary(
            array_merge(
                $this->getPrimary(),
                [
                     $field_name => [$field_type,$field_id]
                ]
            )
        );
        $element->setElementId($field_id);
        $element->afterUpdate();
    }

References getElement(), and ilADTDBBridge\getPrimary().

Here is the call graph for this function:

getElement()

ilADTGroupDBBridge::getElement

(

$a_element_id

)

Definition at line 45 of file class.ilADTGroupDBBridge.php.

    {
        if (array_key_exists($a_element_id, $this->getElements())) {
            return $this->elements[$a_element_id];
        }
    }

References getElements().

Referenced by afterUpdateElement().

Here is the call graph for this function:

Here is the caller graph for this function:

getElements()

ilADTGroupDBBridge::getElements

(

)

Returns

ilADTDBBridge[]

Definition at line 39 of file class.ilADTGroupDBBridge.php.

    {
        $this->prepareElements();
        return $this->elements;
    }

References $elements, and prepareElements().

Referenced by afterDelete(), afterInsert(), afterUpdate(), getElement(), prepareElements(), prepareInsert(), readRecord(), setPrimary(), and setTable().

Here is the call graph for this function:

Here is the caller graph for this function:

isValidADT()

ilADTGroupDBBridge::isValidADT ( ilADT  $a_adt )

protected

Check if given ADT is valid.

:TODO: This could be avoided with type-specifc constructors :TODO: bridge base class?

Parameters

ilADT

$a_adt

Reimplemented from ilADTDBBridge.

Definition at line 9 of file class.ilADTGroupDBBridge.php.

    {
        return ($a_adt instanceof ilADTGroup);
    }

prepareElements()

ilADTGroupDBBridge::prepareElements ( )

protected

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

    {
        if (sizeof($this->elements)) {
            return;
        }
        
        $this->elements = array();
        $factory = ilADTFactory::getInstance();
        
        // convert ADTs to DB bridges
        
        foreach ($this->getADT()->getElements() as $name => $element) {
            $this->elements[$name] = $factory->getDBBridgeForInstance($element);
            $this->elements[$name]->setElementId($name);
            $this->elements[$name]->setTable($this->getTable());
            $this->elements[$name]->setPrimary($this->getPrimary());
        }
    }

References $factory, $name, ilADTDBBridge\getADT(), getElements(), ilADTFactory\getInstance(), ilADTDBBridge\getPrimary(), and ilADTDBBridge\getTable().

Referenced by getElements().

Here is the call graph for this function:

Here is the caller graph for this function:

prepareInsert()

ilADTGroupDBBridge::prepareInsert

(

array &

$a_fields

)

Prepare ADT values for insert.

Parameters

array

&$a_fields

Reimplemented from ilADTDBBridge.

Definition at line 87 of file class.ilADTGroupDBBridge.php.

    {
        foreach ($this->getElements() as $element) {
            $element->prepareInsert($a_fields);
        }
    }

References getElements().

Here is the call graph for this function:

readRecord()

ilADTGroupDBBridge::readRecord

(

array

$a_row

)

Import DB values to ADT.

Parameters

array

$a_row

Reimplemented from ilADTDBBridge.

Definition at line 80 of file class.ilADTGroupDBBridge.php.

    {
        foreach ($this->getElements() as $element) {
            $element->readRecord($a_row);
        }
    }

References getElements().

Here is the call graph for this function:

setPrimary()

ilADTGroupDBBridge::setPrimary

(

array

$a_value

)

Set primary fields (in MDB2 format)

Parameters

array

$a_value

Reimplemented from ilADTDBBridge.

Definition at line 66 of file class.ilADTGroupDBBridge.php.

    {
        parent::setPrimary($a_value);
        
        if (sizeof($this->elements)) {
            foreach (array_keys($this->getADT()->getElements()) as $name) {
                $this->elements[$name]->setPrimary($this->getPrimary());
            }
        }
    }

References $name, ilADTDBBridge\getADT(), getElements(), and ilADTDBBridge\getPrimary().

Referenced by ilADTTest\initDBBridge().

Here is the call graph for this function:

Here is the caller graph for this function:

setTable()

ilADTGroupDBBridge::setTable

(

$a_table

)

Set table name.

Parameters

string

$a_table

Reimplemented from ilADTDBBridge.

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

    {
        parent::setTable($a_table);
        
        if (sizeof($this->elements)) {
            foreach (array_keys($this->getADT()->getElements()) as $name) {
                $this->elements[$name]->setTable($this->getTable());
            }
        }
    }

References $name, ilADTDBBridge\getADT(), getElements(), and ilADTDBBridge\getTable().

Referenced by ilADTTest\initDBBridge().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$elements

ilADTGroupDBBridge::$elements = []

protected

Definition at line 7 of file class.ilADTGroupDBBridge.php.

Referenced by getElements().

---

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

• Services/ADT/classes/Types/Group/class.ilADTGroupDBBridge.php