@ilCtrl_IsCalledBy ilLPPersonalGUI: ilDashboardGUI More...

Collaboration diagram for ilLPPersonalGUI:

Public Member Functions
	__construct ()

	executeCommand ()

Protected Member Functions
	getCurrentPresentationModeFromQuery ()

	buildViewControls ()

	isPresentable (string $presentation_mode, ilDateTime\|null $crs_start, ilDateTime\|null $crs_end)

	listCourses ()

	hasReadAccess (int $obj_id)

	buildLinkToCourse (int $obj_id)

Protected Attributes
const	PRESENTATION_OPTION_CURRENT = "current"

const	PRESENTATION_OPTION_FUTURE = "future"

const	PRESENTATION_OPTION_PAST = "past"

const	PRESENTATION_OPTION_ALL = "all"

const	URL_VAR_MODE = "viewcontrol_plp_mode"

const	URL_VAR_ACTION_MODE = "mode"

const	URL_NAMESPACE_PLP = "plp"

const	URL_NAMESPACE_VIEWCONTROL = "viewcontrol"

const	LNG_VAR_PRESENTATION_OPTION_CURRENT = "view_mode_current"

const	LNG_VAR_PRESENTATION_OPTION_FUTURE = "view_mode_future"

const	LNG_VAR_PRESENTATION_OPTION_PAST = "view_mode_past"

const	LNG_VAR_PRESENTATION_OPTION_ALL = "view_mode_all"

const	LNG_VAR_PROPERTY_CRS_START = "trac_begin_at"

const	LNG_VAR_PROPERTY_CRS_END = "trac_end_at"

const	LNG_VAR_PROPERTY_CRS_ONLINE = "online"

const	LNG_VAR_PROPERTY_CRS_ONLINE_YES = "yes"

const	LNG_VAR_PROPERTY_CRS_ONLINE_NO = "no"

const	LNG_VAR_LISTING_TITLE = "courses"

HTTPServices	$http

UIServices	$ui

ilCtrl	$ctrl

ilObjUser	$user

ilLanguage	$lng

RefineryFactory	$refinery

DataFactory	$data_factory

ilAccessHandler	$access

StaticURL	$static_url

ViewFactoryInterface	$tracking_view

Detailed Description

@ilCtrl_IsCalledBy ilLPPersonalGUI: ilDashboardGUI

Definition at line 37 of file class.ilLPPersonalGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPPersonalGUI::__construct ( )

Definition at line 68 of file class.ilLPPersonalGUI.php.

    {
        global $DIC;
 
        $this->ui = $DIC->ui();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->access = $DIC->access();
        $this->data_factory = new DataFactory();
        $this->static_url = $DIC['static_url'];
        $this->tracking_view = new ViewFactory();
        $this->lng->loadLanguageModule("trac");
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ buildLinkToCourse()

ilLPPersonalGUI::buildLinkToCourse ( int $obj_id )

protected

Definition at line 251 of file class.ilLPPersonalGUI.php.

                                                     : ?URI
    {
        $ref_ids = ilObject::_getAllReferences($obj_id);
        if (count($ref_ids) === 0) {
            return null;
        }
        return $this->static_url->builder()->build(
            'crs',
            $this->data_factory->refId((int) current($ref_ids))
        );
    }

References ilObject\_getAllReferences().

Here is the call graph for this function:

◆ buildViewControls()

ilLPPersonalGUI::buildViewControls ( )

protected

Definition at line 101 of file class.ilLPPersonalGUI.php.

                                          : array
    {
        $current_presentation = $this->getCurrentPresentationModeFromQuery();
        $presentation_options = [
            self::PRESENTATION_OPTION_CURRENT => $this->lng->txt(self::LNG_VAR_PRESENTATION_OPTION_CURRENT),
            self::PRESENTATION_OPTION_FUTURE => $this->lng->txt(self::LNG_VAR_PRESENTATION_OPTION_FUTURE),
            self::PRESENTATION_OPTION_PAST => $this->lng->txt(self::LNG_VAR_PRESENTATION_OPTION_PAST),
            self::PRESENTATION_OPTION_ALL => $this->lng->txt(self::LNG_VAR_PRESENTATION_OPTION_ALL),
        ];
        $uri = $this->http->request()->getUri()->__toString();
        $url_builder = new URLBuilder($this->data_factory->uri($uri));
        list($url_builder, $action_parameter_token) =
            $url_builder->acquireParameters(
                [self::URL_NAMESPACE_VIEWCONTROL, self::URL_NAMESPACE_PLP],
                self::URL_VAR_ACTION_MODE
            );
        $modes = $this->ui->factory()->viewControl()->mode(
            [
                $presentation_options[self::PRESENTATION_OPTION_CURRENT] => (string) $url_builder->withParameter($action_parameter_token, self::PRESENTATION_OPTION_CURRENT)->buildURI(),
                $presentation_options[self::PRESENTATION_OPTION_FUTURE] => (string) $url_builder->withParameter($action_parameter_token, self::PRESENTATION_OPTION_FUTURE)->buildURI(),
                $presentation_options[self::PRESENTATION_OPTION_PAST] => (string) $url_builder->withParameter($action_parameter_token, self::PRESENTATION_OPTION_PAST)->buildURI(),
                $presentation_options[self::PRESENTATION_OPTION_ALL] => (string) $url_builder->withParameter($action_parameter_token, self::PRESENTATION_OPTION_ALL)->buildURI(),
            ],
            'Presentation Mode'
        )
            ->withActive($presentation_options[$current_presentation]);
        return [
            $modes
        ];
    }

References getCurrentPresentationModeFromQuery(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ executeCommand()

ilLPPersonalGUI::executeCommand ( )

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

                                    : void
    {
        $this->listCourses();
    }

References listCourses().

Here is the call graph for this function:

◆ getCurrentPresentationModeFromQuery()

ilLPPersonalGUI::getCurrentPresentationModeFromQuery ( )

protected

Definition at line 90 of file class.ilLPPersonalGUI.php.

                                                            : string
    {
        if ($this->http->wrapper()->query()->has(self::URL_VAR_MODE)) {
            return $this->http->wrapper()->query()->retrieve(
                self::URL_VAR_MODE,
                $this->refinery->kindlyTo()->string()
            );
        }
        return self::PRESENTATION_OPTION_CURRENT;
    }

References ILIAS\FileDelivery\http(), PRESENTATION_OPTION_CURRENT, and ILIAS\Repository\refinery().

Referenced by buildViewControls().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasReadAccess()

ilLPPersonalGUI::hasReadAccess ( int $obj_id )

protected

Definition at line 241 of file class.ilLPPersonalGUI.php.

                                                 : bool
    {
        foreach (ilObject::_getAllReferences($obj_id) as $ref_id) {
            if ($this->access->checkAccess("read", "", $ref_id)) {
                return true;
            }
        }
        return false;
    }

References $ref_id, ilObject\_getAllReferences(), and ILIAS\Repository\access().

Here is the call graph for this function:

◆ isPresentable()

ilLPPersonalGUI::isPresentable	(	string	$presentation_mode,
		ilDateTime\|null	$crs_start,
		ilDateTime\|null	$crs_end
	)

protected

Definition at line 190 of file class.ilLPPersonalGUI.php.

     : bool {
        $now = new ilDateTime(time(), IL_CAL_UNIX);
        $crs_start = (is_null($crs_start) || $crs_start->isNull()) ? $now : $crs_start;
        $crs_end = (is_null($crs_end) || $crs_end->isNull()) ? $now : $crs_end;
        if ($presentation_mode === self::PRESENTATION_OPTION_ALL) {
            return true;
        }
        // courses without end are never in the past
        if (
            $presentation_mode === self::PRESENTATION_OPTION_PAST &&
            ilDateTime::_after($now, $crs_end)
        ) {
            return true;
        }
        // courses without start are never in the future
        if (
            $presentation_mode === self::PRESENTATION_OPTION_FUTURE &&
            ilDateTime::_before($now, $crs_start)
        ) {
            return true;
        }
        // courses without start and end are always current
        // courses without start or end are current if their end/start is not in the past/future
        if (
            $presentation_mode === self::PRESENTATION_OPTION_CURRENT &&
            ilDateTime::_within($now, $crs_start, $crs_end)
        ) {
            return true;
        }
        return false;
    }

◆ listCourses()

ilLPPersonalGUI::listCourses ( )

protected

Definition at line 226 of file class.ilLPPersonalGUI.php.

                                    : void
    {
        $view_controls = $this->buildViewControls();
        $items = $this->buildPanelItems($this->getCurrentPresentationModeFromQuery());
        $crs_item_group = $this->ui->factory()->item()->group("", $items);
        $ui_panel = $this->ui->factory()->panel()->listing()->standard(
            $this->lng->txt(self::LNG_VAR_LISTING_TITLE),
            [
                $crs_item_group
            ]
        )
            ->withViewControls($view_controls);
        $this->ui->mainTemplate()->setContent($this->ui->renderer()->render([$ui_panel]));
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilLPPersonalGUI::$access

protected

Definition at line 64 of file class.ilLPPersonalGUI.php.

◆ $ctrl

ilCtrl ilLPPersonalGUI::$ctrl

protected

Definition at line 59 of file class.ilLPPersonalGUI.php.

◆ $data_factory

DataFactory ilLPPersonalGUI::$data_factory

protected

Definition at line 63 of file class.ilLPPersonalGUI.php.

◆ $http

HTTPServices ilLPPersonalGUI::$http

protected

Definition at line 57 of file class.ilLPPersonalGUI.php.

◆ $lng

ilLanguage ilLPPersonalGUI::$lng

protected

Definition at line 61 of file class.ilLPPersonalGUI.php.

◆ $refinery

RefineryFactory ilLPPersonalGUI::$refinery

protected

Definition at line 62 of file class.ilLPPersonalGUI.php.

◆ $static_url

StaticURL ilLPPersonalGUI::$static_url

protected

Definition at line 65 of file class.ilLPPersonalGUI.php.

◆ $tracking_view

ViewFactoryInterface ilLPPersonalGUI::$tracking_view

protected

Definition at line 66 of file class.ilLPPersonalGUI.php.

◆ $ui

UIServices ilLPPersonalGUI::$ui

protected

Definition at line 58 of file class.ilLPPersonalGUI.php.

◆ $user

ilObjUser ilLPPersonalGUI::$user

protected

Definition at line 60 of file class.ilLPPersonalGUI.php.

◆ LNG_VAR_LISTING_TITLE

const ilLPPersonalGUI::LNG_VAR_LISTING_TITLE = "courses"

protected

Definition at line 56 of file class.ilLPPersonalGUI.php.

◆ LNG_VAR_PRESENTATION_OPTION_ALL

const ilLPPersonalGUI::LNG_VAR_PRESENTATION_OPTION_ALL = "view_mode_all"

protected

Definition at line 50 of file class.ilLPPersonalGUI.php.

◆ LNG_VAR_PRESENTATION_OPTION_CURRENT

const ilLPPersonalGUI::LNG_VAR_PRESENTATION_OPTION_CURRENT = "view_mode_current"

protected

Definition at line 47 of file class.ilLPPersonalGUI.php.

◆ LNG_VAR_PRESENTATION_OPTION_FUTURE

const ilLPPersonalGUI::LNG_VAR_PRESENTATION_OPTION_FUTURE = "view_mode_future"

protected

Definition at line 48 of file class.ilLPPersonalGUI.php.

◆ LNG_VAR_PRESENTATION_OPTION_PAST

const ilLPPersonalGUI::LNG_VAR_PRESENTATION_OPTION_PAST = "view_mode_past"

protected

Definition at line 49 of file class.ilLPPersonalGUI.php.

◆ LNG_VAR_PROPERTY_CRS_END

const ilLPPersonalGUI::LNG_VAR_PROPERTY_CRS_END = "trac_end_at"

protected

Definition at line 52 of file class.ilLPPersonalGUI.php.

◆ LNG_VAR_PROPERTY_CRS_ONLINE

const ilLPPersonalGUI::LNG_VAR_PROPERTY_CRS_ONLINE = "online"

protected

Definition at line 53 of file class.ilLPPersonalGUI.php.

◆ LNG_VAR_PROPERTY_CRS_ONLINE_NO

const ilLPPersonalGUI::LNG_VAR_PROPERTY_CRS_ONLINE_NO = "no"

protected

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

◆ LNG_VAR_PROPERTY_CRS_ONLINE_YES

const ilLPPersonalGUI::LNG_VAR_PROPERTY_CRS_ONLINE_YES = "yes"

protected

Definition at line 54 of file class.ilLPPersonalGUI.php.

◆ LNG_VAR_PROPERTY_CRS_START

const ilLPPersonalGUI::LNG_VAR_PROPERTY_CRS_START = "trac_begin_at"

protected

Definition at line 51 of file class.ilLPPersonalGUI.php.

◆ PRESENTATION_OPTION_ALL

const ilLPPersonalGUI::PRESENTATION_OPTION_ALL = "all"

protected

Definition at line 42 of file class.ilLPPersonalGUI.php.

◆ PRESENTATION_OPTION_CURRENT

const ilLPPersonalGUI::PRESENTATION_OPTION_CURRENT = "current"

protected

Definition at line 39 of file class.ilLPPersonalGUI.php.

Referenced by getCurrentPresentationModeFromQuery().

◆ PRESENTATION_OPTION_FUTURE

const ilLPPersonalGUI::PRESENTATION_OPTION_FUTURE = "future"

protected

Definition at line 40 of file class.ilLPPersonalGUI.php.

◆ PRESENTATION_OPTION_PAST

const ilLPPersonalGUI::PRESENTATION_OPTION_PAST = "past"

protected

Definition at line 41 of file class.ilLPPersonalGUI.php.

◆ URL_NAMESPACE_PLP

const ilLPPersonalGUI::URL_NAMESPACE_PLP = "plp"

protected

Definition at line 45 of file class.ilLPPersonalGUI.php.

◆ URL_NAMESPACE_VIEWCONTROL

const ilLPPersonalGUI::URL_NAMESPACE_VIEWCONTROL = "viewcontrol"

protected

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

◆ URL_VAR_ACTION_MODE

const ilLPPersonalGUI::URL_VAR_ACTION_MODE = "mode"

protected

Definition at line 44 of file class.ilLPPersonalGUI.php.

◆ URL_VAR_MODE

const ilLPPersonalGUI::URL_VAR_MODE = "viewcontrol_plp_mode"

protected

Definition at line 43 of file class.ilLPPersonalGUI.php.

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

components/ILIAS/Tracking/classes/View/PersonalLearningProgress/class.ilLPPersonalGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildLinkToCourse()

◆ buildViewControls()

◆ executeCommand()

◆ getCurrentPresentationModeFromQuery()

◆ hasReadAccess()

◆ isPresentable()

◆ listCourses()

Field Documentation

◆ $access

◆ $ctrl

◆ $data_factory

◆ $http

◆ $lng

◆ $refinery

◆ $static_url

◆ $tracking_view

◆ $ui

◆ $user

◆ LNG_VAR_LISTING_TITLE

◆ LNG_VAR_PRESENTATION_OPTION_ALL

◆ LNG_VAR_PRESENTATION_OPTION_CURRENT

◆ LNG_VAR_PRESENTATION_OPTION_FUTURE

◆ LNG_VAR_PRESENTATION_OPTION_PAST

◆ LNG_VAR_PROPERTY_CRS_END

◆ LNG_VAR_PROPERTY_CRS_ONLINE

◆ LNG_VAR_PROPERTY_CRS_ONLINE_NO

◆ LNG_VAR_PROPERTY_CRS_ONLINE_YES

◆ LNG_VAR_PROPERTY_CRS_START

◆ PRESENTATION_OPTION_ALL

◆ PRESENTATION_OPTION_CURRENT

◆ PRESENTATION_OPTION_FUTURE

◆ PRESENTATION_OPTION_PAST

◆ URL_NAMESPACE_PLP

◆ URL_NAMESPACE_VIEWCONTROL

◆ URL_VAR_ACTION_MODE

◆ URL_VAR_MODE