RemedialCoursePlugin::getRemedialCourseList()

Complexity

Conditions	25
Paths	291

Size

Total Lines	131
Code Lines	74

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

<?php
    public function getRemedialCourseList(
        Exercise $objExercise,
        int $userId = 0,
        int $sessionId = 0,
        bool $review = false
    ): ?string {
        if ('true' !== $this->get(self::SETTING_ENABLED)) {
            return null;
        }

        $field = new ExtraField('exercise');
        $remedialField = $field->get_handler_field_info_by_field_variable(self::EXTRAFIELD_REMEDIAL_VARIABLE);

        if (empty($remedialField)) {
            return null;
        }

        $extraFieldValue = new ExtraFieldValue('exercise');
        $remedialExcerciseField = $extraFieldValue->get_values_by_handler_and_field_variable(
            $objExercise->iId,
            self::EXTRAFIELD_REMEDIAL_VARIABLE
        );
        $remedialCourseIds = explode(';', $remedialExcerciseField['value']);

        if (empty($remedialExcerciseField['value']) || count($remedialCourseIds) == 0) {
            return null;
        }

        $questionExcluded = [
            FREE_ANSWER,
            ORAL_EXPRESSION,
            ANNOTATION,
        ];

        $userId = empty($userId) ? api_get_user_id() : $userId;

        $exerciseStatInfo = Event::getExerciseResultsByUser(
            $userId,
            $objExercise->iId,
            $objExercise->course_id,
            $sessionId
        );
        $bestAttempt = Event::get_best_attempt_exercise_results_per_user(
            $userId,
            $objExercise->iId,
            $objExercise->course_id,
            $sessionId
        );

        foreach ($exerciseStatInfo as $attempt) {
            if (!isset($bestAttempt['exe_result']) || $attempt['exe_result'] >= $bestAttempt['exe_result']) {
                $bestAttempt = $attempt;
            }

            if (!isset($attempt['question_list'])) {
                continue;
            }

            foreach ($attempt['question_list'] as $questionId => $answer) {
                $question = Question::read($questionId, api_get_course_info_by_id($attempt['c_id']));
                $questionOpen = in_array($question->type, $questionExcluded) && !$review;

                if (!$questionOpen) {
                    continue;
                }

                $score = $attempt['exe_result'];
                $comments = Event::get_comments($objExercise->iId, $questionId);

                if (empty($comments) || $score == 0) {
                    return null;
                }
            }
        }

        if (empty($bestAttempt)) {
            return null;
        }

        $bestAttempt['exe_result'] = (int) $bestAttempt['exe_result'];

        $isPassedPercentage = ExerciseLib::isPassPercentageAttemptPassed(
            $objExercise,
            $bestAttempt['exe_result'],
            $bestAttempt['exe_weighting']
        );

        if ($isPassedPercentage) {
            return null;
        }

        $hasAttempts = count($exerciseStatInfo) < $objExercise->selectAttempts();

        $doSubscriptionToRemedial = !$hasAttempts || $objExercise->isBlockedByPercentage($bestAttempt);

        if (!$doSubscriptionToRemedial) {
            return null;
        }

        $courses = [];
        $isInASession = !empty($sessionId);

        foreach ($remedialCourseIds as $courseId) {
            $courseData = api_get_course_info_by_id($courseId);

            if (empty($courseData)) {
                continue;
            }

            if ($isInASession) {
                $courseExistsInSession = SessionManager::sessionHasCourse($sessionId, $courseData['code']);

                if ($courseExistsInSession) {
                    SessionManager::subscribe_users_to_session_course([$userId], $sessionId, $courseData['code']);
                    $courses[] = $courseData['title'];
                }
            } else {
                $isSubscribed = CourseManager::is_user_subscribed_in_course($userId, $courseData['code']);

                if (!$isSubscribed) {
                    CourseManager::subscribeUser($userId, $courseData['code']);
                    $courses[] = $courseData['title'];
                }
            }
        }

        if (empty($courses)) {
            return null;
        }

        return sprintf($this->get_lang('SubscriptionToXRemedialCourses'), implode(' - ', $courses));
    }