SearchController::hydrateQuestionResultsWithQuizIds() - Code Metrics - Inspection of "Merge pull request #7159 from christianbeeznest/GH..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ab6f49...c762ff )

unknown

created 2025-12-12 19:30 UTC

hydrateQuestionResultsWithQuizIds() C

↳ Parent: SearchController

Complexity

Conditions	13
Paths	74

Size

Total Lines	65
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	13
eloc	36
c	1
b	0
f	0
nc	74
nop	1
dl	0
loc	65
rs	6.6166

How to fix Long Method Complexity

<?php

declare(strict_types=1);

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

namespace Chamilo\CoreBundle\Controller;

use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Search\Xapian\XapianIndexService;
use Chamilo\CoreBundle\Search\Xapian\XapianSearchService;
use Chamilo\CourseBundle\Entity\CQuizRelQuestion;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;

final class SearchController extends AbstractController
{
    public function __construct(
        private readonly XapianSearchService $xapianSearchService,
        private readonly XapianIndexService $xapianIndexService,
        private readonly EntityManagerInterface $em,
    ) {
    }

    /**
     * Minimal Xapian search endpoint returning JSON.
     *
     * Example: /search/xapian?q=test
     */
    #[Route(
        path: '/search/xapian',
        name: 'chamilo_core.search_xapian',
        methods: ['GET']
    )]
    public function xapianSearchAction(Request $request): JsonResponse
    {
        $q = \trim((string) $request->query->get('q', ''));

        if ($q === '') {
            return $this->json([
                'query'   => '',
                'total'   => 0,
                'results' => [],
            ]);
        }

        try {
            $result = $this->xapianSearchService->search(
                queryString: $q,
                offset: 0,
                length: 20,
            );

            return $this->json([
                'query'   => $q,
                'total'   => $result['count'],
                'results' => $result['results'],
            ]);
        } catch (\Throwable $e) {
            return $this->json([
                'query' => $q,
                'error' => $e->getMessage(),
            ], 500);
        }
    }

    /**
     * HTML search page using Xapian.
     *
     * Example: /search/xapian/ui?q=test
     */
    #[Route(
        path: '/search/xapian/ui',
        name: 'chamilo_core.search_xapian_ui',
        methods: ['GET']
    )]
    public function xapianSearchPageAction(Request $request): Response
    {
        $q = \trim((string) $request->query->get('q', ''));

        $total = 0;
        $results = [];
        $error = null;

        if ($q !== '') {
            try {
                $searchResult = $this->xapianSearchService->search(
                    queryString: $q,
                    offset: 0,
                    length: 20
                );

                $total   = $searchResult['count']   ?? 0;
                $results = $searchResult['results'] ?? [];

                $results = $this->hydrateResultsWithCourseRootNode($results);
                $results = $this->hydrateQuestionResultsWithQuizIds($results);
            } catch (\Throwable $e) {
                $error = $e->getMessage();
            }
        }

        return $this->render('@ChamiloCore/Search/xapian_search.html.twig', [
            'query'   => $q,
            'total'   => $total,
            'results' => $results,
            'error'   => $error,
        ]);
    }

    /**
     * Demo endpoint: index a sample document into Xapian.
     *
     * Call this once, then query /search/xapian?q=demo or ?q=chamilo.
     */
    #[Route(
        path: '/search/xapian/demo-index',
        name: 'chamilo_core.search_xapian_demo_index',
        methods: ['POST']
    )]
    public function xapianDemoIndexAction(): JsonResponse
    {
        try {
            $docId = $this->xapianIndexService->indexDemoDocument();

            return $this->json([
                'indexed' => true,
                'doc_id'  => $docId,
            ]);
        } catch (\Throwable $e) {
            return $this->json([
                'indexed' => false,
                'error'   => $e->getMessage(),
            ], 500);
        }
    }

    /**
     * Attach course_root_node_id to each result if we can resolve it from course_id.
     *
     * @param array<int, array<string, mixed>> $results
     *
     * @return array<int, array<string, mixed>>
     */
    private function hydrateResultsWithCourseRootNode(array $results): array
    {
        foreach ($results as &$result) {
            if (!\is_array($result)) {
                continue;
            }

            $data = $result['data'] ?? [];
            if (!\is_array($data)) {
                $data = [];
            }

            // If the field already exists (coming from the indexer), keep it.
            if (!empty($data['course_root_node_id'])) {
                $result['data'] = $data;
                continue;
            }

            $courseId = isset($data['course_id']) && $data['course_id'] !== ''
                ? (int) $data['course_id']
                : null;

            if (!$courseId) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                $result['data'] = $data;
                continue;
            }

            /** @var Course|null $course */
            $course = $this->em->find(Course::class, $courseId);
            if (!$course || !$course->getResourceNode()) {
                $result['data'] = $data;
                continue;
            }

            $data['course_root_node_id'] = (string) $course->getResourceNode()->getId();
            $result['data'] = $data;
        }

        return $results;
    }

    /**
     * For question results, resolve the related quiz from c_quiz_rel_question
     * and attach quiz_id into the result data so the Twig can build the link.
     *
     * @param array<int, array<string, mixed>> $results
     *
     * @return array<int, array<string, mixed>>
     */
    private function hydrateQuestionResultsWithQuizIds(array $results): array
    {
        foreach ($results as &$result) {
            if (!\is_array($result)) {
                continue;
            }

            $data = $result['data'] ?? [];
            if (!\is_array($data)) {
                $data = [];
            }

            $kind = $data['kind'] ?? null;
            $tool = $data['tool'] ?? null;

            $isQuestion =
                ('question' === $kind)
                || ('quiz_question' === $tool);

            if (!$isQuestion) {
                $result['data'] = $data;

                continue;
            }

            if (!empty($data['quiz_id'])) {
                $result['data'] = $data;

                continue;
            }

            $questionId = isset($data['question_id']) && '' !== $data['question_id']
                ? (int) $data['question_id']
                : null;

            if (null === $questionId) {
                $result['data'] = $data;

                continue;
            }

            /** @var CQuizRelQuestion|null $rel */
            $rel = $this->em
                ->getRepository(CQuizRelQuestion::class)
                ->findOneBy(['question' => $questionId]);

            if (!$rel) {
                $result['data'] = $data;

                continue;
            }

            $quiz = $rel->getQuiz();
            if (!$quiz || null === $quiz->getIid()) {
                $result['data'] = $data;

                continue;
            }

            $data['quiz_id'] = (string) $quiz->getIid();

            $result['data'] = $data;
        }

        return $results;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\CoreBundle\Controller;
8
9			use Chamilo\CoreBundle\Entity\Course;
10			use Chamilo\CoreBundle\Search\Xapian\XapianIndexService;
11			use Chamilo\CoreBundle\Search\Xapian\XapianSearchService;
12			use Chamilo\CourseBundle\Entity\CQuizRelQuestion;
13			use Doctrine\ORM\EntityManagerInterface;
14			use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
15			use Symfony\Component\HttpFoundation\JsonResponse;
16			use Symfony\Component\HttpFoundation\Request;
17			use Symfony\Component\HttpFoundation\Response;
18			use Symfony\Component\Routing\Attribute\Route;
19
20			final class SearchController extends AbstractController
21			{
22			public function __construct(
23			private readonly XapianSearchService $xapianSearchService,
24			private readonly XapianIndexService $xapianIndexService,
25			private readonly EntityManagerInterface $em,
26			) {
27			}
28
29			/**
30			* Minimal Xapian search endpoint returning JSON.
31			*
32			* Example: /search/xapian?q=test
33			*/
34			#[Route(
35			path: '/search/xapian',
36			name: 'chamilo_core.search_xapian',
37			methods: ['GET']
38			)]
39			public function xapianSearchAction(Request $request): JsonResponse
40			{
41			$q = \trim((string) $request->query->get('q', ''));
42
43			if ($q === '') {
44			return $this->json([
45			'query' => '',
46			'total' => 0,
47			'results' => [],
48			]);
49			}
50
51			try {
52			$result = $this->xapianSearchService->search(
53			queryString: $q,
54			offset: 0,
55			length: 20,
56			);
57
58			return $this->json([
59			'query' => $q,
60			'total' => $result['count'],
61			'results' => $result['results'],
62			]);
63			} catch (\Throwable $e) {
64			return $this->json([
65			'query' => $q,
66			'error' => $e->getMessage(),
67			], 500);
68			}
69			}
70
71			/**
72			* HTML search page using Xapian.
73			*
74			* Example: /search/xapian/ui?q=test
75			*/
76			#[Route(
77			path: '/search/xapian/ui',
78			name: 'chamilo_core.search_xapian_ui',
79			methods: ['GET']
80			)]
81			public function xapianSearchPageAction(Request $request): Response
82			{
83			$q = \trim((string) $request->query->get('q', ''));
84
85			$total = 0;
86			$results = [];
87			$error = null;
88
89			if ($q !== '') {
90			try {
91			$searchResult = $this->xapianSearchService->search(
92			queryString: $q,
93			offset: 0,
94			length: 20
95			);
96
97			$total = $searchResult['count'] ?? 0;
98			$results = $searchResult['results'] ?? [];
99
100			$results = $this->hydrateResultsWithCourseRootNode($results);
101			$results = $this->hydrateQuestionResultsWithQuizIds($results);
102			} catch (\Throwable $e) {
103			$error = $e->getMessage();
104			}
105			}
106
107			return $this->render('@ChamiloCore/Search/xapian_search.html.twig', [
108			'query' => $q,
109			'total' => $total,
110			'results' => $results,
111			'error' => $error,
112			]);
113			}
114
115			/**
116			* Demo endpoint: index a sample document into Xapian.
117			*
118			* Call this once, then query /search/xapian?q=demo or ?q=chamilo.
119			*/
120			#[Route(
121			path: '/search/xapian/demo-index',
122			name: 'chamilo_core.search_xapian_demo_index',
123			methods: ['POST']
124			)]
125			public function xapianDemoIndexAction(): JsonResponse
126			{
127			try {
128			$docId = $this->xapianIndexService->indexDemoDocument();
129
130			return $this->json([
131			'indexed' => true,
132			'doc_id' => $docId,
133			]);
134			} catch (\Throwable $e) {
135			return $this->json([
136			'indexed' => false,
137			'error' => $e->getMessage(),
138			], 500);
139			}
140			}
141
142			/**
143			* Attach course_root_node_id to each result if we can resolve it from course_id.
144			*
145			* @param array<int, array<string, mixed>> $results
146			*
147			* @return array<int, array<string, mixed>>
148			*/
149			private function hydrateResultsWithCourseRootNode(array $results): array
150			{
151			foreach ($results as &$result) {
152			if (!\is_array($result)) {
153			continue;
154			}
155
156			$data = $result['data'] ?? [];
157			if (!\is_array($data)) {
158			$data = [];
159			}
160
161			// If the field already exists (coming from the indexer), keep it.
162			if (!empty($data['course_root_node_id'])) {
163			$result['data'] = $data;
164			continue;
165			}
166
167			$courseId = isset($data['course_id']) && $data['course_id'] !== ''
168			? (int) $data['course_id']
169			: null;
170
171			if (!$courseId) {
			0 ignored issues – show Bug Best Practice introduced 2025-12-08 05:34 UTC by Report Bug Copy Issue Report The expression `$courseId` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be 0. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
172			$result['data'] = $data;
173			continue;
174			}
175
176			/** @var Course\|null $course */
177			$course = $this->em->find(Course::class, $courseId);
178			if (!$course \|\| !$course->getResourceNode()) {
179			$result['data'] = $data;
180			continue;
181			}
182
183			$data['course_root_node_id'] = (string) $course->getResourceNode()->getId();
184			$result['data'] = $data;
185			}
186
187			return $results;
188			}
189
190			/**
191			* For question results, resolve the related quiz from c_quiz_rel_question
192			* and attach quiz_id into the result data so the Twig can build the link.
193			*
194			* @param array<int, array<string, mixed>> $results
195			*
196			* @return array<int, array<string, mixed>>
197			*/
198			private function hydrateQuestionResultsWithQuizIds(array $results): array
199			{
200			foreach ($results as &$result) {
201			if (!\is_array($result)) {
202			continue;
203			}
204
205			$data = $result['data'] ?? [];
206			if (!\is_array($data)) {
207			$data = [];
208			}
209
210			$kind = $data['kind'] ?? null;
211			$tool = $data['tool'] ?? null;
212
213			$isQuestion =
214			('question' === $kind)
215			\|\| ('quiz_question' === $tool);
216
217			if (!$isQuestion) {
218			$result['data'] = $data;
219
220			continue;
221			}
222
223			if (!empty($data['quiz_id'])) {
224			$result['data'] = $data;
225
226			continue;
227			}
228
229			$questionId = isset($data['question_id']) && '' !== $data['question_id']
230			? (int) $data['question_id']
231			: null;
232
233			if (null === $questionId) {
234			$result['data'] = $data;
235
236			continue;
237			}
238
239			/** @var CQuizRelQuestion\|null $rel */
240			$rel = $this->em
241			->getRepository(CQuizRelQuestion::class)
242			->findOneBy(['question' => $questionId]);
243
244			if (!$rel) {
245			$result['data'] = $data;
246
247			continue;
248			}
249
250			$quiz = $rel->getQuiz();
251			if (!$quiz \|\| null === $quiz->getIid()) {
252			$result['data'] = $data;
253
254			continue;
255			}
256
257			$data['quiz_id'] = (string) $quiz->getIid();
258
259			$result['data'] = $data;
260			}
261
262			return $results;
263			}
264			}
265

chamilo / chamilo-lms

Push — master ( ab6f49...c762ff )

hydrateQuestionResultsWithQuizIds() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like