ilPRGActionNoteBuilder.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer;

class ilPRGActionNoteBuilder
{
    protected UIFactory $ui_factory;
    protected Renderer $ui_renderer;
    protected ilLanguage $lng;
    protected ilCtrl $ctrl;
    protected ilTemplate $tpl;
    protected PRGAssignmentRepository $repo_assignment;
    protected ilStudyProgrammeSettingsRepository $repo_settings;
    protected int $usr_id;

    public function __construct(
        UIFactory $ui_factory,
        Renderer $ui_renderer,
        ilLanguage $lng,
        ilCtrl $ctrl,
        ilTemplate $tpl,
        PRGAssignmentRepository $repo_assignment,
        ilStudyProgrammeSettingsRepository $repo_settings,
        int $usr_id
    ) {
        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->usr_id = $usr_id;
    }

    public function getNoteFor(int $prg_obj_id): string
    {
        $ass = $this->repo_assignment->getLatestAssignment($prg_obj_id, $this->usr_id);
        $instruction = '';
        $icon = 'page_editor/icon_pean.svg';
        $dealine_str = '';

        if ($ass) {
            $progresses[] = $ass->getProgressTree();
            $now = new DateTimeImmutable();
            $deadline = null;
            $in_progress = array_filter($progresses, fn($pgs) => $pgs->isInProgress());
            $accredited_or_completed = array_filter($progresses, fn($pgs) => $pgs->isSuccessful());
            if (count($in_progress) === 0) {
                $failed = array_filter($progresses, fn($pgs) => $pgs->isFailed());
                $failed = $this->sortByDeadline($failed);
                if (count($accredited_or_completed) > 0) {
                    $instruction = 'pc_prgactionnote_no_actions_required';
                }
                if (count($failed) > 0 && count($accredited_or_completed) === 0) {
                    $instruction = 'pc_prgactionnote_no_actions_required';
                    $deadline = array_shift($failed)->getDeadline();
                    $dealine_str = ' ' . $deadline->format($this->getUserDateFormat());
                }
            } elseif($accredited_or_completed) {
                $instruction = 'pc_prgactionnote_no_actions_required';
            } else {
                $instruction = 'pc_prgactionnote_complete_content';
                $in_progress_with_deadline = $this->sortByDeadline($in_progress);
                $in_progress_with_deadline = array_filter(
                    $in_progress_with_deadline,
                    fn($pgs) => $pgs->getDeadline()->format('Y-m-d') >= $now->format('Y-m-d')
                );
                if (count($in_progress_with_deadline) > 0) {
                    $deadline = array_shift($in_progress_with_deadline)->getDeadline();
                }

                if (!is_null($deadline)) {
                    $dealine_str = ' ' . $deadline->format($this->getUserDateFormat()) . '.';
                    $instruction = 'pc_prgactionnote_complete_content_with_deadline';
                }
            }
        } else {
            $instruction = 'pc_prgactionnote_no_actions_required';
        }

        $icon = $this->ui_renderer->render(
            $this->ui_factory->symbol()->icon()->custom(
                ilUtil::getImagePath($icon),
                $this->lng->txt($instruction)
            )->withSize('large')
        );

        $this->tpl->setVariable("HEADLINE", $this->lng->txt('pc_prgactionnote_headline'));
        $this->tpl->setVariable("ICON", $icon);
        $this->tpl->setVariable("NOTE_TEXT", $this->lng->txt($instruction) . $dealine_str);
        return $this->tpl->get();
    }

    protected function sortByDeadline(array $progresses): array
    {
        $progresses = array_filter($progresses, fn($pgs) => $pgs->getDeadline());
        usort(
            $progresses,
            static function (ilPRGProgress $a, ilPRGProgress $b): int {
                $a_dat = $a->getDeadline();
                $b_dat = $b->getDeadline();
                if ($a_dat === $b_dat) {
                    return 0;
                }
                return ($a_dat < $b_dat) ? -1 : 1;
            }
        );
        return $progresses;
    }

    protected function getUserDateFormat(): string
    {
        return ilCalendarUtil::getUserDateFormat(0, true);
    }
}