Matching::createAnswersForm() - Code Metrics - Inspection of "Exercise: Re-integrate new question types - refs #..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#6637)

unknown

created 2025-08-30 21:36 UTC

Matching::createAnswersForm() F

↳ Parent: Matching

Complexity

Conditions	26
Paths	> 20000

Size

Total Lines	222
Code Lines	143

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	26
eloc	143
nc	36288
nop	1
dl	0
loc	222
rs	0
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

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

use Chamilo\CourseBundle\Entity\CQuizAnswer;

/**
 * Class Matching
 * Matching questions type class.
 *
 * This class allows to instantiate an object of
 * type MULTIPLE_ANSWER (MULTIPLE CHOICE, MULTIPLE ANSWER)
 * extending the class question
 *
 * @author Eric Marguin
 */
class Matching extends Question
{
    public $typePicture = 'matching.png';
    public $explanationLangVar = 'Matching';

    public function __construct()
    {
        parent::__construct();
        $this->type = MATCHING;
        $this->isContent = $this->getIsContent();
    }

    public function createAnswersForm($form)
    {
        $defaults = [];
        $nb_matches = $nb_options = 2;
        $matches = [];
        $answer = null;
        $counter = 1;

        if (isset($this->id)) {
            $answer = new Answer($this->id);
            $answer->read();
            if ($answer->nbrAnswers > 0) {
                for ($i = 1; $i <= $answer->nbrAnswers; $i++) {
                    $correct = $answer->isCorrect($i);
                    if (empty($correct)) {
                        $matches[$answer->selectAutoId($i)] = chr(64 + $counter);
                        $counter++;
                    }
                }
            }
        }

        if ($form->isSubmitted()) {
            $nb_matches = $form->getSubmitValue('nb_matches');
            $nb_options = $form->getSubmitValue('nb_options');
            if (isset($_POST['lessOptions'])) {
                $nb_matches--;
                $nb_options--;
            }
            if (isset($_POST['moreOptions'])) {
                $nb_matches++;
                $nb_options++;
            }
        } elseif (!empty($this->id)) {
            if ($answer->nbrAnswers > 0) {
                $nb_matches = $nb_options = 0;
                for ($i = 1; $i <= $answer->nbrAnswers; $i++) {
                    if ($answer->isCorrect($i)) {
                        $nb_matches++;
                        $defaults['answer['.$nb_matches.']'] = $answer->selectAnswer($i);
                        if (MATCHING === $this->type) {
                            $defaults['weighting['.$nb_matches.']'] = float_format($answer->selectWeighting($i), 1);
                        }
                        $defaults['matches['.$nb_matches.']'] = $answer->correct[$i];
                    } else {
                        $nb_options++;
                        $defaults['option['.$nb_options.']'] = $answer->selectAnswer($i);
                    }
                }
            }
        } else {
            $defaults['answer[1]'] = get_lang('First step');
            $defaults['answer[2]'] = get_lang('Second step');
            $defaults['matches[2]'] = '2';
            $defaults['option[1]'] = get_lang('Note down the address');
            $defaults['option[2]'] = get_lang('Contact the emergency services');
        }

        if (empty($matches)) {
            for ($i = 1; $i <= $nb_options; $i++) {
                // fill the array with A, B, C.....
                $matches[$i] = chr(64 + $i);
            }
        } else {
            for ($i = $counter; $i <= $nb_options; $i++) {
                // fill the array with A, B, C.....
                $matches[$i] = chr(64 + $i);
            }
        }

        $form->addElement('hidden', 'nb_matches', $nb_matches);
        $form->addElement('hidden', 'nb_options', $nb_options);

        $thWeighting = '';
        if (MATCHING === $this->type) {
            $thWeighting = '<th width="10%">'.get_lang('Score').'</th>';
        }

        // DISPLAY MATCHES
        $html = '<table class="table table-striped table-hover">
        <thead>
            <tr>
                <th width="5%">'.get_lang('N°').'</th>
                <th width="70%">'.get_lang('Answer').'</th>
                <th width="15%">'.get_lang('Matches To').'</th>
                '.$thWeighting.'
            </tr>
        </thead>
        <tbody>';

        $form->addHeader(get_lang('Match them'));
        $form->addHtml($html);

        if ($nb_matches < 1) {
            $nb_matches = 1;
            Display::addFlash(
                Display::return_message(get_lang('You have to create at least one answer'))
            );
        }

        $editorConfig = [
            'ToolbarSet' => 'TestMatching',
            'Width' => '100%',
            'Height' => '125',
        ];

        for ($i = 1; $i <= $nb_matches; $i++) {
            $renderer = &$form->defaultRenderer();
            $renderer->setElementTemplate(
                '<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error -->{element}</td>',
                "answer[$i]"
            );

            $renderer->setElementTemplate(
                '<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error -->{element}</td>',
                "matches[$i]"
            );

            $renderer->setElementTemplate(
                '<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error -->{element}</td>',
                "weighting[$i]"
            );

            $form->addHtml('<tr>');
            $form->addHtml("<td>$i</td>");
            $form->addHtmlEditor(
                "answer[$i]",
                null,
                null,
                false,
                $editorConfig
            );
            $form->addSelect(
                "matches[$i]",
                null,
                $matches,
                ['id' => 'matches_'.$i]
            );
            if (MATCHING === $this->type) {
                $form->addText(
                    "weighting[$i]",
                    null,
                    true,
                    ['id' => 'weighting_'.$i, 'value' => 10]
                );
            } else {
                $form->addHidden("weighting[$i]", "0");
            }
            $form->addHtml('</tr>');
        }

        $form->addHtml('</tbody></table>');

        // DISPLAY OPTIONS
        $html = '<table class="table table-striped table-hover">
            <thead>
                <tr>
                    <th width="15%">'.get_lang('N°').'</th>
                    <th width="85%">'.get_lang('Answer').'</th>
                </tr>
            </thead>
            <tbody>';

        $form->addHtml($html);

        if ($nb_options < 1) {
            $nb_options = 1;
            Display::addFlash(
                Display::return_message(get_lang('You have to create at least one answer'))
            );
        }

        for ($i = 1; $i <= $nb_options; $i++) {
            $renderer = &$form->defaultRenderer();
            $renderer->setElementTemplate(
                '<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error -->{element}</td>',
                "option[$i]"
            );

            $form->addHtml('<tr>');
            $form->addHtml('<td>'.chr(64 + $i).'</td>');
            $form->addHtmlEditor(
                "option[$i]",
                null,
                null,
                false,
                $editorConfig
            );

            $form->addHtml('</tr>');
        }

        $form->addHtml('</table>');

        if (MATCHING_COMBINATION === $this->type) {
            $form->addText('questionWeighting', get_lang('Score'), true, ['value' => 10]);

            if (!empty($this->id)) {
                $defaults['questionWeighting'] = $this->weighting;
            }
        }

        global $text;
        $group = [];
        // setting the save button here and not in the question class.php
        $group[] = $form->addButtonDelete(get_lang('Remove element'), 'lessOptions', true);
        $group[] = $form->addButtonCreate(get_lang('Add element'), 'moreOptions', true);
        $group[] = $form->addButtonSave($text, 'submitQuestion', true);
        $form->addGroup($group);

        if (!empty($this->id)) {
            $form->setDefaults($defaults);
        } else {
            if (1 == $this->isContent) {
                $form->setDefaults($defaults);
            }
        }

        $form->setConstants(
            [
                'nb_matches' => $nb_matches,
                'nb_options' => $nb_options,
            ]
        );
    }

    public function processAnswersCreation($form, $exercise)
    {
        $nb_matches = $form->getSubmitValue('nb_matches');
        $nb_options = $form->getSubmitValue('nb_options');
        $this->weighting = 0;
        $position = 0;
        $objAnswer = new Answer($this->id);

        // Insert the options
        for ($i = 1; $i <= $nb_options; $i++) {
            $position++;
            $option = $form->getSubmitValue('option['.$i.']');
            $objAnswer->createAnswer($option, 0, '', 0, $position);
        }

        // Insert the answers
        for ($i = 1; $i <= $nb_matches; $i++) {
            $position++;
            $answer  = $form->getSubmitValue('answer['.$i.']');
            $matches = $form->getSubmitValue('matches['.$i.']');
            $rowWeight = (MATCHING === $this->type)
                ? (float) $form->getSubmitValue('weighting['.$i.']')
                : 0.0;

            if (MATCHING === $this->type) {
                $this->weighting += $rowWeight;
            }

            $objAnswer->createAnswer(
                $answer,
                $matches,
                '',
                $rowWeight,
                $position
            );
        }

        if (MATCHING_COMBINATION === $this->type) {
            $this->weighting = (float) $form->getSubmitValue('questionWeighting');
        }

        $objAnswer->save();
        $this->save($exercise);
    }

    public function return_header(Exercise $exercise, $counter = null, $score = [])
    {
        $header = parent::return_header($exercise, $counter, $score);
        $header .= '<table class="'.$this->questionTableClass.'">';
        $header .= '<tr>';
        $header .= '<th>'.get_lang('Elements list').'</th>';
        if (!in_array($exercise->results_disabled, [
            RESULT_DISABLE_SHOW_ONLY_IN_CORRECT_ANSWER,
        ])
        ) {
            $header .= '<th>'.get_lang('Your choice').'</th>';
            if ($exercise->showExpectedChoiceColumn()) {
                $header .= '<th>'.get_lang('Expected choice').'</th>';
            }
        }

        if ($exercise->showExpectedChoice()) {
            $header .= '<th class="text-center">'.get_lang('Status').'</th>';
        }
        $header .= '</tr>';

        return $header;
    }

    /**
     * Check if a answer is correct.
     *
     * @param int $position
     * @param int $answer
     * @param int $questionId
     *
     * @return bool
     */
    public static function isCorrect($position, $answer, $questionId)
    {
        $count = Database::getManager()
            ->getRepository(CQuizAnswer::class)
            ->count(['iid' => $position, 'correct' => $answer, 'question' => $questionId]);

        return (bool) $count;
    }
}


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			use Chamilo\CourseBundle\Entity\CQuizAnswer;
6
7			/**
8			* Class Matching
9			* Matching questions type class.
10			*
11			* This class allows to instantiate an object of
12			* type MULTIPLE_ANSWER (MULTIPLE CHOICE, MULTIPLE ANSWER)
13			* extending the class question
14			*
15			* @author Eric Marguin
16			*/
17			class Matching extends Question
18			{
19			public $typePicture = 'matching.png';
20			public $explanationLangVar = 'Matching';
21
22			public function __construct()
23			{
24			parent::__construct();
25			$this->type = MATCHING;
26			$this->isContent = $this->getIsContent();
27			}
28
29			public function createAnswersForm($form)
30			{
31			$defaults = [];
32			$nb_matches = $nb_options = 2;
33			$matches = [];
34			$answer = null;
35			$counter = 1;
36
37			if (isset($this->id)) {
38			$answer = new Answer($this->id);
39			$answer->read();
40			if ($answer->nbrAnswers > 0) {
41			for ($i = 1; $i <= $answer->nbrAnswers; $i++) {
42			$correct = $answer->isCorrect($i);
43			if (empty($correct)) {
44			$matches[$answer->selectAutoId($i)] = chr(64 + $counter);
45			$counter++;
46			}
47			}
48			}
49			}
50
51			if ($form->isSubmitted()) {
52			$nb_matches = $form->getSubmitValue('nb_matches');
53			$nb_options = $form->getSubmitValue('nb_options');
54			if (isset($_POST['lessOptions'])) {
55			$nb_matches--;
56			$nb_options--;
57			}
58			if (isset($_POST['moreOptions'])) {
59			$nb_matches++;
60			$nb_options++;
61			}
62			} elseif (!empty($this->id)) {
63			if ($answer->nbrAnswers > 0) {
64			$nb_matches = $nb_options = 0;
65			for ($i = 1; $i <= $answer->nbrAnswers; $i++) {
66			if ($answer->isCorrect($i)) {
67			$nb_matches++;
68			$defaults['answer['.$nb_matches.']'] = $answer->selectAnswer($i);
69			if (MATCHING === $this->type) {
70			$defaults['weighting['.$nb_matches.']'] = float_format($answer->selectWeighting($i), 1);
71			}
72			$defaults['matches['.$nb_matches.']'] = $answer->correct[$i];
73			} else {
74			$nb_options++;
75			$defaults['option['.$nb_options.']'] = $answer->selectAnswer($i);
76			}
77			}
78			}
79			} else {
80			$defaults['answer[1]'] = get_lang('First step');
81			$defaults['answer[2]'] = get_lang('Second step');
82			$defaults['matches[2]'] = '2';
83			$defaults['option[1]'] = get_lang('Note down the address');
84			$defaults['option[2]'] = get_lang('Contact the emergency services');
85			}
86
87			if (empty($matches)) {
88			for ($i = 1; $i <= $nb_options; $i++) {
89			// fill the array with A, B, C.....
90			$matches[$i] = chr(64 + $i);
91			}
92			} else {
93			for ($i = $counter; $i <= $nb_options; $i++) {
94			// fill the array with A, B, C.....
95			$matches[$i] = chr(64 + $i);
96			}
97			}
98
99			$form->addElement('hidden', 'nb_matches', $nb_matches);
100			$form->addElement('hidden', 'nb_options', $nb_options);
101
102			$thWeighting = '';
103			if (MATCHING === $this->type) {
104			$thWeighting = '<th width="10%">'.get_lang('Score').'</th>';
105			}
106
107			// DISPLAY MATCHES
108			$html = '<table class="table table-striped table-hover">
109			<thead>
110			<tr>
111			<th width="5%">'.get_lang('N°').'</th>
112			<th width="70%">'.get_lang('Answer').'</th>
113			<th width="15%">'.get_lang('Matches To').'</th>
114			'.$thWeighting.'
115			</tr>
116			</thead>
117			<tbody>';
118
119			$form->addHeader(get_lang('Match them'));
120			$form->addHtml($html);
121
122			if ($nb_matches < 1) {
123			$nb_matches = 1;
124			Display::addFlash(
125			Display::return_message(get_lang('You have to create at least one answer'))
126			);
127			}
128
129			$editorConfig = [
130			'ToolbarSet' => 'TestMatching',
131			'Width' => '100%',
132			'Height' => '125',
133			];
134
135			for ($i = 1; $i <= $nb_matches; $i++) {
136			$renderer = &$form->defaultRenderer();
137			$renderer->setElementTemplate(
138			'<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error -->{element}</td>',
139			"answer[$i]"
140			);
141
142			$renderer->setElementTemplate(
143			'<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error -->{element}</td>',
144			"matches[$i]"
145			);
146
147			$renderer->setElementTemplate(
148			'<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error -->{element}</td>',
149			"weighting[$i]"
150			);
151
152			$form->addHtml('<tr>');
153			$form->addHtml("<td>$i</td>");
154			$form->addHtmlEditor(
155			"answer[$i]",
156			null,
157			null,
158			false,
159			$editorConfig
160			);
161			$form->addSelect(
162			"matches[$i]",
163			null,
164			$matches,
165			['id' => 'matches_'.$i]
166			);
167			if (MATCHING === $this->type) {
168			$form->addText(
169			"weighting[$i]",
170			null,
171			true,
172			['id' => 'weighting_'.$i, 'value' => 10]
173			);
174			} else {
175			$form->addHidden("weighting[$i]", "0");
176			}
177			$form->addHtml('</tr>');
178			}
179
180			$form->addHtml('</tbody></table>');
181
182			// DISPLAY OPTIONS
183			$html = '<table class="table table-striped table-hover">
184			<thead>
185			<tr>
186			<th width="15%">'.get_lang('N°').'</th>
187			<th width="85%">'.get_lang('Answer').'</th>
188			</tr>
189			</thead>
190			<tbody>';
191
192			$form->addHtml($html);
193
194			if ($nb_options < 1) {
195			$nb_options = 1;
196			Display::addFlash(
197			Display::return_message(get_lang('You have to create at least one answer'))
198			);
199			}
200
201			for ($i = 1; $i <= $nb_options; $i++) {
202			$renderer = &$form->defaultRenderer();
203			$renderer->setElementTemplate(
204			'<td><!-- BEGIN error --><span class="form_error">{error}</span><!-- END error -->{element}</td>',
205			"option[$i]"
206			);
207
208			$form->addHtml('<tr>');
209			$form->addHtml('<td>'.chr(64 + $i).'</td>');
210			$form->addHtmlEditor(
211			"option[$i]",
212			null,
213			null,
214			false,
215			$editorConfig
216			);
217
218			$form->addHtml('</tr>');
219			}
220
221			$form->addHtml('</table>');
222
223			if (MATCHING_COMBINATION === $this->type) {
224			$form->addText('questionWeighting', get_lang('Score'), true, ['value' => 10]);
225
226			if (!empty($this->id)) {
227			$defaults['questionWeighting'] = $this->weighting;
228			}
229			}
230
231			global $text;
232			$group = [];
233			// setting the save button here and not in the question class.php
234			$group[] = $form->addButtonDelete(get_lang('Remove element'), 'lessOptions', true);
235			$group[] = $form->addButtonCreate(get_lang('Add element'), 'moreOptions', true);
236			$group[] = $form->addButtonSave($text, 'submitQuestion', true);
237			$form->addGroup($group);
238
239			if (!empty($this->id)) {
240			$form->setDefaults($defaults);
241			} else {
242			if (1 == $this->isContent) {
243			$form->setDefaults($defaults);
244			}
245			}
246
247			$form->setConstants(
248			[
249			'nb_matches' => $nb_matches,
250			'nb_options' => $nb_options,
251			]
252			);
253			}
254
255			public function processAnswersCreation($form, $exercise)
256			{
257			$nb_matches = $form->getSubmitValue('nb_matches');
258			$nb_options = $form->getSubmitValue('nb_options');
259			$this->weighting = 0;
260			$position = 0;
261			$objAnswer = new Answer($this->id);
262
263			// Insert the options
264			for ($i = 1; $i <= $nb_options; $i++) {
265			$position++;
266			$option = $form->getSubmitValue('option['.$i.']');
267			$objAnswer->createAnswer($option, 0, '', 0, $position);
268			}
269
270			// Insert the answers
271			for ($i = 1; $i <= $nb_matches; $i++) {
272			$position++;
273			$answer = $form->getSubmitValue('answer['.$i.']');
274			$matches = $form->getSubmitValue('matches['.$i.']');
275			$rowWeight = (MATCHING === $this->type)
276			? (float) $form->getSubmitValue('weighting['.$i.']')
277			: 0.0;
278
279			if (MATCHING === $this->type) {
280			$this->weighting += $rowWeight;
281			}
282
283			$objAnswer->createAnswer(
284			$answer,
285			$matches,
286			'',
287			$rowWeight,
288			$position
289			);
290			}
291
292			if (MATCHING_COMBINATION === $this->type) {
293			$this->weighting = (float) $form->getSubmitValue('questionWeighting');
294			}
295
296			$objAnswer->save();
297			$this->save($exercise);
298			}
299
300			public function return_header(Exercise $exercise, $counter = null, $score = [])
301			{
302			$header = parent::return_header($exercise, $counter, $score);
303			$header .= '<table class="'.$this->questionTableClass.'">';
304			$header .= '<tr>';
305			$header .= '<th>'.get_lang('Elements list').'</th>';
306			if (!in_array($exercise->results_disabled, [
307			RESULT_DISABLE_SHOW_ONLY_IN_CORRECT_ANSWER,
308			])
309			) {
310			$header .= '<th>'.get_lang('Your choice').'</th>';
311			if ($exercise->showExpectedChoiceColumn()) {
312			$header .= '<th>'.get_lang('Expected choice').'</th>';
313			}
314			}
315
316			if ($exercise->showExpectedChoice()) {
317			$header .= '<th class="text-center">'.get_lang('Status').'</th>';
318			}
319			$header .= '</tr>';
320
321			return $header;
322			}
323
324			/**
325			* Check if a answer is correct.
326			*
327			* @param int $position
328			* @param int $answer
329			* @param int $questionId
330			*
331			* @return bool
332			*/
333			public static function isCorrect($position, $answer, $questionId)
334			{
335			$count = Database::getManager()
336			->getRepository(CQuizAnswer::class)
337			->count(['iid' => $position, 'correct' => $answer, 'question' => $questionId]);
338
339			return (bool) $count;
340			}
341			}
342

chamilo / chamilo-lms

Pull Request — master (#6637)

Matching::createAnswersForm() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like