class.ilWaitingList.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
abstract class ilWaitingList
{
    public static array $is_on_list = [];
    private int $obj_id = 0;
    private array $user_ids = [];
    private array $users = [];
    protected ilDBInterface $db;
    protected ilAppEventHandler $eventHandler;
 
    public function __construct(int $a_obj_id)
    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->eventHandler = $DIC->event();
        $this->obj_id = $a_obj_id;
        if ($a_obj_id) {
            $this->read();
        }
    }
 
    public static function lookupListSize(int $a_obj_id): int
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $query = 'SELECT count(usr_id) num from crs_waiting_list WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->num;
        }
        return 0;
    }
 
    public static function _deleteAll(int $a_obj_id): void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = "DELETE FROM crs_waiting_list WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }
 
    public static function _deleteUser(int $a_usr_id): void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $query = "DELETE FROM crs_waiting_list WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer');
        $res = $ilDB->manipulate($query);
    }
 
    public static function deleteUserEntry(int $a_usr_id, int $a_obj_id): void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $query = "DELETE FROM crs_waiting_list " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . ' ' .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');
        $ilDB->query($query);
    }
 
    public function getObjId(): int
    {
        return $this->obj_id;
    }
 
    public function addToList(int $a_usr_id): bool
    {
        if ($this->isOnList($a_usr_id)) {
            return false;
        }
        $query = "INSERT INTO crs_waiting_list (obj_id,usr_id,sub_time) " .
            "VALUES (" .
            $this->db->quote($this->getObjId(), 'integer') . ", " .
            $this->db->quote($a_usr_id, 'integer') . ", " .
            $this->db->quote(time(), 'integer') . " " .
            ")";
        $res = $this->db->manipulate($query);
        $this->read();
        return true;
    }
 
    public function updateSubscriptionTime(int $a_usr_id, int $a_subtime): void
    {
        $query = "UPDATE crs_waiting_list " .
            "SET sub_time = " . $this->db->quote($a_subtime, 'integer') . " " .
            "WHERE usr_id = " . $this->db->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $this->db->quote($this->getObjId(), 'integer') . " ";
        $res = $this->db->manipulate($query);
    }
 
    public function removeFromList(int $a_usr_id): bool
    {
        $query = "DELETE FROM crs_waiting_list " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), 'integer') . " " .
            " AND usr_id = " . $this->db->quote($a_usr_id, 'integer') . " ";
        $affected = $this->db->manipulate($query);
        $this->read();
        return $affected > 0;
    }
 
    public function isOnList(int $a_usr_id): bool
    {
        return isset($this->users[$a_usr_id]);
    }
 
    public static function _isOnList(int $a_usr_id, int $a_obj_id): bool
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        if (isset(self::$is_on_list[$a_usr_id][$a_obj_id])) {
            return self::$is_on_list[$a_usr_id][$a_obj_id];
        }
 
        $query = "SELECT usr_id " .
            "FROM crs_waiting_list " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer');
        $res = $ilDB->query($query);
        return (bool) $res->numRows();
    }
 
    public static function _preloadOnListInfo(array $a_usr_ids, array $a_obj_ids): void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        foreach ($a_usr_ids as $usr_id) {
            foreach ($a_obj_ids as $obj_id) {
                self::$is_on_list[$usr_id][$obj_id] = false;
            }
        }
        $query = "SELECT usr_id, obj_id " .
            "FROM crs_waiting_list " .
            "WHERE " .
            $ilDB->in("obj_id", $a_obj_ids, false, "integer") . " AND " .
            $ilDB->in("usr_id", $a_usr_ids, false, "integer");
        $res = $ilDB->query($query);
        while ($rec = $ilDB->fetchAssoc($res)) {
            self::$is_on_list[(int) $rec["usr_id"]][(int) $rec["obj_id"]] = true;
        }
    }
 
    public function getCountUsers(): int
    {
        return count($this->users);
    }
 
    public function getPosition(int $a_usr_id): int
    {
        return isset($this->users[$a_usr_id]) ? $this->users[$a_usr_id]['position'] : -1;
    }
 
    public function getAllUsers(): array
    {
        return $this->users;
    }
 
    public function getUser(int $a_usr_id): array
    {
        return $this->users[$a_usr_id] ?? [];
    }
 
    public function getUserIds(): array
    {
        return $this->user_ids;
    }
 
    private function read(): void
    {
        $this->users = [];
        $query = "SELECT * FROM crs_waiting_list " .
            "WHERE obj_id = " . $this->db->quote($this->getObjId(), 'integer') . " ORDER BY sub_time";
 
        $res = $this->db->query($query);
        $counter = 0;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            ++$counter;
            $this->users[(int) $row->usr_id]['position'] = $counter;
            $this->users[(int) $row->usr_id]['time'] = (int) $row->sub_time;
            $this->users[(int) $row->usr_id]['usr_id'] = (int) $row->usr_id;
 
            $this->user_ids[] = (int) $row->usr_id;
        }
    }
}