ilObjStudyProgrammeCache Class Reference

Cache for ilObjStudyProgrammes. More...

Collaboration diagram for ilObjStudyProgrammeCache:

Public Member Functions
	getInstanceByRefId (int $ref_id)
	addInstance (ilObjStudyProgramme $prg)
	test_clear ()
	For testing purpose. More...
	test_isEmpty ()

Static Public Member Functions
static	singleton ()

Protected Attributes
array	$instances

Private Member Functions
	__construct ()

Static Private Attributes
static ilObjStudyProgrammeCache	$instance = null

Detailed Description

Cache for ilObjStudyProgrammes.

Implemented as singleton.

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

Constructor & Destructor Documentation

__construct()

ilObjStudyProgrammeCache::__construct ( )

private

Definition at line 35 of file class.ilObjStudyProgrammeCache.php.

    {
        $this->instances = array();
    }

Member Function Documentation

addInstance()

ilObjStudyProgrammeCache::addInstance

(

ilObjStudyProgramme

$prg

)

Definition at line 70 of file class.ilObjStudyProgrammeCache.php.

                                                         : void
    {
        if (!$prg->getRefId()) {
            throw new ilException("ilObjStudyProgrammeCache::addInstance: Can't add instance without ref_id.");
        }
        $this->instances[$prg->getRefId()] = $prg;
    }

References ilObject\getRefId().

Here is the call graph for this function:

getInstanceByRefId()

ilObjStudyProgrammeCache::getInstanceByRefId

(

int

$ref_id

)

Definition at line 48 of file class.ilObjStudyProgrammeCache.php.

                                                   : ilObjStudyProgramme
    {
        // TODO: Maybe this should be done via obj_id instead of ref_id, since two
        // ref_ids could point to the same object, hence leading to two instances of
        // the same object. Since ilObjStudyProgramme is a container, it should (??)
        // only have one ref_id...
        if (!array_key_exists($ref_id, $this->instances)) {
            $type = ilObject::_lookupType($ref_id, true);
            if ($type === 'prg') {
                $this->instances[$ref_id] = new ilObjStudyProgramme($ref_id);
            }
            if ($type === 'prgr') {
                $prg_reference = new ilObjStudyProgrammeReference($ref_id, true);
                $this->instances[$ref_id] = $prg_reference->getReferencedObject();
            }
            if ($type !== 'prgr' && $type !== 'prg') {
                throw new \Exception('invalid ref_id: ' . $ref_id);
            }
        }
        return $this->instances[$ref_id];
    }

References $ref_id, and ilObject\_lookupType().

Here is the call graph for this function:

singleton()

static ilObjStudyProgrammeCache::singleton ( )

static

Definition at line 40 of file class.ilObjStudyProgrammeCache.php.

                                      : ilObjStudyProgrammeCache
    {
        if (self::$instance === null) {
            self::$instance = new ilObjStudyProgrammeCache();
        }
        return self::$instance;
    }

References $instance.

Referenced by ilObjStudyProgramme\initStudyProgrammeCache(), and ilObjStudyProgrammeCacheTest\testCreateBySingleton().

Here is the caller graph for this function:

test_clear()

ilObjStudyProgrammeCache::test_clear

(

)

For testing purpose.

TODO: Move to mock class in tests.

Definition at line 83 of file class.ilObjStudyProgrammeCache.php.

                                : void
    {
        $this->instances = array();
    }

test_isEmpty()

ilObjStudyProgrammeCache::test_isEmpty

(

)

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

                                  : bool
    {
        return count($this->instances) === 0;
    }

Field Documentation

$instance

ilObjStudyProgrammeCache ilObjStudyProgrammeCache::$instance = null

staticprivate

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

Referenced by singleton().

$instances

array ilObjStudyProgrammeCache::$instances

protected

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

---

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

• components/ILIAS/StudyProgramme/classes/class.ilObjStudyProgrammeCache.php