class.ilIndividualAssessmentMembersTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use ILIAS\UI\Component\Table\PresentationRow;
use ILIAS\UI\Component\Dropdown\Dropdown;

class ilIndividualAssessmentMembersTableGUI
{
    protected ilIndividualAssessmentMembersGUI $parent;
    protected ilLanguage $lng;
    protected ilCtrl $ctrl;
    protected IndividualAssessmentAccessHandler $iass_access;
    protected Factory $factory;
    protected Renderer $renderer;
    protected int $current_user_id;
    protected ilObjUser $current_user;
    protected ilIndividualAssessmentDateFormatter $date_formatter;
    protected array $data = [];

    public function __construct(
        ilIndividualAssessmentMembersGUI $parent,
        ilLanguage $lng,
        ilCtrl $ctrl,
        IndividualAssessmentAccessHandler $iass_access,
        Factory $factory,
        Renderer $renderer,
        ilObjUser $current_user,
        ilIndividualAssessmentDateFormatter $date_formatter
    ) {
        $this->parent = $parent;
        $this->lng = $lng;
        $this->ctrl = $ctrl;
        $this->iass_access = $iass_access;
        $this->factory = $factory;
        $this->renderer = $renderer;
        $this->current_user_id = $current_user->getId();
        $this->current_user = $current_user;
        $this->date_formatter = $date_formatter;
    }

    public function setData(array $data): void
    {
        $this->data = array_filter(
            $data,
            fn($record) =>
                 $this->iass_access->mayEditMembers()
                 || $this->iass_access->mayGradeUser($record->id())
                 || $this->iass_access->mayViewUser($record->id())
        );
    }

    public function render(array $view_constrols, int $offset = 0, ?int $limit = null): string
    {
        $ptable = $this->factory->table()->presentation(
            "",
            $view_constrols,
            function (
                PresentationRow $row,
                ilIndividualAssessmentMember $record,
                Factory $ui,
                $environment
            ) {
                return $row
                    ->withHeadline($this->getHeadline($record))
                    ->withSubheadline($this->getSubheadline($record))
                    ->withImportantFields($this->getImportantInfos($record))
                    ->withContent($ui->listing()->descriptive($this->getContent($record)))
                    ->withFurtherFieldsHeadline($this->txt("iass_further_field_headline"))
                    ->withFurtherFields($this->getFurtherFields($record))
                    ->withAction($this->getAction($record, $ui));
            }
        );

        $data = array_slice($this->data, $offset, $limit);
        return $this->renderer->render($ptable->withData($data));
    }

    protected function getHeadline(ilIndividualAssessmentMember $record): string
    {
        return $record->lastname() . ", " . $record->firstname() . " [" . $record->login() . "]";
    }

    protected function getSubheadline(ilIndividualAssessmentMember $record): string
    {
        if (!$this->iass_access->mayViewUser($record->id()) && !$this->iass_access->mayGradeUser($record->id())) {
            return "";
        }

        $examiner_id = $record->examinerId();
        return $this->txt("grading") . ": " . $this->getStatus($record->finalized(), $record->LPStatus(), $examiner_id);
    }

    protected function getImportantInfos(ilIndividualAssessmentMember $record, bool $finalized_only = true): array
    {
        if (
            (!$this->iass_access->mayViewUser($record->id()) && !$this->iass_access->mayGradeUser($record->id()))
            ||
            (!$record->finalized() && $finalized_only)
        ) {
            return [];
        }

        return array_merge(
            $this->getGradedInformation($record->eventTime()),
            $this->getGradedByInformation($record->examinerId()),
            $this->getChangedByInformation($record->changerId(), $record->changeTime())
        );
    }

    protected function getGradedByInformation(?int $graded_by_id): array
    {
        if (is_null($graded_by_id)) {
            return [];
        }

        if (!ilObjUser::userExists([$graded_by_id])) {
            return [$this->txt('iass_graded_by') => $this->txt("user_deleted")];
        }

        $full_name = $this->getFullNameFor($graded_by_id);
        if (!$this->hasPublicProfile($graded_by_id)) {
            return [$this->txt('iass_graded_by') => $full_name];
        }

        return [
            $this->txt('iass_graded_by') => $this->getProfileLink($full_name, $graded_by_id)
        ];
    }

    protected function getChangedByInformation(?int $changed_by_id, ?DateTimeImmutable $change_date): array
    {
        if (is_null($changed_by_id)) {
            return [];
        }

        $changed_date_str = "";
        if (!is_null($change_date)) {
            $changed_date_str = $this->date_formatter->format($this->current_user, $change_date);
        }

        $full_name = $this->getFullNameFor($changed_by_id);
        if (!$this->hasPublicProfile($changed_by_id)) {
            return [$this->txt('iass_changed_by') => $full_name . ' ' . $changed_date_str];
        }

        return [
            $this->txt('iass_changed_by') => $this->getProfileLink($full_name, $changed_by_id) . ' ' . $changed_date_str
        ];
    }

    protected function getContent(ilIndividualAssessmentMember $record): array
    {
        $examiner_id = $record->examinerId();
        if (
            !$this->checkEditable($record->finalized(), $record->id(), $examiner_id)
            && !$this->checkAmendable($record->finalized())
            && !$this->iass_access->mayViewUser($record->id())
            && !$this->iass_access->mayGradeUser($record->id())
        ) {
            return [];
        }

        $usr_id = $record->id();

        if (
            !$this->iass_access->mayViewUser($usr_id)
            && !$record->finalized()
            && $examiner_id !== $this->current_user_id
        ) {
            return [];
        }

        $file_name = $record->fileName();

        return array_merge(
            $this->getRecordNote($record->record()),
            $this->getInternalRecordNote($record->internalNote()),
            $this->checkDownloadFile($usr_id, $file_name)
                ? $this->getFileDownloadLink($usr_id)
                : []
        );
    }

    protected function getFurtherFields(ilIndividualAssessmentMember $record): array
    {
        if (!$this->iass_access->mayViewUser($record->id()) && !$this->iass_access->mayGradeUser($record->id())) {
            return [];
        }

        return array_merge(
            $record->LPStatus() ? [$this->txt("grading") . ":" => $this->getEntryForStatus($record->LPStatus())] : [],
            $this->getImportantInfos($record, false),
            $this->getLocationInfos(
                $record->finalized(),
                $record->id(),
                $record->place(),
                $record->examinerId()
            )
        );
    }

    protected function getAction(ilIndividualAssessmentMember $record, Factory $ui_factory): Dropdown
    {
        $items = [];

        $examiner_id = $record->examinerId();
        $usr_id = $record->id();
        $finalized = $record->finalized();
        $file_name = $record->fileName();

        $this->ctrl->setParameterByClass('ilIndividualAssessmentMemberGUI', 'usr_id', $usr_id);

        if ($this->checkEditable($finalized, $usr_id, $examiner_id)) {
            $target = $this->ctrl->getLinkTargetByClass(ilIndividualAssessmentMemberGUI::class, 'edit');
            $items[] = $ui_factory->button()->shy($this->txt('iass_usr_edit'), $target);
        }

        if ($this->checkUserRemoveable($finalized)) {
            $this->ctrl->setParameterByClass('ilIndividualAssessmentMembersGUI', 'usr_id', $usr_id);
            $target = $this->ctrl->getLinkTargetByClass('ilIndividualAssessmentMembersGUI', 'removeUserConfirmation');
            $items[] = $ui_factory->button()->shy($this->txt('iass_usr_remove'), $target);
            $this->ctrl->setParameterByClass('ilIndividualAssessmentMembersGUI', 'usr_id', null);
        }

        if ($this->checkAmendable($finalized)) {
            $target = $this->ctrl->getLinkTargetByClass('ilIndividualAssessmentMemberGUI', 'amend');
            $items[] = $ui_factory->button()->shy($this->txt('iass_usr_amend'), $target);
        }

        if ($this->checkDownloadFile($usr_id, $file_name)) {
            $target = $this->ctrl->getLinkTargetByClass('ilIndividualAssessmentMemberGUI', 'downloadFile');
            $items[] = $ui_factory->button()->shy($this->txt('iass_usr_download_attachment'), $target);
        }
        $this->ctrl->setParameterByClass('ilIndividualAssessmentMemberGUI', 'usr_id', null);

        return $ui_factory->dropdown()->standard($items)->withLabel($this->txt("actions"));
    }

    protected function getStatus(bool $finalized, int $status, ?int $examiner_id = null): string
    {
        if ($status == 0) {
            $status = ilIndividualAssessmentMembers::LP_IN_PROGRESS;
        }

        if (!$finalized && !is_null($examiner_id)) {
            return $this->txt('iass_assessment_not_completed');
        }

        return $this->getEntryForStatus($status);
    }

    protected function getGradedInformation(?DateTimeImmutable $event_time): array
    {
        if (is_null($event_time)) {
            return [];
        }
        $event_time_str = $this->date_formatter->format($this->current_user, $event_time, true);
        return [$this->txt("iass_event_time") => $event_time_str];
    }

    protected function getFullNameFor(?int $user_id = null): string
    {
        if (is_null($user_id)) {
            return "";
        }

        $name_fields = ilObjUser::_lookupName($user_id);
        return $name_fields["lastname"] . ", " . $name_fields["firstname"] . " [" . $name_fields["login"] . "]";
    }

    protected function getProfileLink(string $full_name, int $user_id): string
    {
        $back_url = $this->ctrl->getLinkTarget($this->parent, "view");
        $this->ctrl->setParameterByClass('ilpublicuserprofilegui', 'user_id', $user_id);
        $this->ctrl->setParameterByClass('ilpublicuserprofilegui', "back_url", rawurlencode($back_url));
        $link = $this->ctrl->getLinkTargetByClass('ilpublicuserprofilegui', 'getHTML');
        $link = $this->factory->link()->standard($full_name, $link);

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

    protected function hasPublicProfile(int $examiner_id): bool
    {
        $user = ilObjectFactory::getInstanceByObjId($examiner_id);
        return (
            ($user->getPref('public_profile') == 'y') ||
            $user->getPref('public_profile') == 'g'
        );
    }

    protected function getLocationInfos(
        bool $finalized,
        int $usr_id,
        ?string $location = null,
        ?int $examiner_id = null
    ): array {
        if (!$this->mayViewLocation($finalized, $usr_id, $examiner_id)) {
            return [];
        }

        if ($location === "" || is_null($location)) {
            return [];
        }

        return [$this->txt("iass_location") . ": " => $location];
    }

    protected function getRecordNote(string $record_note): array
    {
        if (is_null($record_note)) {
            return [];
        }

        return [$this->txt("iass_record") => $record_note];
    }

    protected function getInternalRecordNote(?string $internal_note = null): array
    {
        if (is_null($internal_note)) {
            return [];
        }

        return [$this->txt("iass_internal_note") => $internal_note];
    }

    protected function getFileDownloadLink(int $usr_id): array
    {
        $this->ctrl->setParameterByClass('ilIndividualAssessmentMemberGUI', 'usr_id', $usr_id);
        $target = $this->ctrl->getLinkTargetByClass(
            'ilIndividualAssessmentMemberGUI',
            ilIndividualAssessmentMemberGUI::CMD_DOWNLOAD_FILE
        );
        $this->ctrl->setParameterByClass('ilIndividualAssessmentMemberGUI', 'usr_id', null);
        $link = $this->factory->link()->standard($this->txt("iass_download"), $target);

        return array(
            $this->txt("iass_file") => $this->renderer->render($link)
        );
    }

    protected function getEntryForStatus(int $a_status): string
    {
        switch ($a_status) {
            case ilIndividualAssessmentMembers::LP_IN_PROGRESS:
                return $this->txt('iass_status_pending');
            case ilIndividualAssessmentMembers::LP_COMPLETED:
                return $this->txt('iass_status_completed');
            case ilIndividualAssessmentMembers::LP_FAILED:
                return $this->txt('iass_status_failed');
            default:
                throw new ilIndividualAssessmentException("Invalid status: " . $a_status);
        }
    }

    protected function mayViewLocation(bool $finalized, int $usr_id, ?int $examiner_id = null): bool
    {
        return
            $this->checkEditable($finalized, $usr_id, $examiner_id) ||
            $this->checkAmendable($finalized) ||
            $this->iass_access->mayViewUser($usr_id)
        ;
    }

    protected function checkEditable(bool $finalized, int $usr_id, ?int $examiner_id = null): bool
    {
        if ($finalized) {
            return false;
        }

        return
            (
                $this->iass_access->mayGradeUser($usr_id)
                &&
                $this->wasEditedByViewer($examiner_id)
            );
    }

    protected function checkAmendable(bool $finalized): bool
    {
        if (
            ($this->iass_access->isSystemAdmin() && $finalized) ||
            ($finalized && $this->iass_access->mayAmendAllUsers())
        ) {
            return true;
        }

        return false;
    }

    protected function checkUserRemoveable(bool $finalized): bool
    {
        if (($this->iass_access->isSystemAdmin() && !$finalized) || (!$finalized && $this->iass_access->mayEditMembers())) {
            return true;
        }

        return false;
    }

    protected function checkDownloadFile(int $usr_id, ?string $file_name = null): bool
    {
        if ((!is_null($file_name) && $file_name !== '')
            && ($this->iass_access->isSystemAdmin() || $this->userMayDownloadAttachment($usr_id))
        ) {
            return true;
        }

        return false;
    }

    protected function userMayDownloadAttachment(int $usr_id): bool
    {
        return $this->iass_access->mayViewUser($usr_id) || $this->iass_access->mayGradeUser($usr_id);
    }

    protected function wasEditedByViewer(?int $examiner_id = null): bool
    {
        return $examiner_id === $this->current_user_id || null === $examiner_id;
    }

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