class.ilWaitingList.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 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 ilWaitingList
{
    private $db = null;
    private $obj_id = 0;
    private $user_ids = array();
    private $users = array();
    
    public static $is_on_list = array();


    public function __construct($a_obj_id)
    {
        global $ilDB;

        $this->db = $ilDB;
        $this->obj_id = $a_obj_id;

        $this->read();
    }
    
    public static function lookupListSize($a_obj_id)
    {
        global $ilDB;
        
        $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($a_obj_id)
    {
        global $ilDB;

        $query = "DELETE FROM crs_waiting_list WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);

        return true;
    }
    
    public static function _deleteUser($a_usr_id)
    {
        global $ilDB;

        $query = "DELETE FROM crs_waiting_list WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer');
        $res = $ilDB->manipulate($query);

        return true;
    }
    
    public static function deleteUserEntry($a_usr_id, $a_obj_id)
    {
        global $ilDB;
        
        $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);
        return true;
    }
    

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

    public function addToList($a_usr_id)
    {
        global $ilDB;
        
        if ($this->isOnList($a_usr_id)) {
            return false;
        }
        $query = "INSERT INTO crs_waiting_list (obj_id,usr_id,sub_time) " .
            "VALUES (" .
            $ilDB->quote($this->getObjId(), 'integer') . ", " .
            $ilDB->quote($a_usr_id, 'integer') . ", " .
            $ilDB->quote(time(), 'integer') . " " .
            ")";
        $res = $ilDB->manipulate($query);
        $this->read();

        return true;
    }

    public function updateSubscriptionTime($a_usr_id, $a_subtime)
    {
        global $ilDB;
        
        $query = "UPDATE crs_waiting_list " .
            "SET sub_time = " . $ilDB->quote($a_subtime, 'integer') . " " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($this->getObjId(), 'integer') . " ";
        $res = $ilDB->manipulate($query);
        return true;
    }

    public function removeFromList($a_usr_id)
    {
        global $ilDB;
        
        $query = "DELETE FROM crs_waiting_list " .
            " WHERE obj_id = " . $ilDB->quote($this->getObjId(), 'integer') . " " .
            " AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
        $this->read();

        return true;
    }

    public function isOnList($a_usr_id)
    {
        return isset($this->users[$a_usr_id]) ? true : false;
    }
    
    public static function _isOnList($a_usr_id, $a_obj_id)
    {
        global $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 $res->numRows() ? true : false;
    }
    
    public static function _preloadOnListInfo($a_usr_ids, $a_obj_ids)
    {
        global $ilDB;
        
        if (!is_array($a_usr_ids)) {
            $a_usr_ids = array($a_usr_ids);
        }
        if (!is_array($a_obj_ids)) {
            $a_obj_ids = array($a_obj_ids);
        }
        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[$rec["usr_id"]][$rec["obj_id"]] = true;
        }
    }
    

    public function getCountUsers()
    {
        return count($this->users);
    }
    
    public function getPosition($a_usr_id)
    {
        return isset($this->users[$a_usr_id]) ? $this->users[$a_usr_id]['position'] : -1;
    }

    public function getAllUsers()
    {
        return $this->users ? $this->users : array();
    }
    
    public function getUser($a_usr_id)
    {
        return isset($this->users[$a_usr_id]) ? $this->users[$a_usr_id] : false;
    }
    
    public function getUserIds()
    {
        return $this->user_ids ? $this->user_ids : array();
    }


    private function read()
    {
        global $ilDB;
        
        $this->users = array();

        $query = "SELECT * FROM crs_waiting_list " .
            "WHERE obj_id = " . $ilDB->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[$row->usr_id]['position']      = $counter;
            $this->users[$row->usr_id]['time']          = $row->sub_time;
            $this->users[$row->usr_id]['usr_id']        = $row->usr_id;
            
            $this->user_ids[] = $row->usr_id;
        }
        return true;
    }
}