class.ilMDRights.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilMDRights extends ilMDBase
{
    private const YES_NO_TRANSLATION = [
        'yes' => 'Yes',
        'no' => 'No'
    ];

    private string $costs = '';
    private string $caor = '';
    private string $description = '';
    private ?ilMDLanguageItem $description_language = null;

    public static function lookupRightsByTypeAndCopyright(array $a_types, array $a_copyright): array
    {
        global $DIC;

        $db = $DIC->database();

        $query = 'SELECT rbac_id FROM il_meta_rights ' .
            'WHERE ' . $db->in('obj_type', $a_types, false, 'text') . ' ' .
            'AND ' . $db->in('description', $a_copyright, false, 'text');
        $res = $db->query($query);

        ilLoggerFactory::getLogger('meta')->info($query);

        $obj_ids = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $obj_ids[] = (int) $row->rbac_id;
        }
        return $obj_ids;
    }

    // SET/GET
    public function setCosts(string $a_costs): bool
    {
        switch ($a_costs) {
            case 'Yes':
            case 'No':
                $this->costs = $a_costs;
                return true;

            default:
                return false;
        }
    }

    public function getCosts(): string
    {
        return $this->costs;
    }

    public function setCopyrightAndOtherRestrictions(string $a_caor): bool
    {
        switch ($a_caor) {
            case 'Yes':
            case 'No':
                $this->caor = $a_caor;
                return true;

            default:
                return false;
        }
    }

    public function getCopyrightAndOtherRestrictions(): string
    {
        return $this->caor;
    }

    public function setDescription(string $a_description): void
    {
        $this->description = $a_description;
    }

    public function getDescription(): string
    {
        return $this->description;
    }

    public function setDescriptionLanguage(ilMDLanguageItem $lng_obj): void
    {
        $this->description_language = $lng_obj;
    }

    public function getDescriptionLanguage(): ?ilMDLanguageItem
    {
        return is_object($this->description_language) ? $this->description_language : null;
    }

    public function getDescriptionLanguageCode(): string
    {
        return is_object($this->description_language) ? $this->description_language->getLanguageCode() : '';
    }

    public function save(): int
    {
        $fields = $this->__getFields();
        $fields['meta_rights_id'] = array('integer', $next_id = $this->db->nextId('il_meta_rights'));

        if ($this->db->insert('il_meta_rights', $fields)) {
            $this->setMetaId($next_id);
            return $this->getMetaId();
        }
        return 0;
    }

    public function update(): bool
    {
        return $this->getMetaId() && $this->db->update(
            'il_meta_rights',
            $this->__getFields(),
            array("meta_rights_id" => array('integer', $this->getMetaId()))
        );
    }

    public function delete(): bool
    {
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_rights " .
                "WHERE meta_rights_id = " . $this->db->quote($this->getMetaId(), 'integer');

            $this->db->query($query);

            return true;
        }
        return false;
    }

    public function __getFields(): array
    {
        $costs = (string) array_search(
            $this->getCosts(),
            self::YES_NO_TRANSLATION
        );
        $cpr_and_or = (string) array_search(
            $this->getCopyrightAndOtherRestrictions(),
            self::YES_NO_TRANSLATION
        );

        return array(
            'rbac_id' => array('integer', $this->getRBACId()),
            'obj_id' => array('integer', $this->getObjId()),
            'obj_type' => array('text', $this->getObjType()),
            'costs' => array('text', $costs),
            'cpr_and_or' => array('text', $cpr_and_or),
            'description' => array('text', $this->getDescription()),
            'description_language' => array('text', $this->getDescriptionLanguageCode())
        );
    }

    public function read(): bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_rights " .
                "WHERE meta_rights_id = " . $this->db->quote($this->getMetaId(), 'integer');

            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                if (key_exists($row->costs ?? '', self::YES_NO_TRANSLATION)) {
                    $row->costs = self::YES_NO_TRANSLATION[$row->costs ?? ''];
                }
                if (key_exists($row->cpr_and_or ?? '', self::YES_NO_TRANSLATION)) {
                    $row->cpr_and_or = self::YES_NO_TRANSLATION[$row->cpr_and_or ?? ''];
                }

                $this->setRBACId((int) $row->rbac_id);
                $this->setObjId((int) $row->obj_id);
                $this->setObjType($row->obj_type ?? '');
                $this->setDescription($row->description ?? '');
                $this->setDescriptionLanguage(new ilMDLanguageItem($row->description_language ?? ''));
                $this->setCosts($row->costs ?? '');
                $this->setCopyrightAndOtherRestrictions($row->cpr_and_or ?? '');
            }
            return true;
        }
        return false;
    }

    public function toXML(ilXmlWriter $writer): void
    {
        $writer->xmlStartTag('Rights', array(
            'Cost' => $this->getCosts() ?: 'No',
            'CopyrightAndOtherRestrictions' => $this->getCopyrightAndOtherRestrictions() ?: 'No'
        ));

        $writer->xmlElement(
            'Description',
            [
                'Language' => $this->getDescriptionLanguageCode() ?: 'en'
            ],
            ilMDCopyrightSelectionEntry::_lookupCopyrightForExport($this->getDescription())
        );
        $writer->xmlEndTag('Rights');
    }

    public function parseDescriptionFromImport(string $a_description): void
    {
        $entry_id = ilMDCopyrightSelectionEntry::lookupCopyrightFromImport($a_description);
        if (!$entry_id) {
            $this->setDescription($a_description);
        } else {
            $this->setDescription(ilMDCopyrightSelectionEntry::createIdentifier($entry_id));
        }
    }

    public static function _lookupDescription(int $a_rbac_id, int $a_obj_id): string
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT description FROM il_meta_rights " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);

        if (isset($row) && isset($row->description)) {
            return $row->description;
        }
        return '';
    }

    // STATIC
    public static function _getId(int $a_rbac_id, int $a_obj_id): int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_rights_id FROM il_meta_rights " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');

        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->meta_rights_id;
        }
        return 0;
    }
}