ILIAS\User\Profile\ChecklistGUI Class Reference

Collaboration diagram for ILIAS\User\Profile\ChecklistGUI:

Public Member Functions
	render (int $active_step)

Protected Member Functions
	getUIChecklistStatus (int $check_list_status)
	Get ui checklist status. More...

Protected Attributes
UIFactory	$ui_factory
ChecklistStatus	$status
Language	$lng

Private Attributes
UIRenderer	$ui_renderer

Detailed Description

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 31 of file class.ChecklistGUI.php.

Member Function Documentation

getUIChecklistStatus()

ILIAS\User\Profile\ChecklistGUI::getUIChecklistStatus ( int  $check_list_status )

protected

Get ui checklist status.

Maps the checklist status to the UI element status.

Definition at line 85 of file class.ChecklistGUI.php.

                                                                   : int
    {
        switch ($check_list_status) {
            case ChecklistStatus::STATUS_NOT_STARTED: return Step::NOT_STARTED;
            case ChecklistStatus::STATUS_IN_PROGRESS: return Step::IN_PROGRESS;
            case ChecklistStatus::STATUS_SUCCESSFUL: return Step::SUCCESSFULLY;
        }
        return 0;
    }

References ILIAS\UI\Component\Listing\Workflow\Step\IN_PROGRESS, ILIAS\UI\Component\Listing\Workflow\Step\NOT_STARTED, ILIAS\User\Profile\ChecklistStatus\STATUS_IN_PROGRESS, ILIAS\User\Profile\ChecklistStatus\STATUS_NOT_STARTED, ILIAS\User\Profile\ChecklistStatus\STATUS_SUCCESSFUL, and ILIAS\UI\Component\Listing\Workflow\Step\SUCCESSFULLY.

Referenced by ILIAS\User\Profile\ChecklistGUI\render().

Here is the caller graph for this function:

render()

ILIAS\User\Profile\ChecklistGUI::render

(

int

$active_step

)

Definition at line 55 of file class.ChecklistGUI.php.

                                            : string
    {
        $active_step_nr = 0;
        $workflow_factory = $this->ui_factory->listing()->workflow();
        $status = $this->status;
 
        //setup steps
        $steps = [];
        $cnt = 0;
        foreach ($this->status->getSteps() as $step => $txt) {
            if ($step == $active_step) {
                $active_step_nr = $cnt;
            }
            $cnt++;
            $s = $workflow_factory->step($txt, $status->getStatusDetails($step))
                ->withStatus($this->getUIChecklistStatus($status->getStatus($step)));
            $steps[] = $s;
        }
 
        //setup linear workflow
        $wf = $workflow_factory->linear($this->lng->txt("user_privacy_checklist"), $steps)
            ->withActive($active_step_nr);
 
        //render
        return $this->ui_renderer->render($wf);
    }

References ILIAS\User\Profile\ChecklistGUI\$status, $txt, ILIAS\User\Profile\ChecklistStatus\getStatus(), ILIAS\User\Profile\ChecklistStatus\getStatusDetails(), ILIAS\User\Profile\ChecklistGUI\getUIChecklistStatus(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

$lng

Language ILIAS\User\Profile\ChecklistGUI::$lng

protected

Definition at line 36 of file class.ChecklistGUI.php.

$status

ChecklistStatus ILIAS\User\Profile\ChecklistGUI::$status

protected

Definition at line 35 of file class.ChecklistGUI.php.

Referenced by ILIAS\User\Profile\ChecklistGUI\render().

$ui_factory

UIFactory ILIAS\User\Profile\ChecklistGUI::$ui_factory

protected

Definition at line 33 of file class.ChecklistGUI.php.

$ui_renderer

UIRenderer ILIAS\User\Profile\ChecklistGUI::$ui_renderer

private

Definition at line 34 of file class.ChecklistGUI.php.

---

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

• components/ILIAS/User/src/Profile/class.ChecklistGUI.php