class.ilAdvancedMDRecordObjectOrderings.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilAdvancedMDRecordObjectOrderings
{
    private ilDBInterface $db;
    private array $record_position_map = [];

    public function __construct()
    {
        global $DIC;

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

    public function deleteByObjId(int $obj_id): void
    {
        $query = 'DELETE FROM adv_md_record_obj_ord ' .
            'WHERE obj_id = ' . $this->db->quote($obj_id, 'integer');
        $this->db->manipulate($query);
    }

    public function sortRecords(array $records, int $obj_id = null): array
    {
        // if local custom meta is not enabled use global sorting
        $use_global = true;
        if ($obj_id) {
            if (ilContainer::_lookupContainerSetting(
                $obj_id,
                ilObjectServiceSettingsGUI::CUSTOM_METADATA,
                ''
            )) {
                $use_global = false;
            }
        }
        if ($use_global) {
            usort(
                $records,
                [
                    __CLASS__,
                    'compareRecords'
                ]
            );
            return $records;
        } else {
            $this->readPositionsForObject($obj_id);
            usort(
                $records,
                [
                    __CLASS__,
                    'compareLocalRecords'
                ]
            );
        }
        return $records;
    }

    public function compareRecords(ilAdvancedMDRecord $a, ilAdvancedMDRecord $b): int
    {
        if ($a->getGlobalPosition() == null) {
            $a->setGlobalPosition(999);
        }
        if ($b->getGlobalPosition() == null) {
            $b->setGlobalPosition(999);
        }

        if ($a->getGlobalPosition() < $b->getGlobalPosition()) {
            return -1;
        }
        if ($a->getGlobalPosition() > $b->getGlobalPosition()) {
            return 1;
        }
        return 0;
    }

    public function compareLocalRecords(ilAdvancedMDRecord $a, ilAdvancedMDRecord $b): int
    {
        $local_pos_a = $this->record_position_map[$a->getRecordId()] ??
            ($a->getGlobalPosition() ?: 999);
        $local_pos_b = $this->record_position_map[$b->getRecordId()] ??
            ($b->getGlobalPosition() ?: 999);
        if ($local_pos_a < $local_pos_b) {
            return -1;
        }
        if ($local_pos_a > $local_pos_b) {
            return 1;
        }
        return 0;
    }

    protected function readPositionsForObject(int $obj_id): void
    {
        $query = 'SELECT record_id, position FROM adv_md_record_obj_ord ' .
            'WHERE obj_id = ' . $this->db->quote($obj_id, 'integer');
        $res = $this->db->query($query);

        $this->record_position_map = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->record_position_map[(int) $row->record_id] = (int) $row->position;
        }
    }
}