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.

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

       {
         $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;
     }

Member Function Documentation

◆ getDescription()

LSItem::getDescription ( )

Definition at line 68 of file LSItem.php.

References $description.

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

                                     : string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getIconPath()

LSItem::getIconPath ( )

Definition at line 73 of file LSItem.php.

References $icon_path.

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

                                  : string
     {
         return $this->icon_path;
     }

Here is the caller graph for this function:

◆ getLPMode()

LSItem::getLPMode ( )

Definition at line 98 of file LSItem.php.

References $lp_mode.

Referenced by LSLearnerItem\__construct(), and ilObjLearningSequenceContentTableGUI\getLPSettingsRepresentation().

                                : int
     {
         return $this->lp_mode;
     }

Here is the caller graph for this function:

◆ getOrderNumber()

LSItem::getOrderNumber ( )

Definition at line 83 of file LSItem.php.

References $order_number.

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

                                     : int
     {
         return $this->order_number;
     }

Here is the caller graph for this function:

◆ getPostCondition()

LSItem::getPostCondition ( )

Definition at line 88 of file LSItem.php.

References $post_condition.

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

                                       : ilLSPostCondition
     {
         return $this->post_condition;
     }

Here is the caller graph for this function:

◆ getRefId()

LSItem::getRefId ( )

Definition at line 93 of file LSItem.php.

References $ref_id.

Referenced by LSLearnerItem\__construct(), ilLearnerProgressDB\getAvailabilityFor(), ilLearnerProgressDB\getLearningProgressFor(), ilLSPlayer\getNextItem(), ilLSLearnerItemsQueries\getStateFor(), ilLSViewFactory\getViewFor(), ilLearnerProgressDB\isItemVisibleForUser(), LSItemTest\testWithOnline(), LSItemTest\testWithOrderNumber(), and LSItemTest\testWithPostCondition().

                               : int
     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getTitle()

LSItem::getTitle ( )

Definition at line 63 of file LSItem.php.

References $title.

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

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getType()

LSItem::getType ( )

Definition at line 58 of file LSItem.php.

References $type.

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

                              : string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ isOnline()

LSItem::isOnline ( )

Definition at line 78 of file LSItem.php.

References $is_online.

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

                               : bool
     {
         return $this->is_online;
     }

Here is the caller graph for this function:

◆ withOnline()

LSItem::withOnline ( bool $online )

Definition at line 103 of file LSItem.php.

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

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

Here is the caller graph for this function:

◆ withOrderNumber()

LSItem::withOrderNumber ( int $order_number )

Definition at line 110 of file LSItem.php.

References $order_number.

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

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

Here is the caller graph for this function:

◆ withPostCondition()

LSItem::withPostCondition ( ilLSPostCondition $post_condition )

Definition at line 117 of file LSItem.php.

References $post_condition.

Referenced by LSLearnerItemTest\testTurnedOffWithPostCondition(), and LSItemTest\testWithPostCondition().

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

Here is the caller graph for this function:

Field Documentation

◆ $description

string LSItem::$description

protected

Definition at line 28 of file LSItem.php.

Referenced by __construct(), and getDescription().

◆ $icon_path

string LSItem::$icon_path

protected

Definition at line 29 of file LSItem.php.

Referenced by __construct(), and getIconPath().

◆ $is_online

bool LSItem::$is_online

protected

Definition at line 30 of file LSItem.php.

Referenced by __construct(), and isOnline().

◆ $lp_mode

int LSItem::$lp_mode

protected

Definition at line 34 of file LSItem.php.

Referenced by __construct(), and getLPMode().

◆ $order_number

int LSItem::$order_number

protected

Definition at line 31 of file LSItem.php.

Referenced by __construct(), getOrderNumber(), and withOrderNumber().

◆ $post_condition

ilLSPostCondition LSItem::$post_condition

protected

Definition at line 32 of file LSItem.php.

Referenced by __construct(), getPostCondition(), and withPostCondition().

◆ $ref_id

int LSItem::$ref_id

protected

Definition at line 33 of file LSItem.php.

Referenced by __construct(), and getRefId().

◆ $title

string LSItem::$title

protected

Definition at line 27 of file LSItem.php.

Referenced by __construct(), and getTitle().

◆ $type

string LSItem::$type

protected

Definition at line 26 of file LSItem.php.

Referenced by __construct(), and getType().

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

components/ILIAS/LearningSequence/classes/LSItems/LSItem.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDescription()

◆ getIconPath()

◆ getLPMode()

◆ getOrderNumber()

◆ getPostCondition()

◆ getRefId()

◆ getTitle()

◆ getType()

◆ isOnline()

◆ withOnline()

◆ withOrderNumber()

◆ withPostCondition()

Field Documentation

◆ $description

◆ $icon_path

◆ $is_online

◆ $lp_mode

◆ $order_number

◆ $post_condition

◆ $ref_id

◆ $title

◆ $type