RemedialCoursePlugin::create() - Code Metrics - Inspection of "Plugin: Remedial Course: Fix conditions to inscrip..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.11.x ( 659998...c58798 )

by Angel Fernando Quiroz

created 2021-04-29 19:22 UTC

RemedialCoursePlugin::create() A

↳ Parent: RemedialCoursePlugin

Complexity

Conditions	2
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
cc	2
eloc	2
c	3
b	1
f	0
nc	1
nop	0
dl	0
loc	5
rs	10

<?php

/* For licensing terms, see /license.txt */

/**
 * Class RemedialCoursePlugin.
 */
class RemedialCoursePlugin extends Plugin
{
    const SETTING_ENABLED = 'enabled';
    const EXTRAFIELD_REMEDIAL_VARIABLE = 'remedialcourselist';

    /**
     * RemedialCoursePlugin constructor.
     */
    protected function __construct()
    {
        $settings = [
            self::SETTING_ENABLED => 'boolean',
        ];
        parent::__construct(
            '1.0',
            'Carlos Alvarado',
            $settings
        );
    }

    /**
     * Create a new instance of RemedialCoursePlugin.
     */
    public static function create(): RemedialCoursePlugin
    {
        static $result = null;

        return $result ?: $result = new self();
    }

    /**
     * Perform the plugin installation.
     */
    public function install()
    {
        $this->saveRemedialField();
        $this->saveAdvanceRemedialField();
    }

    /**
     * Save the arrangement for remedialcourselist, it is adjusted internally so that the values
     * match the necessary ones.
     */
    public function saveRemedialField()
    {
        $extraField = new ExtraField('exercise');
        $remedialcourselist = $extraField->get_handler_field_info_by_field_variable(self::EXTRAFIELD_REMEDIAL_VARIABLE);
        if (false === $remedialcourselist) {
            $extraField->save([
                'field_type' => ExtraField::FIELD_TYPE_SELECT_MULTIPLE,
                'variable' => self::EXTRAFIELD_REMEDIAL_VARIABLE,
                'display_text' => 'remedialCourseList',
                'default_value' => 1,
                'field_order' => 0,
                'visible_to_self' => 1,
                'visible_to_others' => 0,
                'changeable' => 1,
                'filter' => 0,
            ]);
        }
    }

    /**
     * Save the arrangement for remedialadvancecourselist, it is adjusted internally so that the values
     * match the necessary ones.
     */
    public function saveAdvanceRemedialField()
    {
        $extraField = new ExtraField('exercise');
        $advancedcourselist = $extraField->get_handler_field_info_by_field_variable('advancedcourselist');
        if (false === $advancedcourselist) {
            $extraField->save([
                'field_type' => ExtraField::FIELD_TYPE_SELECT_MULTIPLE,
                'variable' => 'advancedcourselist',
                'display_text' => 'advancedCourseList',
                'default_value' => 1,
                'field_order' => 0,
                'visible_to_self' => 1,
                'visible_to_others' => 0,
                'changeable' => 1,
                'filter' => 0,
            ]);
        }
    }

    /**
     * Set default_value to 0.
     */
    public function uninstall()
    {
    }

    public function get_name(): string
    {
        return 'remedial_course';
    }

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


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			/**
6			* Class RemedialCoursePlugin.
7			*/
8			class RemedialCoursePlugin extends Plugin
9			{
10			const SETTING_ENABLED = 'enabled';
11			const EXTRAFIELD_REMEDIAL_VARIABLE = 'remedialcourselist';
12
13			/**
14			* RemedialCoursePlugin constructor.
15			*/
16			protected function __construct()
17			{
18			$settings = [
19			self::SETTING_ENABLED => 'boolean',
20			];
21			parent::__construct(
22			'1.0',
23			'Carlos Alvarado',
24			$settings
25			);
26			}
27
28			/**
29			* Create a new instance of RemedialCoursePlugin.
30			*/
31			public static function create(): RemedialCoursePlugin
32			{
33			static $result = null;
34
35			return $result ?: $result = new self();
36			}
37
38			/**
39			* Perform the plugin installation.
40			*/
41			public function install()
42			{
43			$this->saveRemedialField();
44			$this->saveAdvanceRemedialField();
45			}
46
47			/**
48			* Save the arrangement for remedialcourselist, it is adjusted internally so that the values
49			* match the necessary ones.
50			*/
51			public function saveRemedialField()
52			{
53			$extraField = new ExtraField('exercise');
54			$remedialcourselist = $extraField->get_handler_field_info_by_field_variable(self::EXTRAFIELD_REMEDIAL_VARIABLE);
55			if (false === $remedialcourselist) {
56			$extraField->save([
57			'field_type' => ExtraField::FIELD_TYPE_SELECT_MULTIPLE,
58			'variable' => self::EXTRAFIELD_REMEDIAL_VARIABLE,
59			'display_text' => 'remedialCourseList',
60			'default_value' => 1,
61			'field_order' => 0,
62			'visible_to_self' => 1,
63			'visible_to_others' => 0,
64			'changeable' => 1,
65			'filter' => 0,
66			]);
67			}
68			}
69
70			/**
71			* Save the arrangement for remedialadvancecourselist, it is adjusted internally so that the values
72			* match the necessary ones.
73			*/
74			public function saveAdvanceRemedialField()
75			{
76			$extraField = new ExtraField('exercise');
77			$advancedcourselist = $extraField->get_handler_field_info_by_field_variable('advancedcourselist');
78			if (false === $advancedcourselist) {
79			$extraField->save([
80			'field_type' => ExtraField::FIELD_TYPE_SELECT_MULTIPLE,
81			'variable' => 'advancedcourselist',
82			'display_text' => 'advancedCourseList',
83			'default_value' => 1,
84			'field_order' => 0,
85			'visible_to_self' => 1,
86			'visible_to_others' => 0,
87			'changeable' => 1,
88			'filter' => 0,
89			]);
90			}
91			}
92
93			/**
94			* Set default_value to 0.
95			*/
96			public function uninstall()
97			{
98			}
99
100			public function get_name(): string
101			{
102			return 'remedial_course';
103			}
104
105			public function getRemedialCourseList(
106			Exercise $objExercise,
107			int $userId = 0,
108			int $sessionId = 0,
109			bool $review = false
110			): ?string {
111			if ('true' !== $this->get(self::SETTING_ENABLED)) {
112			return null;
113			}
114
115			$field = new ExtraField('exercise');
116			$remedialField = $field->get_handler_field_info_by_field_variable(self::EXTRAFIELD_REMEDIAL_VARIABLE);
117
118			if (empty($remedialField)) {
119			return null;
120			}
121
122			$extraFieldValue = new ExtraFieldValue('exercise');
123			$remedialExcerciseField = $extraFieldValue->get_values_by_handler_and_field_variable(
124			$objExercise->iId,
125			self::EXTRAFIELD_REMEDIAL_VARIABLE
126			);
127			$remedialCourseIds = explode(';', $remedialExcerciseField['value']);
128
129			if (empty($remedialExcerciseField['value']) \|\| count($remedialCourseIds) == 0) {
130			return null;
131			}
132
133			$questionExcluded = [
134			FREE_ANSWER,
135			ORAL_EXPRESSION,
136			ANNOTATION,
137			];
138
139			$userId = empty($userId) ? api_get_user_id() : $userId;
140
141			$exerciseStatInfo = Event::getExerciseResultsByUser(
142			$userId,
143			$objExercise->iId,
144			$objExercise->course_id,
145			$sessionId
146			);
147			$bestAttempt = Event::get_best_attempt_exercise_results_per_user(
148			$userId,
149			$objExercise->iId,
150			$objExercise->course_id,
151			$sessionId
152			);
153
154			foreach ($exerciseStatInfo as $attempt) {
155			if (!isset($bestAttempt['exe_result']) \|\| $attempt['exe_result'] >= $bestAttempt['exe_result']) {
156			$bestAttempt = $attempt;
157			}
158
159			if (!isset($attempt['question_list'])) {
160			continue;
161			}
162
163			foreach ($attempt['question_list'] as $questionId => $answer) {
164			$question = Question::read($questionId, api_get_course_info_by_id($attempt['c_id']));
165			$questionOpen = in_array($question->type, $questionExcluded) && !$review;
166
167			if (!$questionOpen) {
168			continue;
169			}
170
171			$score = $attempt['exe_result'];
172			$comments = Event::get_comments($objExercise->iId, $questionId);
173
174			if (empty($comments) \|\| $score == 0) {
175			return null;
176			}
177			}
178			}
179
180			if (empty($bestAttempt)) {
181			return null;
182			}
183
184			$bestAttempt['exe_result'] = (int) $bestAttempt['exe_result'];
185
186			$isPassedPercentage = ExerciseLib::isPassPercentageAttemptPassed(
187			$objExercise,
188			$bestAttempt['exe_result'],
189			$bestAttempt['exe_weighting']
190			);
191
192			if ($isPassedPercentage) {
193			return null;
194			}
195
196			$hasAttempts = count($exerciseStatInfo) < $objExercise->selectAttempts();
197
198			$doSubscriptionToRemedial = !$hasAttempts \|\| $objExercise->isBlockedByPercentage($bestAttempt);
199
200			if (!$doSubscriptionToRemedial) {
201			return null;
202			}
203
204			$courses = [];
205			$isInASession = !empty($sessionId);
206
207			foreach ($remedialCourseIds as $courseId) {
208			$courseData = api_get_course_info_by_id($courseId);
209
210			if (empty($courseData)) {
211			continue;
212			}
213
214			if ($isInASession) {
215			$courseExistsInSession = SessionManager::sessionHasCourse($sessionId, $courseData['code']);
216
217			if ($courseExistsInSession) {
218			SessionManager::subscribe_users_to_session_course([$userId], $sessionId, $courseData['code']);
219			$courses[] = $courseData['title'];
220			}
221			} else {
222			$isSubscribed = CourseManager::is_user_subscribed_in_course($userId, $courseData['code']);
223
224			if (!$isSubscribed) {
225			CourseManager::subscribeUser($userId, $courseData['code']);
226			$courses[] = $courseData['title'];
227			}
228			}
229			}
230
231			if (empty($courses)) {
232			return null;
233			}
234
235			return sprintf($this->get_lang('SubscriptionToXRemedialCourses'), implode(' - ', $courses));
236			}
237			}
238

chamilo / chamilo-lms

Push — 1.11.x ( 659998...c58798 )

RemedialCoursePlugin::create() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like