Class ilLPStatusFactory Creates status class instances for learning progress modes of an object. More...

Collaboration diagram for ilLPStatusFactory:

Static Public Member Functions
static	_getClassById ($a_obj_id, $a_mode=null)

static	_getClassByIdAndType ($a_obj_id, $a_type)

static	_getInstance ($a_obj_id, $a_mode=null)

Static Protected Member Functions
static	includeClass ($a_class)

Static Private Attributes
static	$class_by_obj_id = array()

Detailed Description

Class ilLPStatusFactory Creates status class instances for learning progress modes of an object.

E.g obj_id of course returns an instance of ilLPStatusManual, ilLPStatusObjectives ...

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

Version: $Id$

Definition at line 19 of file class.ilLPStatusFactory.php.

Member Function Documentation

◆ _getClassById()

static ilLPStatusFactory::_getClassById	(	$a_obj_id,
		$a_mode = `null`
	)

static

Definition at line 23 of file class.ilLPStatusFactory.php.

    {
        if ($a_mode === null) {
            include_once 'Services/Object/classes/class.ilObjectLP.php';
            $olp = ilObjectLP::getInstance($a_obj_id);
            $a_mode = $olp->getCurrentMode();
            
            // please keep the cache in this if-block, otherwise default values
            // will not trigger the include_once calls
            if (isset(self::$class_by_obj_id[$a_obj_id])) {
                return self::$class_by_obj_id[$a_obj_id];
            }
        }
 
        $map = ilLPObjSettings::getClassMap();
        
        if (array_key_exists($a_mode, $map)) {
            $class = $map[$a_mode];
                        
            // undefined? try object lp directly
            if ($class === null) {
                include_once 'Services/Object/classes/class.ilObjectLP.php';
                $olp = ilObjectLP::getInstance($a_obj_id);
                $mode = $olp->getCurrentMode();
                if ($mode != ilLPObjSettings::LP_MODE_UNDEFINED) {
                    return self::_getClassById($a_obj_id, $mode);
                }
            } else {
                self::includeClass($class);
                self::$class_by_obj_id[$a_obj_id] = $class;
                return $class;
            }
        }
 
        // we probably can do better
        echo "ilLPStatusFactory: unknown type " . $a_mode;
        exit;
    }

References _getClassById(), exit, ilLPObjSettings\getClassMap(), ilObjectLP\getInstance(), includeClass(), and ilLPObjSettings\LP_MODE_UNDEFINED.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getClassByIdAndType()

static ilLPStatusFactory::_getClassByIdAndType	(	$a_obj_id,
		$a_type
	)

static

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

    {
        // id is ignored in the moment
        switch ($a_type) {
            case 'event':
                self::includeClass('ilLPStatusEvent');
                return 'ilLPStatusEvent';
 
            default:
                echo "ilLPStatusFactory: unknown type: " . $a_type;
                exit;
        }
    }

References $a_type, exit, and includeClass().

Referenced by ilLPStatusWrapper\_getCompletedByType(), ilLPStatusWrapper\_getFailedByType(), ilLPStatusWrapper\_getInProgressByType(), ilLPStatusWrapper\_getNotAttemptedByType(), and ilLPStatusWrapper\_getStatusInfoByType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getInstance()

static ilLPStatusFactory::_getInstance	(	$a_obj_id,
		$a_mode = `null`
	)

static

Definition at line 84 of file class.ilLPStatusFactory.php.

    {
        if ($a_mode === null) {
            include_once 'Services/Object/classes/class.ilObjectLP.php';
            $olp = ilObjectLP::getInstance($a_obj_id);
            $a_mode = $olp->getCurrentMode();
        }
        
        $map = ilLPObjSettings::getClassMap();
        
        if (array_key_exists($a_mode, $map)) {
            $class = $map[$a_mode];
                        
            // undefined? try object lp directly
            if ($class === null) {
                include_once 'Services/Object/classes/class.ilObjectLP.php';
                $olp = ilObjectLP::getInstance($a_obj_id);
                $mode = $olp->getCurrentMode();
                if ($mode != ilLPObjSettings::LP_MODE_UNDEFINED) {
                    return self::_getInstance($a_obj_id, $mode);
                }
            } else {
                self::includeClass($class);
                return new $class($a_obj_id);
            }
        }
        
        // we probably can do better
        echo "ilLPStatusFactory: unknown type " . $a_mode;
        exit;
    }

References _getInstance(), exit, ilLPObjSettings\getClassMap(), ilObjectLP\getInstance(), includeClass(), and ilLPObjSettings\LP_MODE_UNDEFINED.

Referenced by ilLPStatusWrapper\_determineStatus(), _getInstance(), ilLPStatusWrapper\_refreshStatus(), ilLPStatusWrapper\_setDirty(), ilLPStatusWrapper\_updateStatus(), ilLPStatus\checkStatusForObject(), ilTrQuery\getObjectIds(), and ilTestLP\resetCustomLPDataForUserIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ includeClass()

static ilLPStatusFactory::includeClass ( $a_class )

staticprotected

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

    {
        $path = ($a_class == 'ilLPStatus')
            ? 'Services/Tracking/classes/'
            : 'Services/Tracking/classes/status/';
        include_once $path . 'class.' . $a_class . '.php';
    }