class.ilTimingCache.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2001 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. |
    +-----------------------------------------------------------------------------+
*/


class ilTimingCache
{
    private static $instances = array();

    private $ref_id = 0;

    private $obj_id = 0;

    private $timings_active = false;

    private $timings = array();

    private $timings_user = array();

    private $collection_items = array();

    private $completed_users = array();

    public function __construct($ref_id)
    {
        $this->ref_id = $ref_id;
        $this->obj_id = ilObject::_lookupObjId($this->ref_id);
        $this->readObjectInformation();
    }

    public static function getInstanceByRefId($ref_id)
    {
        if (!isset(self::$instances[$ref_id])) {
            self::$instances[$ref_id] = new self($ref_id);
        }
        return self::$instances[$ref_id];
    }

    public function isWarningRequired($usr_id)
    {
        if (in_array($usr_id, $this->completed_users)) {
            return false;
        }
        foreach ($this->collection_items as $item) {
            $item_instance = self::getInstanceByRefId($item);
            if ($item_instance->isWarningRequired($usr_id)) {
                return true;
            }
        }
        if (!$this->timings_active) {
            return false;
        }

        // check constraints
        if ($this->timings['changeable'] && isset($this->timings_user[$usr_id]['end'])) {
            $end = $this->timings_user[$usr_id]['end'];
        } else {
            $end = $this->timings['suggestion_end'];
        }
        return $end < time();
    }

    protected function readObjectInformation()
    {
        $this->timings = ilObjectActivation::getItem($this->ref_id);
        $this->timings_active = false;
        if ($this->timings['timing_type'] == ilObjectActivation::TIMINGS_PRESETTING) {
            $this->timings_active = true;
            $this->timings_user = ilTimingPlaned::_getPlanedTimingsByItem($this->ref_id);
        }

        $olp = ilObjectLP::getInstance($this->obj_id);
        $collection = $olp->getCollectionInstance();
        if ($collection instanceof ilLPCollectionOfRepositoryObjects) {
            $this->collection_items = $collection->getItems();
        }
        $this->completed_users = ilLPStatus::_getCompleted($this->obj_id);
    }


    public static function &_getTimings($a_ref_id)
    {
        static $cache = array();

        if (isset($cache[$a_ref_id])) {
            return $cache[$a_ref_id];
        }
        $cache[$a_ref_id]['item'] = ilObjectActivation::getItem($a_ref_id);
        $cache[$a_ref_id]['user'] = ilTimingPlaned::_getPlanedTimingsByItem($a_ref_id);

        return $cache[$a_ref_id];
    }
        
    public static function _showWarning($a_ref_id, $a_usr_id)
    {
        global $DIC;

        $ilObjDataCache = $DIC['ilObjDataCache'];
        
        $obj_id = $ilObjDataCache->lookupObjId($a_ref_id);
                                
        // if completed no warning
        include_once './Services/Tracking/classes/class.ilLPStatus.php';
        if (ilLPStatus::_hasUserCompleted($obj_id, $a_usr_id)) {
            return false;
        }
        
        // if editing time reached => show warning
        $timings = &ilTimingCache::_getTimings($a_ref_id);
        if ($timings['item']['timing_type'] == ilObjectActivation::TIMINGS_PRESETTING) {
            if ($timings['item']['changeable'] and $timings['user'][$a_usr_id]['end']) {
                $end = $timings['user'][$a_usr_id]['end'];
            } else {
                $end = $timings['item']['suggestion_end'];
            }
            if ($end < time()) {
                return true;
            }
        }

        include_once './Services/Object/classes/class.ilObjectLP.php';
        $olp = ilObjectLP::getInstance($obj_id);
        $collection = $olp->getCollectionInstance();
        if ($collection instanceof ilLPCollectionOfRepositoryObjects) {
            foreach ($collection->getItems() as $item) {
                if (ilTimingCache::_showWarning($item, $a_usr_id)) {
                    return true;
                }
            }
        }
        
        // Really ???
        return false;
    }
}