ilADTLocalizedTextDBBridge Class Reference

Class ilADTLocalizedTextDBBridge. More...

Inheritance diagram for ilADTLocalizedTextDBBridge:

Collaboration diagram for ilADTLocalizedTextDBBridge:

Public Member Functions
	getTable ()
	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...
	getAdditionalPrimaryFields ()
	afterUpdate ()
	After update hook to enable sub-tables. More...
Public Member Functions inherited from ilADTDBBridge
	__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 $adt)
	deleteTranslations ()
	insertTranslations ()
	Save all translations TODO: Translations are always persisted for all active languages, even if the translation is an empty string. More...
Protected Member Functions inherited from ilADTDBBridge
	isValidADT (ilADT $a_adt)
	setADT (ilADT $a_adt)

Additional Inherited Members
Protected Attributes inherited from ilADTDBBridge
ilADT	$adt
string	$table
string	$id
array	$primary = []
ilDBInterface	$db

Detailed Description

Class ilADTLocalizedTextDBBridge.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 25 of file class.ilADTLocalizedTextDBBridge.php.

Member Function Documentation

afterInsert()

ilADTLocalizedTextDBBridge::afterInsert

(

)

After insert hook to enable sub-tables.

Reimplemented from ilADTDBBridge.

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

                                 : void
    {
        $this->afterUpdate();
    }

References afterUpdate().

Here is the call graph for this function:

afterUpdate()

ilADTLocalizedTextDBBridge::afterUpdate

(

)

After update hook to enable sub-tables.

Reimplemented from ilADTDBBridge.

Definition at line 78 of file class.ilADTLocalizedTextDBBridge.php.

                                 : void
    {
        if (!$this->getADT()->getCopyOfDefinition()->supportsTranslations()) {
            return;
        }
        $this->deleteTranslations();
        $this->insertTranslations();
    }

References deleteTranslations(), ilADTDBBridge\getADT(), and insertTranslations().

Referenced by afterInsert().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteTranslations()

ilADTLocalizedTextDBBridge::deleteTranslations ( )

protected

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

                                           : void
    {
        $this->db->manipulate(
            $q =
            'delete from ' . $this->getTable() . ' ' .
            'where ' . $this->buildPrimaryWhere() . ' ' .
            'and value_index != ' . $this->db->quote('', ilDBConstants::T_TEXT)
        );
    }

References $q, ilADTDBBridge\buildPrimaryWhere(), getTable(), and ilDBConstants\T_TEXT.

Referenced by afterUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

getAdditionalPrimaryFields()

ilADTLocalizedTextDBBridge::getAdditionalPrimaryFields

(

)

Reimplemented from ilADTDBBridge.

Definition at line 71 of file class.ilADTLocalizedTextDBBridge.php.

                                                : array
    {
        return [
            'value_index' => [ilDBConstants::T_TEXT, '']
        ];
    }

References ilDBConstants\T_TEXT.

getTable()

ilADTLocalizedTextDBBridge::getTable

(

)

Reimplemented from ilADTDBBridge.

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

                              : ?string
    {
        return 'adv_md_values_ltext';
    }

Referenced by deleteTranslations(), and insertTranslations().

Here is the caller graph for this function:

insertTranslations()

ilADTLocalizedTextDBBridge::insertTranslations ( )

protected

Save all translations TODO: Translations are always persisted for all active languages, even if the translation is an empty string.

This shouldn't work that way.

Definition at line 102 of file class.ilADTLocalizedTextDBBridge.php.

                                           : void
    {
        foreach ($this->getADT()->getTranslations() as $language => $value) {
            $fields = $this->getPrimary();
            $fields['value_index'] = [ilDBConstants::T_TEXT, $language];
            $fields['value'] = [ilDBConstants::T_TEXT, $value];
            $this->db->insert($this->getTable(), $fields);
        }
    }

References ilADTDBBridge\getADT(), ilADTDBBridge\getPrimary(), getTable(), and ilDBConstants\T_TEXT.

Referenced by afterUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

isValidADT()

ilADTLocalizedTextDBBridge::isValidADT ( ilADT  $adt )

protected

Reimplemented from ilADTDBBridge.

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

                                             : bool
    {
        return $adt instanceof ilADTLocalizedText;
    }

References ilADTDBBridge\$adt.

prepareInsert()

ilADTLocalizedTextDBBridge::prepareInsert

(

array &

$a_fields

)

Prepare ADT values for insert.

Parameters

array

&$a_fields

Reimplemented from ilADTDBBridge.

Definition at line 58 of file class.ilADTLocalizedTextDBBridge.php.

                                                   : void
    {
        $a_fields[$this->getElementId()] = [ilDBConstants::T_TEXT, $this->getADT()->getText()];
    }

References ilADTDBBridge\getADT(), ilADTDBBridge\getElementId(), and ilDBConstants\T_TEXT.

Here is the call graph for this function:

readRecord()

ilADTLocalizedTextDBBridge::readRecord

(

array

$a_row

)

Import DB values to ADT.

Parameters

array

$a_row

Reimplemented from ilADTDBBridge.

Definition at line 37 of file class.ilADTLocalizedTextDBBridge.php.

                                            : void
    {
        $active_languages = $this->getADT()->getCopyOfDefinition()->getActiveLanguages();
        $default_language = $this->getADT()->getCopyOfDefinition()->getDefaultLanguage();
        $language = $a_row[$this->getElementId() . '_language'] ?? '';
 
        if (!$this->getADT()->getCopyOfDefinition()->getMultilingualValueSupport()) {
            $this->getADT()->setText($a_row[$this->getElementId() . '_translation' ]);
        } elseif (strcmp($language, $default_language) === 0) {
            $this->getADT()->setText($a_row[$this->getElementId() . '_translation']);
        } elseif (!strlen($default_language)) {
            $this->getADT()->setText($a_row[$this->getElementId() . '_translation']);
        }
        if (in_array($language, $active_languages)) {
            $this->getADT()->setTranslation(
                $language,
                (string) $a_row[$this->getElementId() . '_translation']
            );
        }
    }

References ilADTDBBridge\getADT(), and ilADTDBBridge\getElementId().

Here is the call graph for this function:

---

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

• components/ILIAS/ADT/classes/Types/LocalizedText/class.ilADTLocalizedTextDBBridge.php