ilLPStatusFactory Class Reference

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

Collaboration diagram for ilLPStatusFactory:

Public Member Functions
	_getClassById ($a_obj_id, $a_mode=NULL)
	_getClassByIdAndType ($a_obj_id, $a_type)
	_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()

ilLPStatusFactory::_getClassById	(		$a_obj_id,
			$a_mode = NULL
	)

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

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

Referenced by ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getFailed(), ilLPStatusWrapper\_getInProgress(), ilLPStatusWrapper\_getNotAttempted(), ilLPStatusWrapper\_getStatusInfo(), ilLPStatusWrapper\_getTypicalLearningTime(), ilLPStatusWrapper\_lookupCompletedForObject(), ilLPStatusWrapper\_lookupFailedForObject(), ilLPStatusWrapper\_lookupInProgressForObject(), ilLMExplorerGUI\checkLPIcon(), ilTrQuery\getParticipantsForObject(), ilLearningProgressGUI\initCollectionManualForm(), ilLearningProgressGUI\showtlt(), ilTrackingTest\testLPMarks(), and ilLearningProgressGUI\updateManual().

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

Here is the call graph for this function:

Here is the caller graph for this function:

_getClassByIdAndType()

ilLPStatusFactory::_getClassByIdAndType	(		$a_obj_id,
			$a_type
	)

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

References exit.

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

        {
                // id is ignored in the moment
                switch($a_type)
                {
                        case 'event':
                                self::includeClass('ilLPStatusEvent');          
                                return 'ilLPStatusEvent';

                        default:
                                echo "ilLPStatusFactory: unknown type: ".$a_type;
                                exit;
                }
        }

Here is the caller graph for this function:

_getInstance()

ilLPStatusFactory::_getInstance	(		$a_obj_id,
			$a_mode = NULL
	)

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

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

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

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

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 69 of file class.ilLPStatusFactory.php.

References $path.

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

Field Documentation

$class_by_obj_id

ilLPStatusFactory::$class_by_obj_id = array()

staticprivate

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

---

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

• Services/Tracking/classes/class.ilLPStatusFactory.php