ilADTDBBridge Class Reference

ADT DB bridge base class. More...

Inheritance diagram for ilADTDBBridge:

Collaboration diagram for ilADTDBBridge:

Public Member Functions
	__construct (ilADT $a_adt)
	Constructor. More...
	getADT ()
	setTable (string $a_table)
	getTable ()
	setElementId (string $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...
	getAdditionalPrimaryFields ()
	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)
	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)
	setADT (ilADT $a_adt)

Protected Attributes
ilADT	$adt
string	$table
string	$id
array	$primary = []
ilDBInterface	$db

Detailed Description

ADT DB bridge base class.

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 25 of file class.ilADTDBBridge.php.

Constructor & Destructor Documentation

__construct()

ilADTDBBridge::__construct

(

ilADT

$a_adt

)

Constructor.

Parameters

ilADT

$a_adt

Definition at line 38 of file class.ilADTDBBridge.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->setADT($a_adt);
    }

References $DIC, and setADT().

Here is the call graph for this function:

Member Function Documentation

afterDelete()

ilADTDBBridge::afterDelete

(

)

After delete hook to enable sub-tables.

Reimplemented in ilADTMultiDBBridge, and ilADTGroupDBBridge.

Definition at line 160 of file class.ilADTDBBridge.php.

                                 : void
    {
    }

afterInsert()

ilADTDBBridge::afterInsert

(

)

After insert hook to enable sub-tables.

Reimplemented in ilADTMultiDBBridge, ilADTGroupDBBridge, ilADTLocalizedTextDBBridge, and ilADTMultiEnumDBBridge.

Definition at line 141 of file class.ilADTDBBridge.php.

                                 : void
    {
    }

afterUpdate()

ilADTDBBridge::afterUpdate

(

)

After update hook to enable sub-tables.

Reimplemented in ilADTMultiDBBridge, ilADTGroupDBBridge, ilADTLocalizedTextDBBridge, and ilADTMultiEnumDBBridge.

Definition at line 153 of file class.ilADTDBBridge.php.

                                 : void
    {
    }

buildPrimaryWhere()

ilADTDBBridge::buildPrimaryWhere

(

)

Convert primary keys array to sql string.

Returns

string

See also

ilADTActiveRecord (:TODO: needed for multi)

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

                                       : string
    {
        $sql = [];
        foreach ($this->primary as $field => $def) {
            $sql[] = $field . "=" . $this->db->quote($def[1], $def[0]);
        }
        return implode(" AND ", $sql);
    }

Referenced by ilADTMultiEnumDBBridge\deleteIndices(), ilADTLocalizedTextDBBridge\deleteTranslations(), and ilADTMultiDBBridge\readRecord().

Here is the caller graph for this function:

getAdditionalPrimaryFields()

ilADTDBBridge::getAdditionalPrimaryFields

(

)

Reimplemented in ilADTLocalizedTextDBBridge.

Definition at line 98 of file class.ilADTDBBridge.php.

                                                : array
    {
        return [];
    }

getADT()

ilADTDBBridge::getADT

(

)

Definition at line 56 of file class.ilADTDBBridge.php.

                            : ilADT
    {
        return $this->adt;
    }

References $adt.

Referenced by ilADTLocalizedTextDBBridge\afterUpdate(), ilADTMultiEnumDBBridge\insertIndices(), ilADTLocalizedTextDBBridge\insertTranslations(), ilADTGroupDBBridge\prepareElements(), ilADTBooleanDBBridge\prepareInsert(), ilADTDateDBBridge\prepareInsert(), ilADTDateTimeDBBridge\prepareInsert(), ilADTEnumDBBridge\prepareInsert(), ilADTExternalLinkDBBridge\prepareInsert(), ilADTFloatDBBridge\prepareInsert(), ilADTIntegerDBBridge\prepareInsert(), ilADTInternalLinkDBBridge\prepareInsert(), ilADTLocalizedTextDBBridge\prepareInsert(), ilADTLocationDBBridge\prepareInsert(), ilADTTextDBBridge\prepareInsert(), ilADTMultiTextDBBridge\prepareMultiInsert(), ilADTMultiTextDBBridge\readMultiRecord(), ilADTBooleanDBBridge\readRecord(), ilADTDateDBBridge\readRecord(), ilADTDateTimeDBBridge\readRecord(), ilADTEnumDBBridge\readRecord(), ilADTExternalLinkDBBridge\readRecord(), ilADTFloatDBBridge\readRecord(), ilADTIntegerDBBridge\readRecord(), ilADTInternalLinkDBBridge\readRecord(), ilADTLocalizedTextDBBridge\readRecord(), ilADTLocationDBBridge\readRecord(), ilADTMultiEnumDBBridge\readRecord(), ilADTTextDBBridge\readRecord(), ilADTGroupDBBridge\setPrimary(), and ilADTGroupDBBridge\setTable().

Here is the caller graph for this function:

getElementId()

ilADTDBBridge::getElementId

(

)

Get element id.

Returns

string | null

Definition at line 84 of file class.ilADTDBBridge.php.

                                  : ?string
    {
        return $this->id;
    }

References $id.

Referenced by ilADTMultiDBBridge\getSubTableName(), ilADTBooleanDBBridge\prepareInsert(), ilADTDateDBBridge\prepareInsert(), ilADTDateTimeDBBridge\prepareInsert(), ilADTEnumDBBridge\prepareInsert(), ilADTExternalLinkDBBridge\prepareInsert(), ilADTFloatDBBridge\prepareInsert(), ilADTIntegerDBBridge\prepareInsert(), ilADTInternalLinkDBBridge\prepareInsert(), ilADTLocalizedTextDBBridge\prepareInsert(), ilADTLocationDBBridge\prepareInsert(), ilADTTextDBBridge\prepareInsert(), ilADTMultiTextDBBridge\prepareMultiInsert(), ilADTMultiTextDBBridge\readMultiRecord(), ilADTMultiDBBridge\readRecord(), ilADTBooleanDBBridge\readRecord(), ilADTDateDBBridge\readRecord(), ilADTDateTimeDBBridge\readRecord(), ilADTEnumDBBridge\readRecord(), ilADTExternalLinkDBBridge\readRecord(), ilADTFloatDBBridge\readRecord(), ilADTIntegerDBBridge\readRecord(), ilADTInternalLinkDBBridge\readRecord(), ilADTLocalizedTextDBBridge\readRecord(), ilADTLocationDBBridge\readRecord(), ilADTMultiEnumDBBridge\readRecord(), and ilADTTextDBBridge\readRecord().

Here is the caller graph for this function:

getPrimary()

ilADTDBBridge::getPrimary

(

)

Get primary fields.

Returns

array

Definition at line 107 of file class.ilADTDBBridge.php.

                                : array
    {
        return $this->primary;
    }

References $primary.

Referenced by ilADTGroupDBBridge\afterUpdateElement(), ilADTMultiEnumDBBridge\insertIndices(), ilADTLocalizedTextDBBridge\insertTranslations(), ilADTGroupDBBridge\prepareElements(), and ilADTGroupDBBridge\setPrimary().

Here is the caller graph for this function:

getTable()

ilADTDBBridge::getTable

(

)

Reimplemented in ilADTLocalizedTextDBBridge, and ilADTMultiEnumDBBridge.

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

                              : ?string
    {
        return $this->table;
    }

References $table.

Referenced by ilADTMultiDBBridge\getSubTableName(), ilADTGroupDBBridge\prepareElements(), and ilADTGroupDBBridge\setTable().

Here is the caller graph for this function:

isValidADT()

ilADTDBBridge::isValidADT ( ilADT  $a_adt )

abstractprotected

Reimplemented in ilADTBooleanDBBridge, ilADTDateDBBridge, ilADTDateTimeDBBridge, ilADTEnumDBBridge, ilADTExternalLinkDBBridge, ilADTFloatDBBridge, ilADTGroupDBBridge, ilADTIntegerDBBridge, ilADTInternalLinkDBBridge, ilADTLocationDBBridge, ilADTMultiEnumDBBridge, ilADTMultiTextDBBridge, ilADTTextDBBridge, and ilADTLocalizedTextDBBridge.

Referenced by setADT().

Here is the caller graph for this function:

prepareInsert()

ilADTDBBridge::prepareInsert ( array &  $a_fields )

abstract

Prepare ADT values for insert.

Parameters

array

&$a_fields

Reimplemented in ilADTMultiDBBridge, ilADTBooleanDBBridge, ilADTDateDBBridge, ilADTDateTimeDBBridge, ilADTEnumDBBridge, ilADTExternalLinkDBBridge, ilADTFloatDBBridge, ilADTGroupDBBridge, ilADTIntegerDBBridge, ilADTInternalLinkDBBridge, ilADTLocalizedTextDBBridge, ilADTLocationDBBridge, ilADTMultiEnumDBBridge, and ilADTTextDBBridge.

Referenced by prepareUpdate().

Here is the caller graph for this function:

prepareUpdate()

ilADTDBBridge::prepareUpdate

(

array &

$a_fields

)

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

                                                   : void
    {
        $this->prepareInsert($a_fields);
    }

References prepareInsert().

Here is the call graph for this function:

readRecord()

ilADTDBBridge::readRecord ( array  $a_row )

abstract

Import DB values to ADT.

Parameters

array

$a_row

Reimplemented in ilADTMultiDBBridge, ilADTBooleanDBBridge, ilADTDateDBBridge, ilADTDateTimeDBBridge, ilADTEnumDBBridge, ilADTExternalLinkDBBridge, ilADTFloatDBBridge, ilADTGroupDBBridge, ilADTIntegerDBBridge, ilADTInternalLinkDBBridge, ilADTLocalizedTextDBBridge, ilADTLocationDBBridge, ilADTMultiEnumDBBridge, and ilADTTextDBBridge.

setADT()

ilADTDBBridge::setADT ( ilADT  $a_adt )

protected

Definition at line 48 of file class.ilADTDBBridge.php.

                                           : void
    {
        if (!$this->isValidADT($a_adt)) {
            throw new \InvalidArgumentException('ADTDBBridge Type mismatch.');
        }
        $this->adt = $a_adt;
    }

References isValidADT().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

setElementId()

ilADTDBBridge::setElementId

(

string

$a_value

)

Set element id (aka DB column[s] [prefix])

Parameters

string

$a_value

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

                                                 : void
    {
        $this->id = $a_value;
    }

setPrimary()

ilADTDBBridge::setPrimary

(

array

$a_value

)

Set primary fields (in MDB2 format)

Parameters

array

$a_value

Reimplemented in ilADTGroupDBBridge.

Definition at line 93 of file class.ilADTDBBridge.php.

                                              : void
    {
        $this->primary = $a_value;
    }

Referenced by ilADTTest\initDBBridge().

Here is the caller graph for this function:

setTable()

ilADTDBBridge::setTable

(

string

$a_table

)

Reimplemented in ilADTGroupDBBridge.

Definition at line 61 of file class.ilADTDBBridge.php.

                                             : void
    {
        $this->table = $a_table;
    }

Referenced by ilADTTest\initDBBridge().

Here is the caller graph for this function:

supportsDefaultValueColumn()

ilADTDBBridge::supportsDefaultValueColumn

(

)

true if table storage relies on the default 'value' column

Returns

bool

Reimplemented in ilADTEnumDBBridge, ilADTExternalLinkDBBridge, ilADTLocationDBBridge, and ilADTMultiEnumDBBridge.

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

                                                : bool
    {
        return true;
    }

Field Documentation

$adt

ilADT ilADTDBBridge::$adt

protected

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

Referenced by getADT(), and ilADTLocalizedTextDBBridge\isValidADT().

$db

ilDBInterface ilADTDBBridge::$db

protected

Definition at line 32 of file class.ilADTDBBridge.php.

$id

string ilADTDBBridge::$id

protected

Definition at line 29 of file class.ilADTDBBridge.php.

Referenced by getElementId().

$primary

array ilADTDBBridge::$primary = []

protected

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

Referenced by getPrimary().

$table

string ilADTDBBridge::$table

protected

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

Referenced by getTable().

---

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

• components/ILIAS/ADT/classes/Bridges/class.ilADTDBBridge.php