ilTimingCache Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilTimingCache:

Public Member Functions
	__construct (int $ref_id)
	isWarningRequired (int $usr_id)

Static Public Member Functions
static	getInstanceByRefId (int $ref_id)
static	_getTimings (int $a_ref_id)

Protected Member Functions
	readObjectInformation ()

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

Static Private Attributes
static array	$instances = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning class ilTimingCache

Author

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

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

Constructor & Destructor Documentation

__construct()

ilTimingCache::__construct

(

int

$ref_id

)

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

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

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

Here is the call graph for this function:

Member Function Documentation

_getTimings()

static ilTimingCache::_getTimings ( int  $a_ref_id )

static

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

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

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

Referenced by ilLPTableBaseGUI\showTimingsWarning().

Here is the call graph for this function:

Here is the caller graph for this function:

getInstanceByRefId()

static ilTimingCache::getInstanceByRefId ( int  $ref_id )

static

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

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

References $ref_id.

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

Here is the caller graph for this function:

isWarningRequired()

ilTimingCache::isWarningRequired

(

int

$usr_id

)

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

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

References getInstanceByRefId().

Here is the call graph for this function:

readObjectInformation()

ilTimingCache::readObjectInformation ( )

protected

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

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

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$collection_items

array ilTimingCache::$collection_items = array()

private

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

$completed_users

array ilTimingCache::$completed_users = array()

private

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

$instances

array ilTimingCache::$instances = []

staticprivate

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

$obj_id

int ilTimingCache::$obj_id = 0

private

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

$ref_id

int ilTimingCache::$ref_id = 0

private

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

Referenced by __construct(), and getInstanceByRefId().

$timings

array ilTimingCache::$timings = array()

private

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

$timings_active

bool ilTimingCache::$timings_active = false

private

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

$timings_user

array ilTimingCache::$timings_user = array()

private

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

---

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

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