ilLSCurriculumBuilder Class Reference

Builds the overview (curriculum) of a LearningSequence. More...

Collaboration diagram for ilLSCurriculumBuilder:

Public Member Functions
	__construct (ilLSLearnerItemsQueries $ls_items, ILIAS\UI\Factory $ui_factory, ilLanguage $language, string $goto_command, ?LSUrlBuilder $url_builder=null)
	getLearnerCurriculum (bool $with_action=false)

Protected Member Functions
	translateLPStatus (int $il_lp_status)

Protected Attributes
ilLSLearnerItemsQueries	$ls_items
ILIAS UI Factory	$ui_factory
ilLanguage	$lng
string	$goto_command
LSUrlBuilder	$url_builder

Detailed Description

Builds the overview (curriculum) of a LearningSequence.

Definition at line 24 of file class.ilLSCurriculumBuilder.php.

Constructor & Destructor Documentation

__construct()

ilLSCurriculumBuilder::__construct	(	ilLSLearnerItemsQueries	$ls_items,
		ILIAS\UI\Factory	$ui_factory,
		ilLanguage	$language,
		string	$goto_command,
		?LSUrlBuilder	$url_builder = null
	)

Definition at line 32 of file class.ilLSCurriculumBuilder.php.

References $goto_command, $ls_items, $ui_factory, $url_builder, and ILIAS\Repository\lng().

      {
        $this->ls_items = $ls_items;
        $this->ui_factory = $ui_factory;
        $this->lng = $language;
        $this->goto_command = $goto_command;
        $this->url_builder = $url_builder;
    }

Here is the call graph for this function:

Member Function Documentation

getLearnerCurriculum()

ilLSCurriculumBuilder::getLearnerCurriculum

(

bool

$with_action = false

)

Definition at line 46 of file class.ilLSCurriculumBuilder.php.

References ILIAS\Repository\lng(), and translateLPStatus().

                                                                   : ILIAS\UI\Component\Listing\Workflow\Linear
    {
        $steps = [];
        foreach ($this->ls_items->getItems() as $item) {
            $action = '#';
            if ($with_action) {
                $action = $this->url_builder->getHref($this->goto_command, $item->getRefId());
            }

            $steps[] = $this->ui_factory->listing()->workflow()->step(
                $item->getTitle(),
                $item->getDescription(),
                $action
            )
            ->withAvailability($item->getAvailability())
            ->withStatus(
                $this->translateLPStatus(
                    $item->getLearningProgressStatus()
                )
            );
        }

        $workflow = $this->ui_factory->listing()->workflow()->linear(
            $this->lng->txt('curriculum'),
            $steps
        );

        if ($steps !== []) {
            $current_position = max(0, $this->ls_items->getCurrentItemPosition());
            $workflow = $workflow->withActive($current_position);
        }

        return $workflow;
    }

Here is the call graph for this function:

translateLPStatus()

ilLSCurriculumBuilder::translateLPStatus ( int  $il_lp_status )

protected

Definition at line 94 of file class.ilLSCurriculumBuilder.php.

References ILIAS\UI\Component\Listing\Workflow\Step\IN_PROGRESS, ILIAS\UI\Component\Listing\Workflow\Step\NOT_STARTED, ILIAS\UI\Component\Listing\Workflow\Step\SUCCESSFULLY, and ILIAS\UI\Component\Listing\Workflow\Step\UNSUCCESSFULLY.

Referenced by getLearnerCurriculum().

                                                           : int
    {
        switch ($il_lp_status) {
            case \ilLPStatus::LP_STATUS_IN_PROGRESS_NUM:
                return ILIAS\UI\Component\Listing\Workflow\Step::IN_PROGRESS;
            case \ilLPStatus::LP_STATUS_COMPLETED_NUM:
                return ILIAS\UI\Component\Listing\Workflow\Step::SUCCESSFULLY;
            case \ilLPStatus::LP_STATUS_FAILED_NUM:
                return ILIAS\UI\Component\Listing\Workflow\Step::UNSUCCESSFULLY;
            case \ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM:
            default:
                return ILIAS\UI\Component\Listing\Workflow\Step::NOT_STARTED;
        }
    }

Here is the caller graph for this function:

Field Documentation

$goto_command

string ilLSCurriculumBuilder::$goto_command

protected

Definition at line 29 of file class.ilLSCurriculumBuilder.php.

Referenced by __construct().

$lng

ilLanguage ilLSCurriculumBuilder::$lng

protected

Definition at line 28 of file class.ilLSCurriculumBuilder.php.

$ls_items

ilLSLearnerItemsQueries ilLSCurriculumBuilder::$ls_items

protected

Definition at line 26 of file class.ilLSCurriculumBuilder.php.

Referenced by __construct().

$ui_factory

ILIAS UI Factory ilLSCurriculumBuilder::$ui_factory

protected

Definition at line 27 of file class.ilLSCurriculumBuilder.php.

Referenced by __construct().

$url_builder

LSUrlBuilder ilLSCurriculumBuilder::$url_builder

protected

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

Referenced by __construct().

---

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

• components/ILIAS/LearningSequence/classes/Player/class.ilLSCurriculumBuilder.php