ilPRGStatusInfoBuilder Class Reference

Builds PageContent "Status Information". More...

Collaboration diagram for ilPRGStatusInfoBuilder:

Public Member Functions
	__construct (UIFactory $ui_factory, Renderer $ui_renderer, ilLanguage $lng, ilCtrl $ctrl, ilTemplate $tpl, PRGAssignmentRepository $repo_assignment, ilStudyProgrammeSettingsRepository $repo_settings, ilCertificateDownloadValidator $cert_validator, int $usr_id)
	getStatusInfoFor (int $prg_obj_id)

Protected Member Functions
	getRestartPeriodOfProgrammeNode (int $prg_obj_id)
	maybeGetCertificateLink (int $prg_obj_id)

Protected Attributes
UIFactory	$ui_factory
Renderer	$ui_renderer
ilLanguage	$lng
ilCtrl	$ctrl
ilTemplate	$tpl
PRGAssignmentRepository	$repo_assignment
ilStudyProgrammeSettingsRepository	$repo_settings
ilCertificateDownloadValidator	$cert_validator
int	$usr_id

Detailed Description

Builds PageContent "Status Information".

Definition at line 27 of file ilPRGStatusInfoBuilder.php.

Constructor & Destructor Documentation

__construct()

ilPRGStatusInfoBuilder::__construct	(	UIFactory	$ui_factory,
		Renderer	$ui_renderer,
		ilLanguage	$lng,
		ilCtrl	$ctrl,
		ilTemplate	$tpl,
		PRGAssignmentRepository	$repo_assignment,
		ilStudyProgrammeSettingsRepository	$repo_settings,
		ilCertificateDownloadValidator	$cert_validator,
		int	$usr_id
	)

Definition at line 39 of file ilPRGStatusInfoBuilder.php.

References $cert_validator, $ctrl, $DIC, $repo_assignment, $repo_settings, $tpl, $ui_factory, $ui_renderer, $usr_id, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

      {
        global $DIC;
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $this->lng = $DIC->language();
        $this->ctrl = $ctrl;
        $this->tpl = $tpl;
        $this->repo_assignment = $repo_assignment;
        $this->repo_settings = $repo_settings;
        $this->cert_validator = $cert_validator;
        $this->usr_id = $usr_id;
    }

Here is the call graph for this function:

Member Function Documentation

getRestartPeriodOfProgrammeNode()

ilPRGStatusInfoBuilder::getRestartPeriodOfProgrammeNode ( int  $prg_obj_id )

protected

Definition at line 113 of file ilPRGStatusInfoBuilder.php.

Referenced by getStatusInfoFor().

                                                                       : ?DateInterval
    {
        $settings = $this->repo_settings->get($prg_obj_id);
        $offset_days = $settings->getValidityOfQualificationSettings()->getRestartPeriod();
        if ($offset_days) {
            return new DateInterval('P' . $offset_days . 'D');
        }
        return null;
    }

Here is the caller graph for this function:

getStatusInfoFor()

ilPRGStatusInfoBuilder::getStatusInfoFor

(

int

$prg_obj_id

)

Definition at line 62 of file ilPRGStatusInfoBuilder.php.

References ilUtil\getImagePath(), getRestartPeriodOfProgrammeNode(), ILIAS\Repository\lng(), and maybeGetCertificateLink().

                                                     : string
    {
        $status = 'pc_prgstatus_status_no_qualification';
        $status_txt = 'pc_prgstatus_text_no_qualification';
        $validity_txt = '';
        $icon = 'standard/icon_not_ok.svg';
        $restart_date = null;

        $ass = $this->repo_assignment->getLongestValidAssignment($prg_obj_id, $this->usr_id)
            ?? $this->repo_assignment->getLatestAssignment($prg_obj_id, $this->usr_id);

        if ($ass) {
            $pgs = $ass->getProgressTree();
            $now = new DateTimeImmutable();
            if ($pgs->hasValidQualification($now)) {
                $status = 'pc_prgstatus_status_valid_qualification';
                $status_txt = 'pc_prgstatus_unlimited_validation';
                $icon = 'standard/icon_ok.svg';
            }

            if ($validity = $pgs->getValidityOfQualification()) {
                $status_txt = 'pc_prgstatus_expiration_date';
                $validity_txt = ' ' . $validity->format('d.m.Y');

                $restart = $this->getRestartPeriodOfProgrammeNode($prg_obj_id);
                if (!is_null($restart)) {
                    $restart_date = $validity->sub($restart)->format('d.m.Y');
                }
            }
        }

        $icon = $this->ui_renderer->render(
            $this->ui_factory->symbol()->icon()->custom(
                \ilUtil::getImagePath($icon),
                $this->lng->txt($status_txt)
            )
            ->withSize('large')
        );
        $this->tpl->setVariable("ICON", $icon);
        $this->tpl->setVariable("HEADLINE", $this->lng->txt("pc_prgstatus_qualification_headline"));
        $this->tpl->setVariable("STATUS", $this->lng->txt($status));
        $this->tpl->setVariable("STATUS_TEXT", $this->lng->txt($status_txt) . $validity_txt);
        if ($certificate_link = $this->maybeGetCertificateLink($prg_obj_id)) {
            $this->tpl->setVariable("CERTIFICATE", $certificate_link);
        }
        if ($restart_date) {
            $this->tpl->setVariable("EDIT_QUALIFICATION", $this->lng->txt("pc_prgstatus_edit_qualification") . " " . $restart_date);
        }
        return $this->tpl->get();
    }

Here is the call graph for this function:

maybeGetCertificateLink()

ilPRGStatusInfoBuilder::maybeGetCertificateLink ( int  $prg_obj_id )

protected

Definition at line 123 of file ilPRGStatusInfoBuilder.php.

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

Referenced by getStatusInfoFor().

                                                               : ?string
    {
        if ($this->cert_validator->isCertificateDownloadable($this->usr_id, $prg_obj_id)) {
            $target = $this->ctrl->getLinkTargetByClass("ilObjStudyProgrammeGUI", "deliverCertificate");
            return $this->ui_renderer->render($this->ui_factory->link()->standard($this->lng->txt('download_certificate'), $target));
        }
        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$cert_validator

ilCertificateDownloadValidator ilPRGStatusInfoBuilder::$cert_validator

protected

Definition at line 36 of file ilPRGStatusInfoBuilder.php.

Referenced by __construct().

$ctrl

ilCtrl ilPRGStatusInfoBuilder::$ctrl

protected

Definition at line 32 of file ilPRGStatusInfoBuilder.php.

Referenced by __construct().

$lng

ilLanguage ilPRGStatusInfoBuilder::$lng

protected

Definition at line 31 of file ilPRGStatusInfoBuilder.php.

$repo_assignment

PRGAssignmentRepository ilPRGStatusInfoBuilder::$repo_assignment

protected

Definition at line 34 of file ilPRGStatusInfoBuilder.php.

Referenced by __construct().

$repo_settings

ilStudyProgrammeSettingsRepository ilPRGStatusInfoBuilder::$repo_settings

protected

Definition at line 35 of file ilPRGStatusInfoBuilder.php.

Referenced by __construct().

$tpl

ilTemplate ilPRGStatusInfoBuilder::$tpl

protected

Definition at line 33 of file ilPRGStatusInfoBuilder.php.

Referenced by __construct().

$ui_factory

UIFactory ilPRGStatusInfoBuilder::$ui_factory

protected

Definition at line 29 of file ilPRGStatusInfoBuilder.php.

Referenced by __construct().

$ui_renderer

Renderer ilPRGStatusInfoBuilder::$ui_renderer

protected

Definition at line 30 of file ilPRGStatusInfoBuilder.php.

Referenced by __construct().

$usr_id

int ilPRGStatusInfoBuilder::$usr_id

protected

Definition at line 37 of file ilPRGStatusInfoBuilder.php.

Referenced by __construct().

---

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

• components/ILIAS/StudyProgramme/classes/PageEditor/ilPRGStatusInfoBuilder.php