LSLearnerItem Class Reference

Add learning progress and availability information to the LSItem. More...

Inheritance diagram for LSLearnerItem:

Collaboration diagram for LSLearnerItem:

Public Member Functions
	__construct (int $usr_id, \Closure $learning_progress_status, int $availability_status, ILIAS\KioskMode\State $kiosk_state, LSItem $ls_item)
	getUserId ()
	getLearningProgressStatus ()
	Calling a closure here is a breach of the "immutable object" paradigm and no good practice at all! Do NOT copy! However, this fixes #27853 for relase 5.4 - with release 6, the issue (among others) is solved by restructuring dependencies and re-ordering calls and instantiation. More...
	getAvailability ()
	getState ()
	withPostCondition (ilLSPostCondition $postcondition)
	withOrderNumber (int $position)
	withOnline (bool $online)
Public Member Functions inherited from LSItem
	__construct (string $type, string $title, string $description, string $icon_path, bool $is_online, int $order_number, \ilLSPostCondition $post_condition, int $ref_id)
	getType ()
	getTitle ()
	getDescription ()
	getIconPath ()
	isOnline ()
	withOnline (bool $online)
	getOrderNumber ()
	withOrderNumber (int $order_number)
	getPostCondition ()
	withPostCondition (ilLSPostCondition $postcondition)
	getRefId ()

Protected Attributes
	$usr_id
	$learning_progress_status
	$availability_status
	$kiosk_state
Protected Attributes inherited from LSItem
	$type
	$title
	$description
	$icon_path
	$is_online
	$order_number
	$post_condition
	$ref_id

Detailed Description

Add learning progress and availability information to the LSItem.

Author

Daniel Weise danie.nosp@m.l.we.nosp@m.ise@c.nosp@m.once.nosp@m.pts-a.nosp@m.nd-t.nosp@m.raini.nosp@m.ng.d.nosp@m.e

Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 11 of file LSLearnerItem.php.

Constructor & Destructor Documentation

__construct()

LSLearnerItem::__construct	(	int	$usr_id,
		\Closure	$learning_progress_status,
		int	$availability_status,
		ILIAS\KioskMode\State	$kiosk_state,
		LSItem	$ls_item
	)

Definition at line 34 of file LSLearnerItem.php.

References $availability_status, $kiosk_state, $learning_progress_status, $usr_id, LSItem\getDescription(), LSItem\getIconPath(), LSItem\getOrderNumber(), LSItem\getPostCondition(), LSItem\getRefId(), LSItem\getTitle(), LSItem\getType(), and LSItem\isOnline().

      {
        $this->usr_id = $usr_id;
        $this->learning_progress_status = $learning_progress_status;
        $this->availability_status = $availability_status;
        $this->kiosk_state = $kiosk_state;

        parent::__construct(
            $ls_item->getType(),
            $ls_item->getTitle(),
            $ls_item->getDescription(),
            $ls_item->getIconPath(),
            $ls_item->isOnline(),
            $ls_item->getOrderNumber(),
            $ls_item->getPostCondition(),
            $ls_item->getRefId()
        );
    }

Here is the call graph for this function:

Member Function Documentation

getAvailability()

LSLearnerItem::getAvailability

(

)

Definition at line 76 of file LSLearnerItem.php.

References $availability_status.

                                      : int
    {
        return $this->availability_status;
    }

getLearningProgressStatus()

LSLearnerItem::getLearningProgressStatus

(

)

Calling a closure here is a breach of the "immutable object" paradigm and no good practice at all! Do NOT copy! However, this fixes #27853 for relase 5.4 - with release 6, the issue (among others) is solved by restructuring dependencies and re-ordering calls and instantiation.

Definition at line 69 of file LSLearnerItem.php.

References $learning_progress_status, LSItem\getRefId(), and getUserId().

                                                : int
    {
        $lp_call = $this->learning_progress_status;
        $lp = $lp_call($this->getRefId(), $this->getUserId());
        return $lp;
    }

Here is the call graph for this function:

getState()

LSLearnerItem::getState

(

)

Definition at line 81 of file LSLearnerItem.php.

References $kiosk_state.

                               : ILIAS\KioskMode\State
    {
        return $this->kiosk_state;
    }

getUserId()

LSLearnerItem::getUserId

(

)

Definition at line 58 of file LSLearnerItem.php.

References $usr_id.

Referenced by getLearningProgressStatus().

                                : int
    {
        return $this->usr_id;
    }

Here is the caller graph for this function:

withOnline()

LSLearnerItem::withOnline

(

bool

$online

)

Definition at line 96 of file LSLearnerItem.php.

                                             : LSItem
    {
        throw new \LogicException('keep this item receptive only');
    }

withOrderNumber()

LSLearnerItem::withOrderNumber

(

int

$position

)

Definition at line 91 of file LSLearnerItem.php.

                                                   : LSItem
    {
        throw new \LogicException('keep this item receptive only');
    }

withPostCondition()

LSLearnerItem::withPostCondition

(

ilLSPostCondition

$postcondition

)

Definition at line 86 of file LSLearnerItem.php.

                                                                        : LSItem
    {
        throw new \LogicException('keep this item receptive only');
    }

Field Documentation

$availability_status

LSLearnerItem::$availability_status

protected

Definition at line 26 of file LSLearnerItem.php.

Referenced by __construct(), and getAvailability().

$kiosk_state

LSLearnerItem::$kiosk_state

protected

Definition at line 31 of file LSLearnerItem.php.

Referenced by __construct(), and getState().

$learning_progress_status

LSLearnerItem::$learning_progress_status

protected

Definition at line 21 of file LSLearnerItem.php.

Referenced by __construct(), and getLearningProgressStatus().

$usr_id

LSLearnerItem::$usr_id

protected

Definition at line 16 of file LSLearnerItem.php.

Referenced by __construct(), and getUserId().

---

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

• Modules/LearningSequence/classes/LearnerProgress/LSLearnerItem.php