ilStudyProgrammeDashboardViewGUI Class Reference

Inheritance diagram for ilStudyProgrammeDashboardViewGUI:

Collaboration diagram for ilStudyProgrammeDashboardViewGUI:

Public Member Functions
	__construct (ilLanguage $lng, ilObjUser $user, ilAccess $access, ilSetting $setting, ILIAS\UI\Factory $factory, ILIAS\UI\Renderer $renderer, ilCtrl $ctrl, ilLogger $log)
	getHTML ()

Protected Member Functions
	getProgressRepository ()
	getAssignmentRepository ()
	getUsersAssignments ()
	isInProgress (int $current_status)
	fillValidation (?bool $valid, ?DateTimeImmutable $validation_expiry_date)
	fillMinimumCompletion (float $value)
	fillCurrentCompletion (float $value)
	fillStatus (string $status)
	fillFinishUntil (DateTimeImmutable $value=null)
	fillRestartFrom (DateTimeImmutable $value=null)
	getVisibleOnPDMode ()
	hasPermission (ilStudyProgrammeAssignment $assignment, string $permission)
	isReadable (ilStudyProgrammeAssignment $assignment)
	txt (string $code)
	calculatePercent (ilObjStudyProgramme $prg, int $current_points)
	findValidationValues (array $assignments)
	findValid (array $assignments)
	buildItem (ilObjStudyProgramme $prg, array $properties)
	getDefaultTargetUrl (int $prg_ref_id)

Protected Attributes
	$lng
	$user
	$access
	$setting
	$visible_on_pd_mode
	$log
	$factory
	$renderer
	$ctrl
	$progress_repository
	$assignment_repository

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeDashboardViewGUI::__construct	(	ilLanguage	$lng,
		ilObjUser	$user,
		ilAccess	$access,
		ilSetting	$setting,
		ILIAS\UI\Factory	$factory,
		ILIAS\UI\Renderer	$renderer,
		ilCtrl	$ctrl,
		ilLogger	$log
	)

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

References $access, $ctrl, $factory, $lng, $log, $renderer, $setting, $user, and user().

      {
        $this->lng = $lng;
        $this->lng->loadLanguageModule('prg');
        $this->user = $user;
        $this->access = $access;
        $this->setting = $setting;
        $this->log = $log;
        $this->factory = $factory;
        $this->renderer = $renderer;
        $this->ctrl = $ctrl;
    }

Here is the call graph for this function:

Member Function Documentation

buildItem()

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

protected

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

References getDefaultTargetUrl(), ilObject\getLongDescription(), ilObject\getRefId(), ilObject\getTitle(), and ilUtil\shortenText().

Referenced by getHTML().

      : ILIAS\UI\Component\Item\Item {
        $title = $prg->getTitle();
        $link = $this->getDefaultTargetUrl((int) $prg->getRefId());
        $title_btn = $this->factory->button()->shy($title, $link);
        $description = $prg->getLongDescription() ?? "";
        $max = $this->setting->get("rep_shorten_description_length");
        if ($this->setting->get("rep_shorten_description") && $max) {
            $description = ilUtil::shortenText($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:

calculatePercent()

ilStudyProgrammeDashboardViewGUI::calculatePercent ( ilObjStudyProgramme  $prg, int  $current_points  )

protected

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

References ilObjStudyProgramme\getAllPrgChildren(), ilObjStudyProgramme\getPoints(), and ilObjStudyProgramme\hasLPChildren().

Referenced by getHTML(), and mockSPRGDashGUI\mockCalculatePercent().

                                                                                       : array
    {
        $minimum_percents = 0;
        $current_percents = 0;

        if ($prg->hasLPChildren()) {
            $minimum_percents = 100;
            if ($current_points > 0) {
                $current_percents = 100;
            }
        }

        $children = $prg->getAllPrgChildren();
        if (count($children) > 0) {
            $max_points = 0;
            foreach ($children as $child) {
                $max_points += $child->getPoints();
            }

            if ($max_points > 0) {
                $prg_points = $prg->getPoints();
                $minimum_percents = round((100 * $prg_points / $max_points), 2);
            }
            if ($current_points > 0) {
                $current_percents = round((100 * $current_points / $max_points), 2);
            }
        }

        return [
            $minimum_percents,
            $current_percents
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillCurrentCompletion()

ilStudyProgrammeDashboardViewGUI::fillCurrentCompletion ( float  $value )

protected

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

References txt().

Referenced by getHTML().

                                                           : array
    {
        $title = $value . " " . $this->txt('percentage');
        return [
            $this->txt('prg_dash_label_gain') => $title
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillFinishUntil()

ilStudyProgrammeDashboardViewGUI::fillFinishUntil ( DateTimeImmutable  $value = null )

protected

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

References $ret, ilDatePresentation\formatDate(), IL_CAL_DATE, and txt().

Referenced by getHTML().

                                                                        : array
    {
        $ret = [];
        if (!is_null($value)) {
            $date = new ilDate(
                $value->format('Y-m-d'),
                IL_CAL_DATE
            );
            $date_string = ilDatePresentation::formatDate($date);
            $ret[$this->txt('prg_dash_label_finish_until')] = $date_string;
        }
        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillMinimumCompletion()

ilStudyProgrammeDashboardViewGUI::fillMinimumCompletion ( float  $value )

protected

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

References txt().

Referenced by getHTML().

                                                           : array
    {
        $title = $value . " " . $this->txt('percentage');
        return [
            $this->txt('prg_dash_label_minimum') => $title
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillRestartFrom()

ilStudyProgrammeDashboardViewGUI::fillRestartFrom ( DateTimeImmutable  $value = null )

protected

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

References $ret, ilDatePresentation\formatDate(), IL_CAL_DATE, and txt().

Referenced by getHTML().

                                                                        : array
    {
        $ret = [];
        if (!is_null($value)) {
            $date = new ilDate(
                $value->format('Y-m-d'),
                IL_CAL_DATE
            );
            $date_string = ilDatePresentation::formatDate($date);
            $ret[$this->txt('prg_dash_label_restart_from')] = $date_string;
        }
        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillStatus()

ilStudyProgrammeDashboardViewGUI::fillStatus ( string  $status )

protected

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

References txt().

Referenced by getHTML().

                                                  : array
    {
        return [
            $this->txt('prg_dash_label_status') => $this->txt('prg_status_' . $status)
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillValidation()

ilStudyProgrammeDashboardViewGUI::fillValidation ( ?bool  $valid, ?DateTimeImmutable  $validation_expiry_date  )

protected

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

References ilDatePresentation\formatDate(), IL_CAL_DATE, and txt().

Referenced by getHTML().

      : array {
        if (!$valid) {
            $validation = $this->txt('no');
        }
        if ($valid && is_null($validation_expiry_date)) {
            $validation = $this->txt('yes');
        }
        if ($valid && !is_null($validation_expiry_date)) {
            $date = new ilDate($validation_expiry_date->format('Y-m-d'), IL_CAL_DATE);
            $validation = ilDatePresentation::formatDate($date);
        }

        return [
            $this->txt('prg_dash_label_valid') => $validation
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findValid()

ilStudyProgrammeDashboardViewGUI::findValid ( array  $assignments )

protected

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

References ilObjStudyProgramme\getInstanceByObjId(), ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_COMPLETED.

Referenced by findValidationValues().

    {
        $status = [
            ilStudyProgrammeProgress::STATUS_COMPLETED,
            ilStudyProgrammeProgress::STATUS_ACCREDITED
        ];
        foreach ($assignments as $key => $assignment) {
            $prg = ilObjStudyProgramme::getInstanceByObjId($assignment->getRootId());
            $progress = $prg->getProgressForAssignment($assignment->getId());
            
            if (in_array($progress->getStatus(), $status)) {
                return $progress->getValidityOfQualification();
            }
        }
        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findValidationValues()

ilStudyProgrammeDashboardViewGUI::findValidationValues ( array  $assignments )

protected

Exceptions

ilException

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

References findValid().

                                                                : array
    {
        $validation_date = $this->findValid($assignments);

        return [
            !is_null($validation_date) && $validation_date->format("Y-m-d") > date("Y-m-d"),
            $validation_date
        ];
    }

Here is the call graph for this function:

getAssignmentRepository()

ilStudyProgrammeDashboardViewGUI::getAssignmentRepository ( )

protected

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

References $assignment_repository, and ilStudyProgrammeDIC\dic().

Referenced by getUsersAssignments().

                                                 : ilStudyProgrammeAssignmentRepository
    {
        if (!$this->assignment_repository) {
            $this->assignment_repository = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserAssignmentDB'];
        }
        return $this->assignment_repository;
    }

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 380 of file class.ilStudyProgrammeDashboardViewGUI.php.

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 caller graph for this function:

getHTML()

ilStudyProgrammeDashboardViewGUI::getHTML

(

)

Exceptions

ilException

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

References $panel, $valid, buildItem(), calculatePercent(), fillCurrentCompletion(), fillFinishUntil(), fillMinimumCompletion(), fillRestartFrom(), fillStatus(), fillValidation(), ilObjStudyProgramme\getInstanceByObjId(), getProgressRepository(), getUsersAssignments(), and isReadable().

                              : string
    {
        $items = [];
        $now = new DateTimeImmutable();

        foreach ($this->getUsersAssignments() as $assignments) {
            $properties = [];
            krsort($assignments);

            $assignment = current($assignments);
            if (!$this->isReadable($assignment)) {
                continue;
            }

            $progress = $this->getProgressRepository()->getRootProgressOf($assignment);

            $current_prg = ilObjStudyProgramme::getInstanceByObjId($assignment->getRootId());
            list($minimum_percents, $current_percents) = $this->calculatePercent(
                $current_prg,
                $progress->getCurrentAmountOfPoints()
            );

            $current_status = $progress->getStatus();
            $deadline = $progress->getDeadline();
            $restart_date = $assignment->getRestartDate();

            $properties[] = $this->fillMinimumCompletion($minimum_percents);
            $properties[] = $this->fillCurrentCompletion($current_percents);
            $properties[] = $this->fillStatus((string) $current_status);

            if ($progress->isSuccessful()) {
                $properties[] = $this->fillRestartFrom($restart_date);
                
                $valid = $progress->hasValidQualification($now);
                $validation_expiry_date = $progress->getValidityOfQualification();
                $properties[] = $this->fillValidation($valid, $validation_expiry_date);
            }
            if ($progress->isInProgress()) {
                $properties[] = $this->fillFinishUntil($deadline);
            }



            $items[] = $this->buildItem($current_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:

getProgressRepository()

ilStudyProgrammeDashboardViewGUI::getProgressRepository ( )

protected

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

References $progress_repository, and ilStudyProgrammeDIC\dic().

Referenced by getHTML().

                                               : ilStudyProgrammeProgressRepository
    {
        if (!$this->progress_repository) {
            $this->progress_repository = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserProgressDB'];
        }
        return $this->progress_repository;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUsersAssignments()

ilStudyProgrammeDashboardViewGUI::getUsersAssignments ( )

protected

Returns

ilStudyProgrammeAssignment[]

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

References getAssignmentRepository(), and user().

Referenced by getHTML().

                                             : array
    {
        return $this->getAssignmentRepository()->getDashboardInstancesforUser($this->user->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getVisibleOnPDMode()

ilStudyProgrammeDashboardViewGUI::getVisibleOnPDMode ( )

protected

Definition at line 249 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:

hasPermission()

ilStudyProgrammeDashboardViewGUI::hasPermission ( ilStudyProgrammeAssignment  $assignment, string  $permission  )

protected

Exceptions

ilException

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

References Vendor\Package\$e, ilObjStudyProgramme\getInstanceByObjId(), and ilStudyProgrammeAssignment\getRootId().

Referenced by isReadable().

      : bool {
        try {
            $prg = ilObjStudyProgramme::getInstanceByObjId($assignment->getRootId());
        } catch (\ilException $e) {
            return false;
        }
        return $this->access->checkAccess($permission, "", $prg->getRefId(), "prg", $prg->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isInProgress()

ilStudyProgrammeDashboardViewGUI::isInProgress ( int  $current_status )

protected

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

References ilStudyProgrammeProgress\STATUS_IN_PROGRESS.

                                                         : bool
    {
        $status = [
            ilStudyProgrammeProgress::STATUS_IN_PROGRESS
        ];
        return in_array($current_status, $status);
    }

isReadable()

ilStudyProgrammeDashboardViewGUI::isReadable ( ilStudyProgrammeAssignment  $assignment )

protected

Exceptions

ilException

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

References getVisibleOnPDMode(), hasPermission(), and ilObjStudyProgrammeAdmin\SETTING_VISIBLE_ON_PD_ALLWAYS.

Referenced by getHTML().

                                                                          : bool
    {
        if ($this->getVisibleOnPDMode() == ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_ALLWAYS) {
            return true;
        }

        return $this->hasPermission($assignment, "read");
    }

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 288 of file class.ilStudyProgrammeDashboardViewGUI.php.

Referenced by fillCurrentCompletion(), fillFinishUntil(), fillMinimumCompletion(), fillRestartFrom(), fillStatus(), and fillValidation().

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

Here is the caller graph for this function:

Field Documentation

$access

ilStudyProgrammeDashboardViewGUI::$access

protected

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

Referenced by __construct().

$assignment_repository

ilStudyProgrammeDashboardViewGUI::$assignment_repository

protected

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

Referenced by getAssignmentRepository().

$ctrl

ilStudyProgrammeDashboardViewGUI::$ctrl

protected

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

Referenced by __construct().

$factory

ilStudyProgrammeDashboardViewGUI::$factory

protected

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

Referenced by __construct().

$lng

ilStudyProgrammeDashboardViewGUI::$lng

protected

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

Referenced by __construct().

$log

ilStudyProgrammeDashboardViewGUI::$log

protected

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

Referenced by __construct().

$progress_repository

ilStudyProgrammeDashboardViewGUI::$progress_repository

protected

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

Referenced by getProgressRepository().

$renderer

ilStudyProgrammeDashboardViewGUI::$renderer

protected

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

Referenced by __construct().

$setting

ilStudyProgrammeDashboardViewGUI::$setting

protected

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

Referenced by __construct().

$user

ilStudyProgrammeDashboardViewGUI::$user

protected

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

Referenced by __construct().

$visible_on_pd_mode

ilStudyProgrammeDashboardViewGUI::$visible_on_pd_mode

protected

Definition at line 33 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