ilObjStudyProgrammeCache Class Reference

Cache for ilObjStudyProgrammes. More...

Collaboration diagram for ilObjStudyProgrammeCache:

Public Member Functions
	getInstanceByRefId ($a_ref_id)
	addInstance (ilObjStudyProgramme $a_prg)
	test_clear ()
	For testing purpose. More...
	test_isEmpty ()

Static Public Member Functions
static	singleton ()

Protected Attributes
	$instances

Private Member Functions
	__construct ()

Static Private Attributes
static	$instance = null

Detailed Description

Cache for ilObjStudyProgrammes.

Implemented as singleton.

Author

: Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

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

Constructor & Destructor Documentation

__construct()

ilObjStudyProgrammeCache::__construct ( )

private

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

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

Member Function Documentation

addInstance()

ilObjStudyProgrammeCache::addInstance

(

ilObjStudyProgramme

$a_prg

)

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

References ilObject\getRefId().

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

Here is the call graph for this function:

getInstanceByRefId()

ilObjStudyProgrammeCache::getInstanceByRefId

(

$a_ref_id

)

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

                                                      {
                require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");   
                
                // 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($a_ref_id, $this->instances)) {
                        $this->instances[$a_ref_id] = new ilObjStudyProgramme($a_ref_id);
                }
                return $this->instances[$a_ref_id];
        }

singleton()

static ilObjStudyProgrammeCache::singleton ( )

static

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

Referenced by ilObjStudyProgramme\initStudyProgrammeCache(), and ilObjStudyProgrammeTest\testGetInstanceByRefId().

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

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 55 of file class.ilObjStudyProgrammeCache.php.

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

test_isEmpty()

ilObjStudyProgrammeCache::test_isEmpty

(

)

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

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

Field Documentation

$instance

ilObjStudyProgrammeCache::$instance = null

staticprivate

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

$instances

ilObjStudyProgrammeCache::$instances

protected

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

---

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

• Modules/StudyProgramme/classes/class.ilObjStudyProgrammeCache.php