class.ilADTDBBridge.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

abstract class ilADTDBBridge
{
    protected ilADT $adt;
    protected string $table;
    protected string $id;
    protected array $primary = [];

    protected ilDBInterface $db;

    public function __construct(ilADT $a_adt)
    {
        global $DIC;

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

    abstract protected function isValidADT(ilADT $a_adt): bool;

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

    public function getADT(): ilADT
    {
        return $this->adt;
    }

    public function setTable(string $a_table): void
    {
        $this->table = $a_table;
    }

    public function getTable(): ?string
    {
        return $this->table;
    }

    public function setElementId(string $a_value): void
    {
        $this->id = $a_value;
    }

    public function getElementId(): ?string
    {
        return $this->id;
    }

    public function setPrimary(array $a_value): void
    {
        $this->primary = $a_value;
    }

    public function getAdditionalPrimaryFields(): array
    {
        return [];
    }

    public function getPrimary(): array
    {
        return $this->primary;
    }

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

    abstract public function readRecord(array $a_row): void;

    abstract public function prepareInsert(array &$a_fields): void;

    public function afterInsert(): void
    {
    }

    public function prepareUpdate(array &$a_fields): void
    {
        $this->prepareInsert($a_fields);
    }

    public function afterUpdate(): void
    {
    }

    public function afterDelete(): void
    {
    }

    public function supportsDefaultValueColumn(): bool
    {
        return true;
    }
}