class.ActiveRecord.php

Go to the documentation of this file.

<?php

/******************************************************************************
 *
 * This file is part of ILIAS, a powerful learning management system.
 *
 * ILIAS is licensed with the GPL-3.0, you should have received a copy
 * of said license along with the source code.
 *
 * If this is not the case or you just want to try ILIAS, you'll find
 * us at:
 * https://www.ilias.de
 * https://github.com/ILIAS-eLearning
 *
 *****************************************************************************/
abstract class ActiveRecord
{
    protected bool $ar_safe_read = true;
    protected string $connector_container_name = '';
    protected bool $is_new = true;

    public function getArConnector(): \arConnector
    {
        return arConnectorMap::get($this);
    }

    public function getArFieldList(): \arFieldList
    {
        return arFieldCache::get($this);
    }

    public static function returnDbTableName(): string
    {
        throw new arException(
            arException::UNKNONWN_EXCEPTION,
            'Implement getConnectorContainerName in your child-class'
        );
    }

    public function getConnectorContainerName(): string
    {
        // WILL BE ABSTRACT TO REPLACE returnDbTableName() IN NEXT VERSION
        if ($this->connector_container_name) {
            return $this->connector_container_name;
        }

        $ar = self::getCalledClass();

        return $ar::returnDbTableName();
    }

    public function setConnectorContainerName(string $connector_container_name): void
    {
        $this->connector_container_name = $connector_container_name;
    }

    public function getPrimaryFieldValue()
    {
        $primary_fieldname = arFieldCache::getPrimaryFieldName($this);

        return $this->{$primary_fieldname};
    }

    public function setPrimaryFieldValue($value): void
    {
        $primary_fieldname = arFieldCache::getPrimaryFieldName($this);

        $this->{$primary_fieldname} = $value;
    }

    public function __construct($primary_key = 0)
    {
        $arFieldList = arFieldCache::get($this);

        $key = $arFieldList->getPrimaryFieldName();
        $this->{$key} = $primary_key;
        if ($primary_key !== 0 && $primary_key !== null && $primary_key !== false) {
            $this->read();
        }
    }

    public function storeObjectToCache(): void
    {
        arObjectCache::store($this);
    }

    public function asStdClass(): \stdClass
    {
        $return = new stdClass();
        foreach ($this->getArFieldList()->getFields() as $field) {
            $fieldname = $field->getName();
            $return->{$fieldname} = $this->{$fieldname};
        }

        return $return;
    }

    public function buildFromArray(array $array): \ActiveRecord
    {
        $class = get_class($this);
        $primary = $this->getArFieldList()->getPrimaryFieldName();
        $primary_value = $array[$primary];
        if ($primary_value && arObjectCache::isCached($class, $primary_value)) {
            return arObjectCache::get($class, $primary_value);
        }
        foreach ($array as $field_name => $value) {
            $waked = $this->wakeUp($field_name, $value);
            $this->{$field_name} = $waked ?? $value;
        }
        arObjectCache::store($this);

        return $this;
    }

    public function fixDateField($field_name, $value)
    {
        if ($this->getArFieldList()->getFieldByName($field_name)->isDateField()) {
            return $this->getArConnector()->fixDate($value);
        }

        return $value;
    }

    public function sleep($field_name)
    {
        return null;
    }

    public function wakeUp($field_name, $field_value)
    {
        return null;
    }

    final public function getArrayForConnector(): array
    {
        $data = array();
        foreach ($this->getArFieldList()->getFields() as $field) {
            $field_name = $field->getName();
            $sleeped = $this->sleep($field_name);
            $var = $sleeped ?? ($this->{$field_name});
            $data[$field_name] = array($field->getFieldType(), $var);
        }

        return $data;
    }




    //
    // Collector Modifications
    //
    protected static function getCalledClass(): \ActiveRecord
    {
        $class = static::class;

        return arCalledClassCache::get($class);
    }

    final public static function installDB(): bool
    {
        return self::getCalledClass()->installDatabase();
    }

    public function installConnector(): bool
    {
        return $this->installDatabase();
    }

    final public static function renameDBField(string $old_name, string $new_name): bool
    {
        return self::getCalledClass()->getArConnector()->renameField(self::getCalledClass(), $old_name, $new_name);
    }

    final public static function tableExists(): bool
    {
        return self::getCalledClass()->getArConnector()->checkTableExists(self::getCalledClass());
    }

    final public static function fieldExists(string $field_name): bool
    {
        return self::getCalledClass()->getArConnector()->checkFieldExists(self::getCalledClass(), $field_name);
    }

    final public static function removeDBField(string $field_name): bool
    {
        return self::getCalledClass()->getArConnector()->removeField(self::getCalledClass(), $field_name);
    }
    final protected function installDatabase(): bool
    {
        if (!self::tableExists()) {
            $fields = array();
            if (isset($this)) {
                foreach ($this->getArFieldList()->getFields() as $field) {
                    $fields[$field->getName()] = $field->getAttributesForConnector();
                }
            }

            return $this->getArConnector()->installDatabase($this, $fields);
        }

        return $this->getArConnector()->updateDatabase($this);
    }

    final public static function updateDB(): bool
    {
        if (!self::tableExists()) {
            self::getCalledClass()->installDatabase();

            return true;
        }

        return self::getCalledClass()->getArConnector()->updateDatabase(self::getCalledClass());
    }
    final public static function resetDB(): bool
    {
        return self::getCalledClass()->getArConnector()->resetDatabase(self::getCalledClass());
    }

    final public static function truncateDB(): void
    {
        self::getCalledClass()->getArConnector()->truncateDatabase(self::getCalledClass());
    }
    final public static function flushDB(): void
    {
        self::truncateDB();
    }

    //
    // CRUD
    //
    public function store(): void
    {
        $primary_fieldname = arFieldCache::getPrimaryFieldName($this);
        $primary_value = $this->getPrimaryFieldValue();

        if (!self::where(array($primary_fieldname => $primary_value))->hasSets()) {
            $this->create();
        } else {
            $this->update();
        }
    }

    public function save(): void
    {
        $this->store();
    }

    public function create(): void
    {
        if ($this->getArFieldList()->getPrimaryField()->getSequence()) {
            $primary_fieldname = arFieldCache::getPrimaryFieldName($this);
            $this->{$primary_fieldname} = $this->getArConnector()->nextID($this);
        }

        $this->getArConnector()->create($this);
        arObjectCache::store($this);
    }

    public function copy(int $new_id = 0): self
    {
        if (self::where(array($this->getArFieldList()->getPrimaryFieldName() => $new_id))->hasSets()) {
            throw new arException(arException::COPY_DESTINATION_ID_EXISTS);
        }
        $new_obj = clone($this);
        $new_obj->setPrimaryFieldValue($new_id);

        return $new_obj;
    }

    public function afterObjectLoad(): void
    {
    }

    public function read(): void
    {
        $records = $this->getArConnector()->read($this);
        if ($this->ar_safe_read === true && is_array($records) && count($records) === 0) {
            throw new arException(arException::RECORD_NOT_FOUND, $this->getPrimaryFieldValue());
        } elseif ($this->ar_safe_read === false && is_array($records) && count($records) === 0) {
            $this->is_new = true;
        }
        $records = is_array($records) ? $records : array();
        foreach ($records as $rec) {
            foreach ($this->getArrayForConnector() as $k => $v) {
                $waked = $this->wakeUp($k, $rec->{$k} ?? null);
                $this->{$k} = $waked ?? $rec->{$k} ?? null;
            }
            arObjectCache::store($this);
        }
    }

    public function update()
    {
        $this->getArConnector()->update($this);
        arObjectCache::store($this);
    }

    public function delete()
    {
        $this->getArConnector()->delete($this);
        arObjectCache::purge($this);
    }



    //
    // Collection
    //
    public static function preloadObjects(): array
    {
        return self::get();
    }

    public static function additionalParams(array $additional_params): \ActiveRecordList
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());
        $srModelObjectList->additionalParams($additional_params);

        return $srModelObjectList;
    }

    public static function find($primary_key, array $add_constructor_args = array()): ?\ActiveRecord
    {
        try {
            $class_name = static::class;
            if (!arObjectCache::isCached($class_name, $primary_key)) {
                $obj = arFactory::getInstance($class_name, $primary_key, $add_constructor_args);
                $obj->storeObjectToCache();

                return $obj;
            }
        } catch (arException $e) {
            return null;
        }

        try {
            $obj = arObjectCache::get($class_name, $primary_key);
        } catch (arException $e) {
            return null;
        }

        return $obj;
    }

    public static function findOrFail($primary_key, array $add_constructor_args = array()): \ActiveRecord
    {
        $obj = self::find($primary_key, $add_constructor_args);
        if (is_null($obj)) {
            throw new arException(arException::RECORD_NOT_FOUND);
        }

        return $obj;
    }

    public static function findOrGetInstance($primary_key, array $add_constructor_args = array())
    {
        $obj = self::find($primary_key, $add_constructor_args);
        if ($obj !== null) {
            return $obj;
        }

        $class_name = static::class;
        $obj = arFactory::getInstance($class_name, 0, $add_constructor_args);
        $obj->setPrimaryFieldValue($primary_key);
        $obj->is_new = true;
        $obj->storeObjectToCache();

        return $obj;
    }

    public static function where($where, $operator = null): \ActiveRecordList
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());
        $srModelObjectList->where($where, $operator);

        return $srModelObjectList;
    }

    public static function innerjoinAR(
        ActiveRecord $ar,
        $on_this,
        $on_external,
        array $fields = array('*'),
        string $operator = '=',
        $both_external = false
    ): \ActiveRecordList {
        return self::innerjoin(
            $ar->getConnectorContainerName(),
            $on_this,
            $on_external,
            $fields,
            $operator,
            $both_external
        );
    }

    public static function innerjoin(
        $tablename,
        $on_this,
        $on_external,
        array $fields = array('*'),
        string $operator = '=',
        bool $both_external = false
    ): \ActiveRecordList {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());

        return $srModelObjectList->innerjoin($tablename, $on_this, $on_external, $fields, $operator, $both_external);
    }

    public static function leftjoin(
        $tablename,
        $on_this,
        $on_external,
        array $fields = array('*'),
        string $operator = '=',
        bool $both_external = false
    ): \ActiveRecordList {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());

        return $srModelObjectList->leftjoin($tablename, $on_this, $on_external, $fields, $operator, $both_external);
    }

    public static function orderBy($orderBy, string $orderDirection = 'ASC'): \ActiveRecordList
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());
        $srModelObjectList->orderBy($orderBy, $orderDirection);

        return $srModelObjectList;
    }

    public static function dateFormat(string $date_format = 'd.m.Y - H:i:s'): \ActiveRecordList
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());
        $srModelObjectList->dateFormat($date_format);

        return $srModelObjectList;
    }

    public static function limit($start, $end): \ActiveRecordList
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());
        $srModelObjectList->limit($start, $end);

        return $srModelObjectList;
    }

    public static function affectedRows(): int
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());

        return $srModelObjectList->affectedRows();
    }

    public static function count(): int
    {
        return self::affectedRows();
    }

    public static function get(): array
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());

        return $srModelObjectList->get();
    }

    public static function debug(): \ActiveRecordList
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());

        return $srModelObjectList->debug();
    }

    public static function first(): ?\ActiveRecord
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());

        return $srModelObjectList->first();
    }

    public static function getCollection(): \ActiveRecordList
    {
        return new ActiveRecordList(self::getCalledClass());
        ;
    }

    public static function last(): ?\ActiveRecord
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());

        return $srModelObjectList->last();
    }

    public static function getFirstFromLastQuery(): ?\ActiveRecord
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());

        return $srModelObjectList->getFirstFromLastQuery();
    }

    public static function connector(arConnector $connector): \ActiveRecordList
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());

        return $srModelObjectList->connector($connector);
    }

    public static function raw(bool $set_raw = true): \ActiveRecordList
    {
        $srModelObjectList = new ActiveRecordList(self::getCalledClass());

        return $srModelObjectList->raw($set_raw);
    }

    public static function getArray(?string $key = null, $values = null): array
    {
        $record_list = new ActiveRecordList(self::getCalledClass());

        return $record_list->getArray($key, $values);
    }

    //
    // Magic Methods & Helpers
    //
    public function __call($name, $arguments)
    {
        // Getter
        if (preg_match("/get([a-zA-Z]*)/u", $name, $matches) && count($arguments) === 0) {
            return $this->{self::fromCamelCase($matches[1])};
        }
        // Setter
        if (preg_match("/set([a-zA-Z]*)/u", $name, $matches) && count($arguments) === 1) {
            $this->{self::fromCamelCase($matches[1])} = $arguments[0];
        }
    }

    public static function _toCamelCase(string $str, bool $capitalise_first_char = false): ?string
    {
        if ($capitalise_first_char) {
            $str[0] = strtoupper($str[0]);
        }

        return preg_replace_callback('/_([a-z])/', fn ($c) => strtoupper($c[1]), $str);
    }

    protected static function fromCamelCase(string $str): ?string
    {
        $str[0] = strtolower($str[0]);

        return preg_replace_callback('/([A-Z])/', fn ($c) => "_" . strtolower($c[1]), $str);
    }
}