ilPRGActionNoteBuilder Class Reference

Builds PageContent "Note". More...

Collaboration diagram for ilPRGActionNoteBuilder:

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

Protected Member Functions
	sortByDeadline (array $progresses)
	getUserDateFormat ()

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

Detailed Description

Builds PageContent "Note".

Definition at line 27 of file ilPRGActionNoteBuilder.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 38 of file ilPRGActionNoteBuilder.php.

References $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->usr_id = $usr_id;
    }

Here is the call graph for this function:

Member Function Documentation

getNoteFor()

ilPRGActionNoteBuilder::getNoteFor

(

int

$prg_obj_id

)

Definition at line 59 of file ilPRGActionNoteBuilder.php.

References ilUtil\getImagePath(), getUserDateFormat(), ILIAS\Repository\lng(), and sortByDeadline().

                                               : 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();
    }

Here is the call graph for this function:

getUserDateFormat()

ilPRGActionNoteBuilder::getUserDateFormat ( )

protected

Definition at line 135 of file ilPRGActionNoteBuilder.php.

References ilCalendarUtil\getUserDateFormat().

Referenced by getNoteFor().

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

Here is the call graph for this function:

Here is the caller graph for this function:

sortByDeadline()

ilPRGActionNoteBuilder::sortByDeadline ( array  $progresses )

protected

Definition at line 118 of file ilPRGActionNoteBuilder.php.

References Vendor\Package\$a, Vendor\Package\$b, and ilPRGProgress\getDeadline().

Referenced by getNoteFor().

                                                        : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilPRGActionNoteBuilder::$ctrl

protected

Definition at line 32 of file ilPRGActionNoteBuilder.php.

Referenced by __construct().

$lng

ilLanguage ilPRGActionNoteBuilder::$lng

protected

Definition at line 31 of file ilPRGActionNoteBuilder.php.

$repo_assignment

PRGAssignmentRepository ilPRGActionNoteBuilder::$repo_assignment

protected

Definition at line 34 of file ilPRGActionNoteBuilder.php.

Referenced by __construct().

$repo_settings

ilStudyProgrammeSettingsRepository ilPRGActionNoteBuilder::$repo_settings

protected

Definition at line 35 of file ilPRGActionNoteBuilder.php.

Referenced by __construct().

$tpl

ilTemplate ilPRGActionNoteBuilder::$tpl

protected

Definition at line 33 of file ilPRGActionNoteBuilder.php.

Referenced by __construct().

$ui_factory

UIFactory ilPRGActionNoteBuilder::$ui_factory

protected

Definition at line 29 of file ilPRGActionNoteBuilder.php.

Referenced by __construct().

$ui_renderer

Renderer ilPRGActionNoteBuilder::$ui_renderer

protected

Definition at line 30 of file ilPRGActionNoteBuilder.php.

Referenced by __construct().

$usr_id

int ilPRGActionNoteBuilder::$usr_id

protected

Definition at line 36 of file ilPRGActionNoteBuilder.php.

Referenced by __construct().

---

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

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