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 (int $a_obj_id, ?int $a_mode=null)
static	_getClassByIdAndType (int $a_obj_id, string $a_type)
static	_getInstance (int $a_obj_id, ?int $a_mode=null)

Private Member Functions
	__construct ()
	getLogger ()

Static Private Member Functions
static	getFactoryInstance ()

Private Attributes
ilLogger	$logger

Static Private Attributes
static self	$instance = null
static array	$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 28 of file class.ilLPStatusFactory.php.

Constructor & Destructor Documentation

__construct()

ilLPStatusFactory::__construct ( )

private

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

References $DIC, and ILIAS\Repository\logger().

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

_getClassById()

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

static

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

References $message, ilLogLevel\ERROR, ilLPObjSettings\getClassMap(), ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_UNDEFINED, and null.

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(), and ilLearningProgressGUI\updateManual().

     : string {
        if ($a_mode === null) {
            $olp = ilObjectLP::getInstance($a_obj_id);
            $a_mode = $olp->getCurrentMode();

            // please keep the cache in this if-block, otherwise default values
            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) {
                $olp = ilObjectLP::getInstance($a_obj_id);
                $mode = $olp->getCurrentMode();
                if ($mode != ilLPObjSettings::LP_MODE_UNDEFINED) {
                    return self::_getClassById($a_obj_id, $mode);
                }
            } else {
                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 ( int  $a_obj_id, string  $a_type  )

static

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

References $message, and ilLogLevel\ERROR.

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

     : string {
        // id is ignored in the moment
        switch ($a_type) {
            case 'event':
                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 ( int  $a_obj_id, ?int  $a_mode = null  )

static

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

References $message, ilLogLevel\ERROR, ilLPObjSettings\getClassMap(), ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_UNDEFINED, and null.

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

     : ilLPStatus {
        if ($a_mode === null) {
            $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) {
                $olp = ilObjectLP::getInstance($a_obj_id);
                $mode = $olp->getCurrentMode();
                if ($mode != ilLPObjSettings::LP_MODE_UNDEFINED) {
                    return self::_getInstance($a_obj_id, $mode);
                }
            } else {
                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

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

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

getLogger()

ilLPStatusFactory::getLogger ( )

private

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

References $logger.

                                : ilLogger
    {
        return $this->logger;
    }

Field Documentation

$class_by_obj_id

array ilLPStatusFactory::$class_by_obj_id = array()

staticprivate

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

$instance

self ilLPStatusFactory::$instance = null

staticprivate

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

$logger

ilLogger ilLPStatusFactory::$logger

private

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

Referenced by getLogger().

---

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

• components/ILIAS/Tracking/classes/class.ilLPStatusFactory.php