ilLPStatusFactory Class Reference

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)

Private Member Functions
	__construct ()
	ilLPStatusFactory constructor. More...
	getLogger ()

Static Private Member Functions
static	getFactoryInstance ()

Private Attributes
	$logger

Static Private Attributes
static	$instance
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

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

Constructor & Destructor Documentation

__construct()

ilLPStatusFactory::__construct ( )

private

ilLPStatusFactory constructor.

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

References $DIC.

    {
        global $DIC;

        $this->logger = $DIC->logger()->trac();
    }

Member Function Documentation

_getClassById()

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

static

Parameters

	$a_obj_id
null	$a_mode

Returns

mixed

Exceptions

ilInvalidLPStatusException

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

References $factory, $message, ilLogLevel\ERROR, 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;
            }
        }

        $factory = self::getFactoryInstance();
        $message = 'Unknown LP mode given: ' . $a_mode;
        $factory->getLogger()->logStack(ilLogLevel::ERROR, $message);
        throw new ilInvalidLPStatusException($message);
    }

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

Parameters

$a_obj_id
$a_type

Returns

string

Exceptions

ilInvalidLPStatusException

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

References $factory, $message, and ilLogLevel\ERROR.

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:
                $factory = self::getFactoryInstance();
                $message = 'Unknown LP type given: ' . $a_type;
                $factory->getLogger()->logStack(ilLogLevel::ERROR, $message);
                throw new ilInvalidLPStatusException($message);
        }
    }

Here is the caller graph for this function:

_getInstance()

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

static

Parameters

	$a_obj_id
null	$a_mode

Returns

mixed

Exceptions

ilInvalidLPStatusException

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

References $factory, $message, ilLogLevel\ERROR, 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);
            }
        }

        $factory = self::getFactoryInstance();
        $message = 'Unknown LP mode given: ' . $a_mode;
        $factory->getLogger()->logStack(ilLogLevel::ERROR, $message);
        throw new ilInvalidLPStatusException($message);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFactoryInstance()

static ilLPStatusFactory::getFactoryInstance ( )

staticprivate

Returns

ilLPStatusFactory

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

                                                 : ilLPStatusFactory
    {
        if (!self::$instance) {
            self::$instance = new self();
        }
        return self::$instance;

    }

getLogger()

ilLPStatusFactory::getLogger ( )

private

Returns

ilLogger

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

References $logger.

    {
        return $this->logger;
    }

includeClass()

static ilLPStatusFactory::includeClass (   $a_class )

staticprotected

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

    {
        $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 28 of file class.ilLPStatusFactory.php.

$instance

ilLPStatusFactory::$instance

staticprivate

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

$logger

ilLPStatusFactory::$logger

private

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

Referenced by getLogger().

---

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

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