ilStudyProgrammeDashboardViewGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilStudyProgrammeDashboardViewGUI:

Public Member Functions
	__construct (ilLanguage $lng, ilAccess $access, ilSetting $setting, ILIAS\UI\Factory $factory, ILIAS\UI\Renderer $renderer, ilCtrl $ctrl, ilStudyProgrammeUserTable $user_table, int $usr_id)
	getHTML ()

Protected Member Functions
	getVisibleOnPDMode ()
	isReadable (ilObjStudyProgramme $prg)
	txt (string $code)
	buildItem (ilObjStudyProgramme $prg, array $properties)
	getDefaultTargetUrl (int $prg_ref_id)

Protected Attributes
ilLanguage	$lng
ilAccessHandler	$access
ilSetting	$setting
ILIAS UI Factory	$factory
ILIAS UI Renderer	$renderer
ilCtrl	$ctrl
ilStudyProgrammeUserTable	$user_table
int	$usr_id
string	$visible_on_pd_mode = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 21 of file class.ilStudyProgrammeDashboardViewGUI.php.

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeDashboardViewGUI::__construct	(	ilLanguage	$lng,
		ilAccess	$access,
		ilSetting	$setting,
		ILIAS\UI\Factory	$factory,
		ILIAS\UI\Renderer	$renderer,
		ilCtrl	$ctrl,
		ilStudyProgrammeUserTable	$user_table,
		int	$usr_id
	)

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

References $access, $ctrl, $factory, $lng, $renderer, $setting, $user_table, $usr_id, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

      {
        $this->lng = $lng;
        $this->lng->loadLanguageModule('prg');
        $this->lng->loadLanguageModule('certificate');
        $this->access = $access;
        $this->setting = $setting;
        $this->factory = $factory;
        $this->renderer = $renderer;
        $this->ctrl = $ctrl;
        $this->user_table = $user_table;
        $this->usr_id = $usr_id;
    }

Here is the call graph for this function:

Member Function Documentation

buildItem()

ilStudyProgrammeDashboardViewGUI::buildItem ( ilObjStudyProgramme  $prg, array  $properties  )

protected

Definition at line 131 of file class.ilStudyProgrammeDashboardViewGUI.php.

References getDefaultTargetUrl(), ilObject\getLongDescription(), ilObject\getRefId(), ilObject\getTitle(), ILIAS\Repository\int(), and ilStr\shortenTextExtended().

Referenced by getHTML().

     : ILIAS\UI\Component\Item\Item {
        $title = $prg->getTitle();
        $link = $this->getDefaultTargetUrl($prg->getRefId());
        $title_btn = $this->factory->button()->shy($title, $link);
        $description = $prg->getLongDescription() ?? "";
        $max = (int) $this->setting->get("rep_shorten_description_length");
        if ($this->setting->get("rep_shorten_description") && $max !== 0) {
            $description = ilStr::shortenTextExtended($description, $max, true);
        }

        $icon = $this->factory->symbol()->icon()->standard('prg', $title, 'medium');
        return $this->factory->item()->standard($title_btn)
            ->withProperties(array_merge(...$properties))
            ->withDescription($description)
            ->withLeadIcon($icon)
        ;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultTargetUrl()

ilStudyProgrammeDashboardViewGUI::getDefaultTargetUrl ( int  $prg_ref_id )

protected

Definition at line 152 of file class.ilStudyProgrammeDashboardViewGUI.php.

References ILIAS\Repository\ctrl().

Referenced by buildItem().

                                                           : string
    {
        $this->ctrl->setParameterByClass(
            ilObjStudyProgrammeGUI::class,
            'ref_id',
            $prg_ref_id
        );
        $link = $this->ctrl->getLinkTargetByClass(
            [
                ilRepositoryGUI::class,
                ilObjStudyProgrammeGUI::class,
            ]
        );
        $this->ctrl->setParameterByClass(
            ilObjStudyProgrammeGUI::class,
            'ref_id',
            null
        );
        return $link;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilStudyProgrammeDashboardViewGUI::getHTML

(

)

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

References $panel, $rows, buildItem(), ilObjStudyProgramme\getInstanceByObjId(), isReadable(), ILIAS\Repository\lng(), ilPRGProgress\STATUS_ACCREDITED, ilPRGProgress\STATUS_COMPLETED, and txt().

                             : string
    {
        //array ilStudyProgrammeUserTableRow[]
        $this->user_table->disablePermissionCheck(true);
        $rows = $this->user_table->fetchSingleUserRootAssignments($this->usr_id);
        $items = [];
        foreach ($rows as $row) {
            $prg = ilObjStudyProgramme::getInstanceByObjId($row->getNodeId());
            if (! $this->isReadable($prg)) {
                continue;
            }

            $min = $row->getPointsRequired();
            $max = $row->getPointsReachable();
            $cur = $row->getPointsCurrent();
            $required_string = $min;
            if ((float)$max < (float)$min) {
                $required_string .= ' ' . $this->txt('prg_dash_label_unreachable') . ' (' . $max . ')';
            }

            $properties = [
                [$this->txt('prg_dash_label_minimum') => $required_string],
                [$this->txt('prg_dash_label_gain') => $cur],
                [$this->txt('prg_dash_label_status') => $row->getStatus()],
            ];

            if (in_array($row->getStatusRaw(), [ilPRGProgress::STATUS_COMPLETED, ilPRGProgress::STATUS_ACCREDITED])) {
                $validity = $row->getExpiryDate() ? $row->getExpiryDate() : $row->getValidity();
                $properties[] = [$this->txt('prg_dash_label_valid') => $validity];
            } else {
                $properties[] = [$this->txt('prg_dash_label_finish_until') =>$row->getDeadline()];
            }

            $validator = new ilCertificateDownloadValidator();
            if ($validator->isCertificateDownloadable($row->getUsrId(), $row->getNodeId())) {
                $cert_url = "ilias.php?baseClass=ilRepositoryGUI&ref_id=" . $prg->getRefId() . "&cmd=deliverCertificate";
                $cert_link = $this->factory->link()->standard($this->txt('download_certificate'), $cert_url);
                $properties[] = [$this->txt('certificate') => $this->renderer->render($cert_link)];
            }

            $items[] = $this->buildItem($prg, $properties);
        }

        if (count($items) === 0) {
            return '';
        }
        $group[] = $this->factory->item()->group("", $items);
        $panel = $this->factory->panel()->listing()->standard($this->lng->txt("dash_studyprogramme"), $group);

        return $this->renderer->render($panel);
    }

Here is the call graph for this function:

getVisibleOnPDMode()

ilStudyProgrammeDashboardViewGUI::getVisibleOnPDMode ( )

protected

Definition at line 106 of file class.ilStudyProgrammeDashboardViewGUI.php.

References $visible_on_pd_mode, ilObjStudyProgrammeAdmin\SETTING_VISIBLE_ON_PD, and ilObjStudyProgrammeAdmin\SETTING_VISIBLE_ON_PD_READ.

Referenced by isReadable().

                                           : string
    {
        if (is_null($this->visible_on_pd_mode)) {
            $this->visible_on_pd_mode =
                $this->setting->get(
                    ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD,
                    ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_READ
                );
        }
        return $this->visible_on_pd_mode;
    }

Here is the caller graph for this function:

isReadable()

ilStudyProgrammeDashboardViewGUI::isReadable ( ilObjStudyProgramme  $prg )

protected

Definition at line 118 of file class.ilStudyProgrammeDashboardViewGUI.php.

References ILIAS\Repository\access(), ilObject\getId(), ilObject\getRefId(), getVisibleOnPDMode(), and ilObjStudyProgrammeAdmin\SETTING_VISIBLE_ON_PD_ALLWAYS.

Referenced by getHTML().

                                                           : bool
    {
        if ($this->getVisibleOnPDMode() === ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_ALLWAYS) {
            return true;
        }
        return $this->access->checkAccess('read', "", $prg->getRefId(), "prg", $prg->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

txt()

ilStudyProgrammeDashboardViewGUI::txt ( string  $code )

protected

Definition at line 126 of file class.ilStudyProgrammeDashboardViewGUI.php.

References ILIAS\Repository\lng().

Referenced by getHTML().

                                        : string
    {
        return $this->lng->txt($code);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilStudyProgrammeDashboardViewGUI::$access

protected

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

Referenced by __construct().

$ctrl

ilCtrl ilStudyProgrammeDashboardViewGUI::$ctrl

protected

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

Referenced by __construct().

$factory

ILIAS UI Factory ilStudyProgrammeDashboardViewGUI::$factory

protected

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

Referenced by __construct().

$lng

ilLanguage ilStudyProgrammeDashboardViewGUI::$lng

protected

Definition at line 23 of file class.ilStudyProgrammeDashboardViewGUI.php.

Referenced by __construct().

$renderer

ILIAS UI Renderer ilStudyProgrammeDashboardViewGUI::$renderer

protected

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

Referenced by __construct().

$setting

ilSetting ilStudyProgrammeDashboardViewGUI::$setting

protected

Definition at line 25 of file class.ilStudyProgrammeDashboardViewGUI.php.

Referenced by __construct().

$user_table

ilStudyProgrammeUserTable ilStudyProgrammeDashboardViewGUI::$user_table

protected

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

Referenced by __construct().

$usr_id

int ilStudyProgrammeDashboardViewGUI::$usr_id

protected

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

Referenced by __construct().

$visible_on_pd_mode

string ilStudyProgrammeDashboardViewGUI::$visible_on_pd_mode = null

protected

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

Referenced by getVisibleOnPDMode().

---

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

• Modules/StudyProgramme/classes/class.ilStudyProgrammeDashboardViewGUI.php