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 ()
	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...
	setADT (ilADT $a_adt)
	Set ADT. More...

Protected Attributes
	$adt
	$table
	$id
	$primary = []

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilADTDBBridge::__construct

(

ilADT

$a_adt

)

Constructor.

Parameters

ilADT

$a_adt

Returns

self

Reimplemented in ilADTLocalizedTextDBBridge, and ilADTMultiEnumDBBridge.

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

    {
        $this->setADT($a_adt);
    }

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

    {
    }

afterInsert()

ilADTDBBridge::afterInsert

(

)

After insert hook to enable sub-tables.

Reimplemented in ilADTMultiDBBridge, ilADTGroupDBBridge, ilADTLocalizedTextDBBridge, and ilADTMultiEnumDBBridge.

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

    {
    }

afterUpdate()

ilADTDBBridge::afterUpdate

(

)

After update hook to enable sub-tables.

Reimplemented in ilADTMultiDBBridge, ilADTGroupDBBridge, ilADTLocalizedTextDBBridge, and ilADTMultiEnumDBBridge.

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

    {
    }

buildPrimaryWhere()

ilADTDBBridge::buildPrimaryWhere

(

)

Convert primary keys array to sql string.

See also

ilADTActiveRecord (:TODO: needed for multi)

Returns

string

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
                
        $sql = array();
        
        foreach ($this->primary as $field => $def) {
            $sql[] = $field . "=" . $ilDB->quote($def[1], $def[0]);
        }
        
        return implode(" AND ", $sql);
    }

References $DIC, and $ilDB.

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

Here is the caller graph for this function:

getADT()

ilADTDBBridge::getADT

(

)

Get ADT.

Returns

ilADT

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

    {
        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

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

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

    {
        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

(

)

Get table name.

Returns

string

Reimplemented in ilADTLocalizedTextDBBridge, and ilADTMultiEnumDBBridge.

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

    {
        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

Check if given ADT is valid.

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

Parameters

ilADT

$a_adt

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

)

Prepare ADT values for update.

See also

prepareInsert()

Parameters

array

&$a_fields

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

    {
        $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

Set ADT.

Exceptions

Exception

Parameters

ilADT

$a_adt

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

    {
        if (!$this->isValidADT($a_adt)) {
            throw new Exception('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

(

$a_value

)

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

Parameters

string

$a_value

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

    {
        $this->id = (string) $a_value;
    }

setPrimary()

ilADTDBBridge::setPrimary

(

array

$a_value

)

Set primary fields (in MDB2 format)

Parameters

array

$a_value

Reimplemented in ilADTGroupDBBridge.

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

    {
        $this->primary = $a_value;
    }

setTable()

ilADTDBBridge::setTable

(

$a_table

)

Set table name.

Parameters

string

$a_table

Reimplemented in ilADTGroupDBBridge.

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

    {
        $this->table = (string) $a_table;
    }

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

                                                 : bool
    {
        return true;
    }

Field Documentation

$adt

ilADTDBBridge::$adt

protected

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

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

$id

ilADTDBBridge::$id

protected

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

Referenced by getElementId().

$primary

ilADTDBBridge::$primary = []

protected

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

Referenced by getPrimary().

$table

ilADTDBBridge::$table

protected

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

Referenced by getTable().

---

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

• Services/ADT/classes/Bridges/class.ilADTDBBridge.php