class.ilMDRelation.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
class ilMDRelation extends ilMDBase
{
    private string $kind = '';
 
    // METHODS OF CHILD OBJECTS (Taxon)
 
    public function getIdentifier_Ids(): array
    {
        return ilMDIdentifier_::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_relation');
    }
 
    public function getIdentifier_(int $a_identifier__id): ?ilMDIdentifier_
    {
        if (!$a_identifier__id) {
            return null;
        }
        $ide = new ilMDIdentifier_();
        $ide->setMetaId($a_identifier__id);
 
        return $ide;
    }
 
    public function addIdentifier_(): ilMDIdentifier_
    {
        $ide = new ilMDIdentifier_($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $ide->setParentId($this->getMetaId());
        $ide->setParentType('meta_relation');
 
        return $ide;
    }
 
    public function getDescriptionIds(): array
    {
        return ilMDDescription::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_relation');
    }
 
    public function getDescription(int $a_description_id): ?ilMDDescription
    {
        if (!$a_description_id) {
            return null;
        }
        $des = new ilMDDescription();
        $des->setMetaId($a_description_id);
 
        return $des;
    }
 
    public function addDescription(): ilMDDescription
    {
        $des = new ilMDDescription($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $des->setParentId($this->getMetaId());
        $des->setParentType('meta_relation');
 
        return $des;
    }
 
    // SET/GET
    public function setKind(string $a_kind): bool
    {
        switch ($a_kind) {
            case 'IsPartOf':
            case 'HasPart':
            case 'IsVersionOf':
            case 'HasVersion':
            case 'IsFormatOf':
            case 'HasFormat':
            case 'References':
            case 'IsReferencedBy':
            case 'IsBasedOn':
            case 'IsBasisFor':
            case 'Requires':
            case 'IsRequiredBy':
                $this->kind = $a_kind;
                return true;
 
            default:
                return false;
        }
    }
 
    public function getKind(): string
    {
        return $this->kind;
    }
 
    public function save(): int
    {
        $fields = $this->__getFields();
        $fields['meta_relation_id'] = array('integer', $next_id = $this->db->nextId('il_meta_relation'));
 
        if ($this->db->insert('il_meta_relation', $fields)) {
            $this->setMetaId($next_id);
            return $this->getMetaId();
        }
        return 0;
    }
 
    public function update(): bool
    {
        return $this->getMetaId() && $this->db->update(
            'il_meta_relation',
            $this->__getFields(),
            array("meta_relation_id" => array('integer', $this->getMetaId()))
        );
    }
 
    public function delete(): bool
    {
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_relation " .
                "WHERE meta_relation_id = " . $this->db->quote($this->getMetaId(), 'integer');
            $res = $this->db->manipulate($query);
 
            foreach ($this->getIdentifier_Ids() as $id) {
                $ide = $this->getIdentifier_($id);
                $ide->delete();
            }
            foreach ($this->getDescriptionIds() as $id) {
                $des = $this->getDescription($id);
                $des->delete();
            }
 
            return true;
        }
        return false;
    }
 
    public function __getFields(): array
    {
        return array(
            'rbac_id' => array('integer', $this->getRBACId()),
            'obj_id' => array('integer', $this->getObjId()),
            'obj_type' => array('text', $this->getObjType()),
            'kind' => array('text', $this->getKind())
        );
    }
 
    public function read(): bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_relation " .
                "WHERE meta_relation_id = " . $this->db->quote($this->getMetaId(), 'integer');
 
            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $this->setRBACId((int) $row->rbac_id);
                $this->setObjId((int) $row->obj_id);
                $this->setObjType($row->obj_type);
                $this->setKind($row->kind ?? '');
            }
        }
        return true;
    }
 
    public function toXML(ilXmlWriter $writer): void
    {
        $writer->xmlStartTag('Relation', array(
            'Kind' => $this->getKind() ?: 'IsPartOf'
        ));
        $writer->xmlStartTag('Resource');
 
        // Identifier_
        $ides = $this->getIdentifier_Ids();
        foreach ($ides as $id) {
            $ide = $this->getIdentifier_($id);
            $ide->toXML($writer);
        }
        if (!count($ides)) {
            $ide = new ilMDIdentifier_($this->getRBACId(), $this->getObjId());
            $ide->toXML($writer);
        }
 
        // Description
        $dess = $this->getDescriptionIds();
        foreach ($dess as $id) {
            $des = $this->getDescription($id);
            $des->toXML($writer);
        }
        if (!count($dess)) {
            $des = new ilMDDescription($this->getRBACId(), $this->getObjId());
            $des->toXML($writer);
        }
 
        $writer->xmlEndTag('Resource');
        $writer->xmlEndTag('Relation');
    }
 
    // STATIC
 
    public static function _getIds(int $a_rbac_id, int $a_obj_id): array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = "SELECT meta_relation_id FROM il_meta_relation " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');
 
        $res = $ilDB->query($query);
        $ids = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $ids[] = (int) $row->meta_relation_id;
        }
        return $ids;
    }
}