ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
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...
 
 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...
 

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 105 of file class.ilADTGroupDBBridge.php.

106 {
107 foreach ($this->getElements() as $element) {
108 $element->afterDelete();
109 }
110 }

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 91 of file class.ilADTGroupDBBridge.php.

92 {
93 foreach ($this->getElements() as $element) {
94 $element->afterInsert();
95 }
96 }

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 98 of file class.ilADTGroupDBBridge.php.

99 {
100 foreach ($this->getElements() as $element) {
101 $element->afterUpdate();
102 }
103 }

References getElements().

+ Here is the call graph for this function:

◆ getElement()

ilADTGroupDBBridge::getElement (   $a_element_id)

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

43 {
44 if (array_key_exists($a_element_id, $this->getElements())) {
45 return $this->elements[$a_element_id];
46 }
47 }

References getElements().

+ Here is the call graph for this function:

◆ getElements()

ilADTGroupDBBridge::getElements ( )

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

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.

10 {
11 return ($a_adt instanceof ilADTGroup);
12 }

◆ prepareElements()

ilADTGroupDBBridge::prepareElements ( )
protected

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

18 {
19 if (sizeof($this->elements)) {
20 return;
21 }
22
23 $this->elements = array();
25
26 // convert ADTs to DB bridges
27
28 foreach ($this->getADT()->getElements() as $name => $element) {
29 $this->elements[$name] = $factory->getDBBridgeForInstance($element);
30 $this->elements[$name]->setElementId($name);
31 $this->elements[$name]->setTable($this->getTable());
32 $this->elements[$name]->setPrimary($this->getPrimary());
33 }
34 }
getPrimary()
Get primary fields.
getTable()
Get table name.
static getInstance()
Get singleton.
$factory
Definition: metadata.php:58
if($format !==null) $name
Definition: metadata.php:230

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 84 of file class.ilADTGroupDBBridge.php.

85 {
86 foreach ($this->getElements() as $element) {
87 $element->prepareInsert($a_fields);
88 }
89 }

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 77 of file class.ilADTGroupDBBridge.php.

78 {
79 foreach ($this->getElements() as $element) {
80 $element->readRecord($a_row);
81 }
82 }

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 63 of file class.ilADTGroupDBBridge.php.

64 {
65 parent::setPrimary($a_value);
66
67 if (sizeof($this->elements)) {
68 foreach (array_keys($this->getADT()->getElements()) as $name) {
69 $this->elements[$name]->setPrimary($this->getPrimary());
70 }
71 }
72 }

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 52 of file class.ilADTGroupDBBridge.php.

53 {
54 parent::setTable($a_table);
55
56 if (sizeof($this->elements)) {
57 foreach (array_keys($this->getADT()->getElements()) as $name) {
58 $this->elements[$name]->setTable($this->getTable());
59 }
60 }
61 }

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: