findResults() - Code Metrics - Inspection of "Plugin: Exercise monitoring and focused - refs BT#..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 1.11.x (#4900)

by Angel Fernando Quiroz

created 2023-11-27 17:18 UTC

findResults() C

↳ Parent: Project

Complexity

Conditions	10
Paths	192

Size

Total Lines	75
Code Lines	41

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	41
dl	0
loc	75
rs	6.9
c	1
b	0
f	0
cc	10
nc	192
nop	3

How to fix Long Method Complexity

<?php

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

use Chamilo\CoreBundle\Entity\TrackEAttempt;
use Chamilo\CoreBundle\Entity\TrackEExercises;
use Chamilo\CourseBundle\Entity\CQuiz;
use Chamilo\PluginBundle\ExerciseFocused\Entity\Log as FocusedLog;
use Chamilo\PluginBundle\ExerciseMonitoring\Entity\Log as MonitoringLog;
use Chamilo\UserBundle\Entity\User;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Query\Expr\Join;
use Symfony\Component\HttpFoundation\Request as HttpRequest;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

require_once __DIR__.'/../../../main/inc/global.inc.php';

api_protect_course_script(true);

if (!api_is_allowed_to_edit()) {
    api_not_allowed(true);
}

$plugin = ExerciseFocusedPlugin::create();
$monitoringPlugin = ExerciseMonitoringPlugin::create();
$monitoringPluginIsEnabled = $monitoringPlugin->isEnabled(true);
$request = HttpRequest::createFromGlobals();
$em = Database::getManager();
$focusedLogRepository = $em->getRepository(FocusedLog::class);
$attempsRepository = $em->getRepository(TrackEAttempt::class);

if (!$plugin->isEnabled(true)) {
    api_not_allowed(true);
}

$params = $request->query->all();

$results = findResults($params, $em, $plugin);

$data = [];

/** @var array<string, mixed> $result */
foreach ($results as $result) {
    /** @var TrackEExercises $trackExe */
    $trackExe = $result['exe'];
    $user = api_get_user_entity($trackExe->getExeUserId());

    $outfocusedLimitCount = $focusedLogRepository->countByActionInExe($trackExe, FocusedLog::TYPE_OUTFOCUSED_LIMIT);
    $timeLimitCount = $focusedLogRepository->countByActionInExe($trackExe, FocusedLog::TYPE_TIME_LIMIT);

    $exercise = new Exercise($trackExe->getCId());
    $exercise->read($trackExe->getExeExoId());

    $quizType = (int) $exercise->selectType();

    $data[] = [
        get_lang('LoginName'),
        $user->getUsername(),
    ];
    $data[] = [
        get_lang('Student'),
        $user->getFirstname(),
        $user->getLastname(),
    ];

    if ($monitoringPluginIsEnabled
        && 'true' === $monitoringPlugin->get(ExerciseMonitoringPlugin::SETTING_INSTRUCTION_AGE_DISTINCTION_ENABLE)
    ) {
        $fieldVariable = $monitoringPlugin->get(ExerciseMonitoringPlugin::SETTING_EXTRAFIELD_BIRTHDATE);
        $birthdateValue = UserManager::get_extra_user_data_by_field($user->getId(), $fieldVariable);

        $data[] = [
            $monitoringPlugin->get_lang('Birthdate'),
            $birthdateValue ? $birthdateValue[$fieldVariable] : '----',
            $monitoringPlugin->isAdult($user->getId())
                ? $monitoringPlugin->get_lang('AdultStudent')
                : $monitoringPlugin->get_lang('MinorStudent'),
        ];
    }

    if ($trackExe->getSessionId()) {
        $data[] = [
            get_lang('SessionName'),
            api_get_session_entity($trackExe->getSessionId())->getName(),
        ];
    }

    $data[] = [
        get_lang('CourseTitle'),
        api_get_course_entity($trackExe->getCId())->getTitle(),
    ];
    $data[] = [
        get_lang('ExerciseName'),
        $exercise->getUnformattedTitle(),
    ];
    $data[] = [
        $plugin->get_lang('ExerciseStartDateAndTime'),
        api_get_local_time($result['exe']->getStartDate(), null, null, true, true, true),
    ];
    $data[] = [
        $plugin->get_lang('ExerciseEndDateAndTime'),
        api_get_local_time($result['exe']->getExeDate(), null, null, true, true, true),
    ];
    $data[] = [
        get_lang('IP'),
        $result['exe']->getUserIp(),
    ];
    $data[] = [
        $plugin->get_lang('Motive'),
        $plugin->calculateMotive($outfocusedLimitCount, $timeLimitCount),
    ];
    $data[] = [];

    $data[] = [
        $plugin->get_lang('LevelReached'),
        get_lang('DateExo'),
        get_lang('Score'),
        $plugin->get_lang('Outfocused'),
        $plugin->get_lang('Returns'),
        $monitoringPluginIsEnabled ? $monitoringPlugin->get_lang('Snapshots') : '',
    ];

    if (ONE_PER_PAGE === $quizType) {
        $questionList = explode(',', $trackExe->getDataTracking());

        foreach ($questionList as $idx => $questionId) {
            $attempt = $attempsRepository->findOneBy(
                ['exeId' => $trackExe->getExeId(), 'questionId' => $questionId],
                ['tms' => 'DESC']
            );

            if (!$attempt) {
                continue;
            }

            $result = $exercise->manage_answer(
                $trackExe->getExeId(),
                $questionId,
                null,
                'exercise_result',
                false,
                false,
                true,
                false,
                $exercise->selectPropagateNeg()
            );

            $row = [
                get_lang('QuestionNumber').' '.($idx + 1),
                api_get_local_time($attempt->getTms()),
                $result['score'].' / '.$result['weight'],
                $focusedLogRepository->countByActionAndLevel($trackExe, FocusedLog::TYPE_OUTFOCUSED, $questionId),
                $focusedLogRepository->countByActionAndLevel($trackExe, FocusedLog::TYPE_RETURN, $questionId),
                getSnapshotListForLevel($questionId, $trackExe),
            ];

            $data[] = $row;
        }
    } elseif (ALL_ON_ONE_PAGE === $quizType) {
    }

    $data[] = [];
    $data[] = [];
    $data[] = [];
}

Export::arrayToXls($data);

function getSessionIdFromFormValues(array $formValues, array $fieldVariableList): array
{
    $fieldItemIdList = [];
    $objFieldValue = new ExtraFieldValue('session');

    foreach ($fieldVariableList as $fieldVariable) {
        if (!isset($formValues["extra_$fieldVariable"])) {
            continue;
        }

        $itemValue = $objFieldValue->get_item_id_from_field_variable_and_field_value(
            $fieldVariable,
            $formValues["extra_$fieldVariable"]
        );

        if ($itemValue) {
            $fieldItemIdList[] = (int) $itemValue['item_id'];
        }
    }

    return array_unique($fieldItemIdList);
}

function findResults(array $formValues, EntityManagerInterface $em, ExerciseFocusedPlugin $plugin)
{
    $cId = api_get_course_int_id();

    $qb = $em->createQueryBuilder();
    $qb
        ->select('te AS exe, q.title, te.startDate , u.firstname, u.lastname, u.username')
        ->from(TrackEExercises::class, 'te')
        ->innerJoin(CQuiz::class, 'q', Join::WITH, 'te.exeExoId = q.iid')
        ->innerJoin(User::class, 'u', Join::WITH, 'te.exeUserId = u.id');

    $params = [];

    if ($cId) {
        $qb->andWhere($qb->expr()->eq('te.cId', ':cId'));

        $params['cId'] = $cId;
    }

    $sessionItemIdList = getSessionIdFromFormValues(
        $formValues,
        $plugin->getSessionFieldList()
    );

    if ($sessionItemIdList) {

        $qb->andWhere($qb->expr()->in('te.sessionId', ':sessionItemIdList'));

        $params['sessionItemIdList'] = $sessionItemIdList;
    }

    if (!empty($formValues['username'])) {
        $qb->andWhere($qb->expr()->eq('u.username', ':username'));

        $params['username'] = $formValues['username'];
    }

    if (!empty($formValues['firstname'])) {
        $qb->andWhere($qb->expr()->eq('u.firstname', ':firstname'));

        $params['firstname'] = $formValues['firstname'];
    }

    if (!empty($formValues['lastname'])) {
        $qb->andWhere($qb->expr()->eq('u.lastname', ':lastname'));

        $params['lastname'] = $formValues['lastname'];
    }

    if (!empty($formValues['start_date'])) {
        $qb->andWhere(
            $qb->expr()->andX(
                $qb->expr()->gte('te.startDate', ':start_date'),
                $qb->expr()->lte('te.exeDate', ':end_date')
            )
        );

        $params['start_date'] = api_get_utc_datetime($formValues['start_date'].' 00:00:00', false, true);
        $params['end_date'] = api_get_utc_datetime($formValues['start_date'].' 23:59:59', false, true);
    }

    if (empty($params)) {
        return [];
    }

    if ($cId && !empty($formValues['id'])) {
        $qb->andWhere($qb->expr()->eq('q.iid', ':q_id'));

        $params['q_id'] = $formValues['id'];
    }

    $qb->setParameters($params);

    $query = $qb->getQuery();

    return $query->getResult();
}

function getSnapshotListForLevel(int $level, TrackEExercises $trackExe): string
{
    $monitoringPluginIsEnabled = ExerciseMonitoringPlugin::create()->isEnabled(true);

    if (!$monitoringPluginIsEnabled) {
        return '';
    }

    $user = api_get_user_entity($trackExe->getExeUserId());
    $monitoringLogRepository = Database::getManager()->getRepository(MonitoringLog::class);

    $monitoringLogsByQuestion = $monitoringLogRepository->findByLevelAndExe($level, $trackExe);
    $snapshotList = [];

    /** @var MonitoringLog $logByQuestion */
    foreach ($monitoringLogsByQuestion as $logByQuestion) {
        $snapshotUrl = ExerciseMonitoringPlugin::generateSnapshotUrl(
            $user->getId(),
            $logByQuestion->getImageFilename()
        );
        $snapshotList[] = api_get_local_time($logByQuestion->getCreatedAt()).' '.$snapshotUrl;
    }

    return implode(PHP_EOL, $snapshotList);
}


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			use Chamilo\CoreBundle\Entity\TrackEAttempt;
6			use Chamilo\CoreBundle\Entity\TrackEExercises;
7			use Chamilo\CourseBundle\Entity\CQuiz;
8			use Chamilo\PluginBundle\ExerciseFocused\Entity\Log as FocusedLog;
9			use Chamilo\PluginBundle\ExerciseMonitoring\Entity\Log as MonitoringLog;
10			use Chamilo\UserBundle\Entity\User;
11			use Doctrine\ORM\EntityManagerInterface;
12			use Doctrine\ORM\Query\Expr\Join;
13			use Symfony\Component\HttpFoundation\Request as HttpRequest;
			0 ignored issues – show Bug introduced 2023-10-06 16:55 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `HttpRequest`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
14
15			require_once __DIR__.'/../../../main/inc/global.inc.php';
16
17			api_protect_course_script(true);
18
19			if (!api_is_allowed_to_edit()) {
20			api_not_allowed(true);
21			}
22
23			$plugin = ExerciseFocusedPlugin::create();
24			$monitoringPlugin = ExerciseMonitoringPlugin::create();
25			$monitoringPluginIsEnabled = $monitoringPlugin->isEnabled(true);
26			$request = HttpRequest::createFromGlobals();
27			$em = Database::getManager();
28			$focusedLogRepository = $em->getRepository(FocusedLog::class);
29			$attempsRepository = $em->getRepository(TrackEAttempt::class);
30
31			if (!$plugin->isEnabled(true)) {
32			api_not_allowed(true);
33			}
34
35			$params = $request->query->all();
36
37			$results = findResults($params, $em, $plugin);
38
39			$data = [];
40
41			/** @var array<string, mixed> $result */
42			foreach ($results as $result) {
43			/** @var TrackEExercises $trackExe */
44			$trackExe = $result['exe'];
45			$user = api_get_user_entity($trackExe->getExeUserId());
46
47			$outfocusedLimitCount = $focusedLogRepository->countByActionInExe($trackExe, FocusedLog::TYPE_OUTFOCUSED_LIMIT);
48			$timeLimitCount = $focusedLogRepository->countByActionInExe($trackExe, FocusedLog::TYPE_TIME_LIMIT);
49
50			$exercise = new Exercise($trackExe->getCId());
51			$exercise->read($trackExe->getExeExoId());
52
53			$quizType = (int) $exercise->selectType();
54
55			$data[] = [
56			get_lang('LoginName'),
57			$user->getUsername(),
58			];
59			$data[] = [
60			get_lang('Student'),
61			$user->getFirstname(),
62			$user->getLastname(),
63			];
64
65			if ($monitoringPluginIsEnabled
66			&& 'true' === $monitoringPlugin->get(ExerciseMonitoringPlugin::SETTING_INSTRUCTION_AGE_DISTINCTION_ENABLE)
67			) {
68			$fieldVariable = $monitoringPlugin->get(ExerciseMonitoringPlugin::SETTING_EXTRAFIELD_BIRTHDATE);
69			$birthdateValue = UserManager::get_extra_user_data_by_field($user->getId(), $fieldVariable);
70
71			$data[] = [
72			$monitoringPlugin->get_lang('Birthdate'),
73			$birthdateValue ? $birthdateValue[$fieldVariable] : '----',
74			$monitoringPlugin->isAdult($user->getId())
75			? $monitoringPlugin->get_lang('AdultStudent')
76			: $monitoringPlugin->get_lang('MinorStudent'),
77			];
78			}
79
80			if ($trackExe->getSessionId()) {
81			$data[] = [
82			get_lang('SessionName'),
83			api_get_session_entity($trackExe->getSessionId())->getName(),
84			];
85			}
86
87			$data[] = [
88			get_lang('CourseTitle'),
89			api_get_course_entity($trackExe->getCId())->getTitle(),
90			];
91			$data[] = [
92			get_lang('ExerciseName'),
93			$exercise->getUnformattedTitle(),
94			];
95			$data[] = [
96			$plugin->get_lang('ExerciseStartDateAndTime'),
97			api_get_local_time($result['exe']->getStartDate(), null, null, true, true, true),
98			];
99			$data[] = [
100			$plugin->get_lang('ExerciseEndDateAndTime'),
101			api_get_local_time($result['exe']->getExeDate(), null, null, true, true, true),
102			];
103			$data[] = [
104			get_lang('IP'),
105			$result['exe']->getUserIp(),
106			];
107			$data[] = [
108			$plugin->get_lang('Motive'),
109			$plugin->calculateMotive($outfocusedLimitCount, $timeLimitCount),
110			];
111			$data[] = [];
112
113			$data[] = [
114			$plugin->get_lang('LevelReached'),
115			get_lang('DateExo'),
116			get_lang('Score'),
117			$plugin->get_lang('Outfocused'),
118			$plugin->get_lang('Returns'),
119			$monitoringPluginIsEnabled ? $monitoringPlugin->get_lang('Snapshots') : '',
120			];
121
122			if (ONE_PER_PAGE === $quizType) {
123			$questionList = explode(',', $trackExe->getDataTracking());
124
125			foreach ($questionList as $idx => $questionId) {
126			$attempt = $attempsRepository->findOneBy(
127			['exeId' => $trackExe->getExeId(), 'questionId' => $questionId],
128			['tms' => 'DESC']
129			);
130
131			if (!$attempt) {
132			continue;
133			}
134
135			$result = $exercise->manage_answer(
136			$trackExe->getExeId(),
137			$questionId,
138			null,
139			'exercise_result',
140			false,
141			false,
142			true,
143			false,
144			$exercise->selectPropagateNeg()
145			);
146
147			$row = [
148			get_lang('QuestionNumber').' '.($idx + 1),
149			api_get_local_time($attempt->getTms()),
150			$result['score'].' / '.$result['weight'],
151			$focusedLogRepository->countByActionAndLevel($trackExe, FocusedLog::TYPE_OUTFOCUSED, $questionId),
152			$focusedLogRepository->countByActionAndLevel($trackExe, FocusedLog::TYPE_RETURN, $questionId),
153			getSnapshotListForLevel($questionId, $trackExe),
154			];
155
156			$data[] = $row;
157			}
158			} elseif (ALL_ON_ONE_PAGE === $quizType) {
159			}
160
161			$data[] = [];
162			$data[] = [];
163			$data[] = [];
164			}
165
166			Export::arrayToXls($data);
167
168			function getSessionIdFromFormValues(array $formValues, array $fieldVariableList): array
169			{
170			$fieldItemIdList = [];
171			$objFieldValue = new ExtraFieldValue('session');
172
173			foreach ($fieldVariableList as $fieldVariable) {
174			if (!isset($formValues["extra_$fieldVariable"])) {
175			continue;
176			}
177
178			$itemValue = $objFieldValue->get_item_id_from_field_variable_and_field_value(
179			$fieldVariable,
180			$formValues["extra_$fieldVariable"]
181			);
182
183			if ($itemValue) {
184			$fieldItemIdList[] = (int) $itemValue['item_id'];
185			}
186			}
187
188			return array_unique($fieldItemIdList);
189			}
190
191			function findResults(array $formValues, EntityManagerInterface $em, ExerciseFocusedPlugin $plugin)
192			{
193			$cId = api_get_course_int_id();
194
195			$qb = $em->createQueryBuilder();
196			$qb
197			->select('te AS exe, q.title, te.startDate , u.firstname, u.lastname, u.username')
198			->from(TrackEExercises::class, 'te')
199			->innerJoin(CQuiz::class, 'q', Join::WITH, 'te.exeExoId = q.iid')
200			->innerJoin(User::class, 'u', Join::WITH, 'te.exeUserId = u.id');
201
202			$params = [];
203
204			if ($cId) {
205			$qb->andWhere($qb->expr()->eq('te.cId', ':cId'));
206
207			$params['cId'] = $cId;
208			}
209
210			$sessionItemIdList = getSessionIdFromFormValues(
211			$formValues,
212			$plugin->getSessionFieldList()
213			);
214
215			if ($sessionItemIdList) {
			0 ignored issues – show Bug Best Practice introduced 2023-10-18 16:23 UTC by Report Bug Copy Issue Report The expression `$sessionItemIdList` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
216			$qb->andWhere($qb->expr()->in('te.sessionId', ':sessionItemIdList'));
217
218			$params['sessionItemIdList'] = $sessionItemIdList;
219			}
220
221			if (!empty($formValues['username'])) {
222			$qb->andWhere($qb->expr()->eq('u.username', ':username'));
223
224			$params['username'] = $formValues['username'];
225			}
226
227			if (!empty($formValues['firstname'])) {
228			$qb->andWhere($qb->expr()->eq('u.firstname', ':firstname'));
229
230			$params['firstname'] = $formValues['firstname'];
231			}
232
233			if (!empty($formValues['lastname'])) {
234			$qb->andWhere($qb->expr()->eq('u.lastname', ':lastname'));
235
236			$params['lastname'] = $formValues['lastname'];
237			}
238
239			if (!empty($formValues['start_date'])) {
240			$qb->andWhere(
241			$qb->expr()->andX(
242			$qb->expr()->gte('te.startDate', ':start_date'),
243			$qb->expr()->lte('te.exeDate', ':end_date')
244			)
245			);
246
247			$params['start_date'] = api_get_utc_datetime($formValues['start_date'].' 00:00:00', false, true);
248			$params['end_date'] = api_get_utc_datetime($formValues['start_date'].' 23:59:59', false, true);
249			}
250
251			if (empty($params)) {
252			return [];
253			}
254
255			if ($cId && !empty($formValues['id'])) {
256			$qb->andWhere($qb->expr()->eq('q.iid', ':q_id'));
257
258			$params['q_id'] = $formValues['id'];
259			}
260
261			$qb->setParameters($params);
262
263			$query = $qb->getQuery();
264
265			return $query->getResult();
266			}
267
268			function getSnapshotListForLevel(int $level, TrackEExercises $trackExe): string
269			{
270			$monitoringPluginIsEnabled = ExerciseMonitoringPlugin::create()->isEnabled(true);
271
272			if (!$monitoringPluginIsEnabled) {
273			return '';
274			}
275
276			$user = api_get_user_entity($trackExe->getExeUserId());
277			$monitoringLogRepository = Database::getManager()->getRepository(MonitoringLog::class);
278
279			$monitoringLogsByQuestion = $monitoringLogRepository->findByLevelAndExe($level, $trackExe);
280			$snapshotList = [];
281
282			/** @var MonitoringLog $logByQuestion */
283			foreach ($monitoringLogsByQuestion as $logByQuestion) {
284			$snapshotUrl = ExerciseMonitoringPlugin::generateSnapshotUrl(
285			$user->getId(),
286			$logByQuestion->getImageFilename()
287			);
288			$snapshotList[] = api_get_local_time($logByQuestion->getCreatedAt()).' '.$snapshotUrl;
289			}
290
291			return implode(PHP_EOL, $snapshotList);
292			}
293

chamilo / chamilo-lms

Pull Request — 1.11.x (#4900)

findResults() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like