class.ilADTBasedObject.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 ilADTBasedObject
{
    protected ilADT $properties;
    protected array $db_errors = [];

    protected ilDBInterface $db;
    protected ilLanguage $lng;

    public function __construct()
    {
        global $DIC;
        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->properties = $this->initProperties();

        // :TODO: to keep constructor "open" we COULD use func_get_args()
        $this->parsePrimary(func_get_args());
        $this->read();
    }


    //
    // properties
    //

    abstract protected function initProperties(): ilADT;

    public function getProperties(): ilADT
    {
        return $this->properties;
    }

    public function isValid(): bool
    {
        return $this->properties->isValid();
    }

    public function __call($a_method, $a_value)
    {
        $type = substr($a_method, 0, 3);
        switch ($type) {
            case "get":
                $parsed = strtolower(preg_replace("/([A-Z])/", " $1", substr($a_method, 3)));
                $parsed = str_replace(" ", "_", trim($parsed));
                if (!$this->properties->hasElement($parsed)) {
                    throw new Exception("ilADTObject unknown property " . $parsed);
                }
                return $this->properties->getElement($parsed);

            default:
                throw new Exception("ilADTObject unknown type: " . $type);
        }
    }


    //
    // CRUD / active record
    //

    abstract protected function parsePrimary(array $a_args): void;

    abstract protected function hasPrimary(): bool;

    abstract protected function createPrimaryKeyb(): bool;

    abstract protected function initDBBridge(ilADTDBBridge $a_adt_db): void;

    protected function initActiveRecordInstance(): ilADTActiveRecord
    {
        if (!$this->hasPrimary()) {
            throw new Exception("ilADTBasedObject no primary");
        }

        $factory = ilADTFactory::getInstance();
        $adt_db = $factory->getDBBridgeForInstance($this->properties);
        $this->initDBBridge($adt_db);

        // use custom error handling
        //FIXME
        //$this->db->exception = "ilADTDBException";

        return $factory->getActiveRecordInstance($adt_db);
    }

    public function read(): bool
    {
        if ($this->hasPrimary()) {
            $rec = $this->initActiveRecordInstance();
            return $rec->read();
        }
        return false;
    }

    public function create(): bool
    {
        if ($this->hasPrimary()) {
            return $this->update();
        }

        if ($this->isValid()) {
            if ($this->createPrimaryKeyb()) {
                try {
                    $rec = $this->initActiveRecordInstance();
                    $rec->create();
                } catch (ilADTDBException $e) {
                    $this->db_errors[$e->getColumn()][] = $e->getCode();
                    return false;
                }
                return true;
            }
        }
        return false;
    }

    public function update(): bool
    {
        if (!$this->hasPrimary()) {
            return $this->create();
        }

        if ($this->isValid()) {
            try {
                $rec = $this->initActiveRecordInstance();
                $rec->update();
            } catch (ilADTDBException $e) {
                $this->db_errors[$e->getColumn()][] = $e->getCode();
                return false;
            }
            return true;
        }
        return false;
    }

    public function delete(): bool
    {
        if ($this->hasPrimary()) {
            $rec = $this->initActiveRecordInstance();
            $rec->delete();
            return true;
        }
        return false;
    }

    public function getDBErrors(): array
    {
        return $this->db_errors;
    }

    public function translateDBErrorCodes(array $a_codes): array
    {
        $res = array();

        foreach ($a_codes as $code) {
            switch ($code) {
                default:
                    $res[] = "Unknown ADT error code " . $code;
                    break;
            }
        }
        return $res;
    }

    public function getAllTranslatedErrors(string $delimiter = "\n"): string
    {
        $tmp = array();

        foreach ($this->getProperties()->getValidationErrorsByElements() as $error_code => $element_id) {
            $tmp[] = $element_id . " [validation]: " . $this->getProperties()->translateErrorCode($error_code);
        }

        foreach ($this->getDBErrors() as $element_id => $codes) {
            $tmp[] = $element_id . " [db]: " . implode($delimiter, $this->translateDBErrorCodes($codes));
        }

        if (count($tmp)) {
            return get_class($this) . $delimiter . implode($delimiter, $tmp);
        }
        return '';
    }
}