Data holding class LSItem . More...

Inheritance diagram for LSItem:

Collaboration diagram for LSItem:

Public Member Functions
	__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
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

Data holding class LSItem .

Definition at line 24 of file LSItem.php.

Constructor & Destructor Documentation

◆ __construct()

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
	)

Definition at line 36 of file LSItem.php.

      {
        $this->type = $type;
        $this->title = $title;
        $this->description = $description;
        $this->icon_path = $icon_path;
        $this->is_online = $is_online;
        $this->order_number = $order_number;
        $this->post_condition = $post_condition;
        $this->ref_id = $ref_id;
        $this->lp_mode = $lp_mode;
    }

References $description, $icon_path, $is_online, $lp_mode, $order_number, $post_condition, $ref_id, $title, and $type.

Member Function Documentation

◆ getDescription()

LSItem::getDescription ( )

Definition at line 68 of file LSItem.php.

                                    : string
    {
        return $this->description;
    }

References $description.

Referenced by LSLearnerItem\__construct(), ILIAS\LearningSequence\Player\LSChoicePageBuilder\getSections(), LSItemTest\testWithOnline(), LSItemTest\testWithOrderNumber(), and LSItemTest\testWithPostCondition().

Here is the caller graph for this function:

◆ getIconPath()

LSItem::getIconPath ( )

Definition at line 73 of file LSItem.php.

                                 : string
    {
        return $this->icon_path;
    }

References $icon_path.

Referenced by LSLearnerItem\__construct(), ILIAS\LearningSequence\Player\LSChoicePageBuilder\getObjectIcon(), LSItemTest\testWithOnline(), LSItemTest\testWithOrderNumber(), and LSItemTest\testWithPostCondition().

Here is the caller graph for this function:

◆ getLPMode()

LSItem::getLPMode ( )

Definition at line 98 of file LSItem.php.

                               : int
    {
        return $this->lp_mode;
    }

References $lp_mode.

Referenced by LSLearnerItem\__construct().

Here is the caller graph for this function:

◆ getOrderNumber()

LSItem::getOrderNumber ( )

Definition at line 83 of file LSItem.php.

                                    : int
    {
        return $this->order_number;
    }

References $order_number.

Referenced by LSLearnerItem\__construct(), LSItemTest\testWithOnline(), LSItemTest\testWithOrderNumber(), and LSItemTest\testWithPostCondition().

Here is the caller graph for this function:

◆ getPostCondition()

LSItem::getPostCondition ( )

Definition at line 88 of file LSItem.php.

                                      : ilLSPostCondition
    {
        return $this->post_condition;
    }

References $post_condition.

Referenced by LSLearnerItem\__construct(), ILIAS\LearningSequence\LearningMap\LSOLearningMapSequentialNavigator\canLeave(), LSItemTest\testWithOnline(), LSItemTest\testWithOrderNumber(), and LSItemTest\testWithPostCondition().

Here is the caller graph for this function:

◆ getRefId()

LSItem::getRefId ( )

Definition at line 93 of file LSItem.php.

                              : int
    {
        return $this->ref_id;
    }

References $ref_id.

Here is the caller graph for this function:

◆ getTitle()

LSItem::getTitle ( )

Definition at line 63 of file LSItem.php.

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by LSLearnerItem\__construct(), ILIAS\LearningSequence\Player\LSChoicePageBuilder\buildCard(), ILIAS\LearningSequence\Player\LSChoicePageBuilder\getTileImage(), LSItemTest\testWithOnline(), LSItemTest\testWithOrderNumber(), and LSItemTest\testWithPostCondition().

Here is the caller graph for this function:

◆ getType()

LSItem::getType ( )

Definition at line 58 of file LSItem.php.

                             : string
    {
        return $this->type;
    }

References $type.

Referenced by LSLearnerItem\__construct(), ILIAS\LearningSequence\Player\LSChoicePageBuilder\getObjectIcon(), ILIAS\LearningSequence\Player\LSChoicePageBuilder\getTileImage(), ilLSViewFactory\getViewFor(), LSItemTest\testWithOnline(), LSItemTest\testWithOrderNumber(), and LSItemTest\testWithPostCondition().

Here is the caller graph for this function:

◆ isOnline()

LSItem::isOnline ( )

Definition at line 78 of file LSItem.php.

                              : bool
    {
        return $this->is_online;
    }

References $is_online.

Referenced by LSLearnerItem\__construct(), ilLearnerProgressDB\isItemVisibleForUser(), LSItemTest\testWithOnline(), LSItemTest\testWithOrderNumber(), and LSItemTest\testWithPostCondition().

Here is the caller graph for this function:

◆ withOnline()

LSItem::withOnline ( bool $online )

Reimplemented in LSLearnerItem.

Definition at line 103 of file LSItem.php.

                                            : LSItem
    {
        $clone = clone $this;
        $clone->is_online = $online;
        return $clone;
    }

Referenced by LSLearnerItemTest\testTurnedOffWithOnline(), and LSItemTest\testWithOnline().

Here is the caller graph for this function:

◆ withOrderNumber()

LSItem::withOrderNumber ( int $order_number )

Reimplemented in LSLearnerItem.

Definition at line 110 of file LSItem.php.

                                                      : LSItem
    {
        $clone = clone $this;
        $clone->order_number = $order_number;
        return $clone;
    }

References $order_number.

Referenced by LSLearnerItemTest\testTurnedOffWithOrderNumber(), and LSItemTest\testWithOrderNumber().

Here is the caller graph for this function:

◆ withPostCondition()

LSItem::withPostCondition ( ilLSPostCondition $post_condition )

Reimplemented in LSLearnerItem.

Definition at line 117 of file LSItem.php.

                                                                        : LSItem
    {
        $clone = clone $this;
        $clone->post_condition = $post_condition;
        return $clone;
    }