ilTimingCache Class Reference

class ilTimingCache More...

Collaboration diagram for ilTimingCache:

Public Member Functions
	__construct ($ref_id)
	ilTimingCache constructor. More...
	isWarningRequired ($usr_id)

Static Public Member Functions
static	getInstanceByRefId ($ref_id)
static &	_getTimings ($a_ref_id)
static	_showWarning ($a_ref_id, $a_usr_id)

Protected Member Functions
	readObjectInformation ()
	Read timing information for object. More...

Private Attributes
	$ref_id = 0
	$obj_id = 0
	$timings_active = false
	$timings = array()
	$timings_user = array()
	$collection_items = array()
	$completed_users = array()

Static Private Attributes
static	$instances = array()

Detailed Description

class ilTimingCache

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 32 of file class.ilTimingCache.php.

Constructor & Destructor Documentation

__construct()

ilTimingCache::__construct

(

$ref_id

)

ilTimingCache constructor.

Definition at line 77 of file class.ilTimingCache.php.

References $ref_id, ilObject\_lookupObjId(), and readObjectInformation().

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

Here is the call graph for this function:

Member Function Documentation

_getTimings()

static& ilTimingCache::_getTimings (   $a_ref_id )

static

Deprecated:

7

Parameters

$a_ref_id

Returns

mixed

Definition at line 150 of file class.ilTimingCache.php.

References ilTimingPlaned\_getPlanedTimingsByItem(), array, and ilObjectActivation\getItem().

Referenced by _showWarning(), and ilLPTableBaseGUI\showTimingsWarning().

    {
        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];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_showWarning()

static ilTimingCache::_showWarning (   $a_ref_id,   $a_usr_id  )

static

Deprecated:

7

Parameters

$a_ref_id
$a_usr_id

Returns

bool

Definition at line 169 of file class.ilTimingCache.php.

References $end, $obj_id, $timings, _getTimings(), ilLPStatus\_hasUserCompleted(), ilObjectLP\getInstance(), time, and ilObjectActivation\TIMINGS_PRESETTING.

    {
        global $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;
    }

Here is the call graph for this function:

getInstanceByRefId()

static ilTimingCache::getInstanceByRefId (   $ref_id )

static

Parameters

$ref_id

Returns

ilTimingCache

Definition at line 88 of file class.ilTimingCache.php.

References $ref_id.

Referenced by ilLPTableBaseGUI\showTimingsWarning().

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

Here is the caller graph for this function:

isWarningRequired()

ilTimingCache::isWarningRequired

(

$usr_id

)

Parameters

int

$usr_id

Returns

bool

Definition at line 100 of file class.ilTimingCache.php.

References $end, and time.

    {
        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();
    }

readObjectInformation()

ilTimingCache::readObjectInformation ( )

protected

Read timing information for object.

Definition at line 127 of file class.ilTimingCache.php.

References ilLPStatus\_getCompleted(), ilTimingPlaned\_getPlanedTimingsByItem(), ilObjectLP\getInstance(), ilObjectActivation\getItem(), and ilObjectActivation\TIMINGS_PRESETTING.

Referenced by __construct().

    {
        $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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$collection_items

ilTimingCache::$collection_items = array()

private

Definition at line 67 of file class.ilTimingCache.php.

$completed_users

ilTimingCache::$completed_users = array()

private

Definition at line 72 of file class.ilTimingCache.php.

$instances

ilTimingCache::$instances = array()

staticprivate

Definition at line 37 of file class.ilTimingCache.php.

$obj_id

ilTimingCache::$obj_id = 0

private

Definition at line 47 of file class.ilTimingCache.php.

Referenced by _showWarning().

$ref_id

ilTimingCache::$ref_id = 0

private

Definition at line 42 of file class.ilTimingCache.php.

Referenced by __construct(), and getInstanceByRefId().

$timings

ilTimingCache::$timings = array()

private

Definition at line 57 of file class.ilTimingCache.php.

Referenced by _showWarning().

$timings_active

ilTimingCache::$timings_active = false

private

Definition at line 52 of file class.ilTimingCache.php.

$timings_user

ilTimingCache::$timings_user = array()

private

Definition at line 62 of file class.ilTimingCache.php.

---

The documentation for this class was generated from the following file:

• Modules/Course/classes/Timings/class.ilTimingCache.php