class.ilMDBase.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

abstract class ilMDBase
{
    private int $rbac_id;

    private int $obj_id;

    private string $obj_type;

    private ?int $meta_id = null;
    private int $parent_id;
    private string $parent_type;

    private bool $export_mode = false;

    protected ilLogger $log;
    protected ilDBInterface $db;

    public function __construct(
        int $a_rbac_id = 0,
        int $a_obj_id = 0,
        string $a_type = ''
    ) {
        global $DIC;

        $this->db = $DIC->database();

        if ($a_obj_id === 0) {
            $a_obj_id = $a_rbac_id;
        }

        $this->log = ilLoggerFactory::getLogger("meta");

        $this->rbac_id = $a_rbac_id;
        $this->obj_id = $a_obj_id;
        $this->obj_type = $a_type;
    }

    abstract public function read(): bool;

    // SET/GET
    public function setRBACId(int $a_id): void
    {
        $this->rbac_id = $a_id;
    }

    public function getRBACId(): int
    {
        return $this->rbac_id;
    }

    public function setObjId(int $a_id): void
    {
        $this->obj_id = $a_id;
    }

    public function getObjId(): int
    {
        return $this->obj_id;
    }

    public function setObjType(string $a_type): void
    {
        $this->obj_type = $a_type;
    }

    public function getObjType(): string
    {
        return $this->obj_type;
    }

    public function setMetaId(int $a_meta_id, bool $a_read_data = true): void
    {
        $this->meta_id = $a_meta_id;

        if ($a_read_data) {
            $this->read();
        }
    }

    public function getMetaId(): ?int
    {
        return $this->meta_id;
    }

    public function setParentType(string $a_parent_type): void
    {
        $this->parent_type = $a_parent_type;
    }

    public function getParentType(): string
    {
        return $this->parent_type;
    }

    public function setParentId(int $a_id): void
    {
        $this->parent_id = $a_id;
    }

    public function getParentId(): int
    {
        return $this->parent_id;
    }

    public function setExportMode(bool $a_export_mode = true): void
    {
        $this->export_mode = $a_export_mode;
    }

    public function getExportMode(): bool
    {
        return $this->export_mode;
    }

    public function validate(): bool
    {
        return false;
    }

    public function update(): bool
    {
        return false;
    }

    public function save(): int
    {
        return 0;
    }

    public function delete(): bool
    {
        return false;
    }

    public function toXML(ilXmlWriter $writer): void
    {
    }
}