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, int $learning_progress_status, int $availability_status, LSItem $ls_item)
	getUserId ()
	getLearningProgressStatus ()
	getAvailability ()
	withPostCondition (ilLSPostCondition $post_condition)
	withOrderNumber (int $order_number)
	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, int $lp_mode)
	getType ()
	getTitle ()
	getDescription ()
	getIconPath ()
	isOnline ()
	getOrderNumber ()
	getPostCondition ()
	getRefId ()
	getLPMode ()
	withOnline (bool $online)
	withOrderNumber (int $order_number)
	withPostCondition (ilLSPostCondition $post_condition)

Protected Attributes
int	$usr_id
int	$learning_progress_status
int	$availability_status
Protected Attributes inherited from LSItem
string	$type
string	$title
string	$description
string	$icon_path
bool	$is_online
int	$order_number
ilLSPostCondition	$post_condition
int	$ref_id
int	$lp_mode

Detailed Description

Add learning progress and availability information to the LSItem.

Definition at line 24 of file LSLearnerItem.php.

Constructor & Destructor Documentation

__construct()

LSLearnerItem::__construct	(	int	$usr_id,
		int	$learning_progress_status,
		int	$availability_status,
		LSItem	$ls_item
	)

Definition at line 30 of file LSLearnerItem.php.

      {
        $this->usr_id = $usr_id;
        $this->learning_progress_status = $learning_progress_status;
        $this->availability_status = $availability_status;
        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(),
            $ls_item->getLPMode()
        );
    }

References $availability_status, $learning_progress_status, $usr_id, ILIAS\GlobalScreen\Provider\__construct(), LSItem\getDescription(), LSItem\getIconPath(), LSItem\getLPMode(), LSItem\getOrderNumber(), LSItem\getPostCondition(), LSItem\getRefId(), LSItem\getTitle(), LSItem\getType(), and LSItem\isOnline().

Here is the call graph for this function:

Member Function Documentation

getAvailability()

LSLearnerItem::getAvailability

(

)

Definition at line 62 of file LSLearnerItem.php.

                                     : int
    {
        return $this->availability_status;
    }

References $availability_status.

getLearningProgressStatus()

LSLearnerItem::getLearningProgressStatus

(

)

Definition at line 57 of file LSLearnerItem.php.

                                               : int
    {
        return $this->learning_progress_status;
    }

References $learning_progress_status.

Referenced by ilLSPlayer\getCurrentItemLearningProgress().

Here is the caller graph for this function:

getUserId()

LSLearnerItem::getUserId

(

)

Definition at line 52 of file LSLearnerItem.php.

                               : int
    {
        return $this->usr_id;
    }

References $usr_id.

withOnline()

LSLearnerItem::withOnline

(

bool

$online

)

Reimplemented from LSItem.

Definition at line 77 of file LSLearnerItem.php.

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

withOrderNumber()

LSLearnerItem::withOrderNumber

(

int

$order_number

)

Reimplemented from LSItem.

Definition at line 72 of file LSLearnerItem.php.

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

withPostCondition()

LSLearnerItem::withPostCondition

(

ilLSPostCondition

$post_condition

)

Reimplemented from LSItem.

Definition at line 67 of file LSLearnerItem.php.

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

Field Documentation

$availability_status

int LSLearnerItem::$availability_status

protected

Definition at line 28 of file LSLearnerItem.php.

Referenced by __construct(), and getAvailability().

$learning_progress_status

int LSLearnerItem::$learning_progress_status

protected

Definition at line 27 of file LSLearnerItem.php.

Referenced by __construct(), and getLearningProgressStatus().

$usr_id

int LSLearnerItem::$usr_id

protected

Definition at line 26 of file LSLearnerItem.php.

Referenced by __construct(), and getUserId().

---

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

• components/ILIAS/LearningSequence/classes/LearnerProgress/LSLearnerItem.php