class.ilStudyProgrammeEvents.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilStudyProgrammeEvents implements StudyProgrammeEvents
{
    public const PUBLIC_EVENTS = [
        self::EVENT_USER_ASSIGNED,
        self::EVENT_USER_DEASSIGNED,
        self::EVENT_USER_REASSIGNED,
    ];
    /*
        self::EVENT_USER_SUCCESSFUL,
        self::EVENT_USER_NOT_SUCCESSFUL,
        self::EVENT_VALIDITY_CHANGE,
        self::EVENT_SCORE_CHANGE

        will all trigger self::EVENT_USER_SUCCESSFUL on ilAppEventHandler,
        but only once! and for root-prg only.
        This prevents e.g. certificate to rebuild on every (sucessive) change
    */

    public function __construct(
        protected ilLogger $logger,
        protected ilAppEventHandler $app_event_handler,
        protected PRGEventHandler $prg_event_handler
    ) {
    }

    public function raise(string $event, array $parameter): void
    {
        $parameter_formatter = static function ($value) use (&$parameter_formatter) {
            if (is_object($value)) {
                return get_class($value);
            }

            if (is_array($value)) {
                return array_map(
                    $parameter_formatter,
                    $value
                );
            }

            return $value;
        };

        $this->logger->debug("PRG raised: " . $event . ' (' . var_export(array_map(
            $parameter_formatter,
            $parameter
        ), true) . ')');

        if (in_array($event, [
            self::EVENT_USER_ASSIGNED,
            self::EVENT_USER_DEASSIGNED,
            self::EVENT_USER_SUCCESSFUL,
            self::EVENT_USER_NOT_SUCCESSFUL,
            self::EVENT_VALIDITY_CHANGE
        ])) {
            $this->prg_event_handler->updateLPStatus($parameter['prg_id'], $parameter['usr_id']);
        }

        if (in_array($event, [
                self::EVENT_USER_SUCCESSFUL,
                self::EVENT_USER_NOT_SUCCESSFUL,
                self::EVENT_VALIDITY_CHANGE,
                self::EVENT_SCORE_CHANGE
            ])
            && $parameter["root_prg_id"] === $parameter["prg_id"]
        ) {
            $cert = fn() => $this->app_event_handler->raise(self::COMPONENT, self::EVENT_USER_SUCCESSFUL, $parameter);
            $this->prg_event_handler->triggerCertificateOnce($cert, $parameter["root_prg_id"], $parameter["usr_id"]);
        }

        if ($event === self::EVENT_USER_ABOUT_TO_FAIL) {
            $this->prg_event_handler->sendRiskyToFailMail($parameter['ass_id'], $parameter['root_prg_id']);
        }
        if ($event === self::EVENT_USER_TO_RESTART) {
            $this->prg_event_handler->sendInformToReAssignMail($parameter['ass_id'], $parameter['root_prg_id']);
        }
        if ($event === self::EVENT_USER_REASSIGNED) {
            $this->prg_event_handler->sendReAssignedMail($parameter['ass_id'], $parameter['root_prg_id']);
        }
        if ($event === self::EVENT_VALIDITY_CHANGE) {
            $this->prg_event_handler->resetMailFlagValidity($parameter['ass_id'], $parameter['root_prg_id']);
        }
        if ($event === self::EVENT_DEADLINE_CHANGE) {
            $this->prg_event_handler->resetMailFlagDeadline($parameter['ass_id'], $parameter['root_prg_id']);
        }

        if (in_array($event, self::PUBLIC_EVENTS)) {
            $this->app_event_handler->raise(self::COMPONENT, $event, $parameter);
        }
    }

    public function userAssigned(ilPRGAssignment $assignment): void
    {
        $this->raise(
            self::EVENT_USER_ASSIGNED,
            [
                "root_prg_id" => $assignment->getRootId(),
                "prg_id" => $assignment->getRootId(),
                "usr_id" => $assignment->getUserId(),
                "ass_id" => $assignment->getId()
            ]
        );
    }

    public function userDeassigned(ilPRGAssignment $a_assignment): void
    {
        $this->raise(
            self::EVENT_USER_DEASSIGNED,
            [
                "root_prg_id" => $a_assignment->getRootId(),
                "prg_id" => $a_assignment->getRootId(),
                "usr_id" => $a_assignment->getUserId(),
                "ass_id" => $a_assignment->getId()
            ]
        );
    }

    public function userReAssigned(ilPRGAssignment $assignment): void
    {
        $this->raise(
            self::EVENT_USER_REASSIGNED,
            [
                "ass_id" => $assignment->getId(),
                "root_prg_id" => (int) $assignment->getRootId()
            ]
        );
    }

    public function userSuccessful(ilPRGAssignment $assignment, int $pgs_node_id): void
    {
        $this->raise(
            self::EVENT_USER_SUCCESSFUL,
            [
                "root_prg_id" => $assignment->getRootId(),
                "prg_id" => $pgs_node_id,
                "usr_id" => $assignment->getUserId(),
                "ass_id" => $assignment->getId()
            ]
        );
    }

    public function informUserByMailToRestart(ilPRGAssignment $assignment): void
    {
        $this->raise(
            self::EVENT_USER_TO_RESTART,
            [
                "ass_id" => (int) $assignment->getId(),
                "root_prg_id" => (int) $assignment->getRootId()
            ]
        );
    }

    public function userRiskyToFail(ilPRGAssignment $assignment): void
    {
        $this->raise(
            self::EVENT_USER_ABOUT_TO_FAIL,
            [
                "ass_id" => (int) $assignment->getId(),
                "root_prg_id" => (int) $assignment->getRootId()
            ]
        );
    }

    public function validityChange(ilPRGAssignment $assignment, int $pgs_node_id): void
    {
        $this->raise(self::EVENT_VALIDITY_CHANGE, [
            "ass_id" => $assignment->getId(),
            "root_prg_id" => $assignment->getRootId(),
            "prg_id" => $pgs_node_id,
            "usr_id" => $assignment->getUserId()
        ]);
    }

    public function deadlineChange(ilPRGAssignment $assignment, int $pgs_node_id): void
    {
        $this->raise(self::EVENT_DEADLINE_CHANGE, [
            "ass_id" => $assignment->getId(),
            "root_prg_id" => $assignment->getRootId(),
            "prg_id" => $pgs_node_id,
            "usr_id" => $assignment->getUserId()
        ]);
    }

    public function scoreChange(ilPRGAssignment $assignment, int $pgs_node_id): void
    {
        $this->raise(self::EVENT_SCORE_CHANGE, [
            "ass_id" => $assignment->getId(),
            "root_prg_id" => $assignment->getRootId(),
            "prg_id" => $pgs_node_id,
            "usr_id" => $assignment->getUserId()
        ]);
    }

    public function userRevertSuccessful(ilPRGAssignment $assignment, int $pgs_node_id): void
    {
        $this->raise(self::EVENT_USER_NOT_SUCCESSFUL, [
            "ass_id" => $assignment->getId(),
            "root_prg_id" => $assignment->getRootId(),
            "prg_id" => $pgs_node_id,
            "usr_id" => $assignment->getUserId()
        ]);
    }
}