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

Passed

Push — master ( 16cab1...51d316 )

unknown

created 2025-11-13 20:14 UTC

LearnpathLink::calc_score() B

↳ Parent: LearnpathLink

Complexity

Conditions	11
Paths	44

Size

Total Lines	60
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	11
eloc	43
nc	44
nop	2
dl	0
loc	60
rs	7.3166
c	1
b	0
f	0

How to fix Long Method Complexity

<?php

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

use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CourseBundle\Entity\CLp;

/**
 * Defines a gradebook LearnpathLink object.
 *
 * @author Yannick Warnier <[email protected]>
 * @author Bert Steppé
 */
class LearnpathLink extends AbstractLink
{
    private $learnpath_table;
    private $learnpath_data;

    /**
     * Constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->set_type(LINK_LEARNPATH);
    }

    /**
     * Generate an array of all learnpaths available.
     *
     * @return array 2-dimensional array - every element contains 2 subelements (id, name)
     */
    public function get_all_links()
    {
        if (empty($this->getCourseId())) {
            return [];
        }

        $lpRepo = Container::getLpRepository();
        $session = api_get_session_entity();
        $course = api_get_course_entity();

        $qb = $lpRepo->getResourcesByCourse($course, $session);
        $lps = $qb->getQuery()->getResult();

        $list = [];
        /** @var CLp $lp */
        foreach ($lps as $lp) {
            $list[] = [$lp->getIid(), $lp->getTitle()];
        }

        return $list;
    }

    /**
     * Has anyone used this learnpath yet ?
     */
    public function has_results()
    {
        $tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
        $sql = "SELECT count(id) AS number FROM $tbl_stats
				WHERE lp_id = ".$this->get_ref_id();
        $result = Database::query($sql);
        $number = Database::fetch_array($result, 'NUM');

        return 0 != $number[0];
    }

    /**
     * Get the progress of this learnpath. Only the last attempt are taken into account.
     *
     * @param $studentId student id (default: all students who have results - then the average is returned)
     * @param $type The type of score we want to get: best|average|ranking
     *
     * @return array (score, max) if student is given
     *               array (sum of scores, number of scores) otherwise
     *               or null if no scores available
     */
    public function calc_score($studentId = null, $type = null)
    {
        $tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
        $session_id = $this->get_session_id();

        $sql = "SELECT * FROM $tbl_stats
                WHERE lp_id = ".$this->get_ref_id();

        if (isset($studentId)) {
            $sql .= ' AND user_id = '.intval($studentId);
        }

        // order by id, that way the student's first attempt is accessed first
        $sql .= ' ORDER BY view_count DESC';

        $scores = Database::query($sql);
        // for 1 student
        if (isset($studentId)) {
            if ($data = Database::fetch_assoc($scores)) {
                return [$data['progress'], 100];
            } else {
                return null;
            }
        } else {
            // all students -> get average
            $students = []; // user list, needed to make sure we only
            // take first attempts into account
            $rescount = 0;
            $sum = 0;
            $bestResult = 0;
            $sumResult = 0;
            while ($data = Database::fetch_array($scores)) {
                if (!(array_key_exists($data['user_id'], $students))) {
                    $students[$data['user_id']] = $data['progress'];
                    $rescount++;
                    $sum += $data['progress'] / 100;
                    $sumResult += $data['progress'];

                    if ($data['progress'] > $bestResult) {
                        $bestResult = $data['progress'];
                    }
                }
            }

            if (0 == $rescount) {
                return [null, null];
            } else {
                switch ($type) {
                    case 'best':
                        return [$bestResult, 100];
                        break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                    case 'average':
                        return [$sumResult / $rescount, 100];
                        break;
                    case 'ranking':
                        return AbstractLink::getCurrentUserRanking($studentId, $students);
                        break;
                    default:
                        return [$sum, $rescount];
                        break;
                }
            }
        }
    }

    /**
     * Get URL where to go to if the user clicks on the link.
     */
    public function get_link()
    {
        $session_id = $this->get_session_id();
        $url = api_get_path(WEB_CODE_PATH).'lp/lp_controller.php?'.api_get_cidreq_params(
            $this->getCourseId(),
                $session_id
        ).'&gradebook=view';

        if (!api_is_allowed_to_edit() || null == $this->calc_score(api_get_user_id())) {
            $url .= '&action=view&lp_id='.$this->get_ref_id();
        } else {
            $url .= '&action=build&lp_id='.$this->get_ref_id();
        }

        return $url;
    }

    /**
     * Get name to display: same as learnpath title.
     */
    public function get_name()
    {
        $data = $this->get_learnpath_data();

        return $data['title'];
    }

    /**
     * Get description to display: same as learnpath description.
     */
    public function get_description()
    {
        $data = $this->get_learnpath_data();

        return $data['description'];
    }

    /**
     * Check if this still links to a learnpath.
     */
    public function is_valid_link()
    {
        $sql = 'SELECT count(iid) FROM '.$this->get_learnpath_table().'
                WHERE iid = '.$this->get_ref_id().' ';
        $result = Database::query($sql);
        $number = Database::fetch_row($result, 'NUM');

        return 0 != $number[0];
    }

    public function get_type_name()
    {
        return get_lang('Learning paths');
    }

    public function needs_name_and_description()
    {
        return false;
    }

    public function needs_max()
    {
        return false;
    }

    public function needs_results()
    {
        return false;
    }

    public function is_allowed_to_change_name()
    {
        return false;
    }

    public function get_icon_name()
    {
        return 'learnpath';
    }

    /**
     * Lazy load function to get the database table of the learnpath.
     */
    private function get_learnpath_table()
    {
        $this->learnpath_table = Database::get_course_table(TABLE_LP_MAIN);

        return $this->learnpath_table;
    }

    /**
     * Lazy load function to get the database contents of this learnpath.
     */
    private function get_learnpath_data()
    {
        if (!isset($this->learnpath_data)) {
            $sql = 'SELECT * FROM '.$this->get_learnpath_table().'
                    WHERE iid = '.$this->get_ref_id().' ';
            $result = Database::query($sql);
            $this->learnpath_data = Database::fetch_array($result);
        }

        return $this->learnpath_data;
    }
}


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			use Chamilo\CoreBundle\Framework\Container;
6			use Chamilo\CourseBundle\Entity\CLp;
7
8			/**
9			* Defines a gradebook LearnpathLink object.
10			*
11			* @author Yannick Warnier <[email protected]>
12			* @author Bert Steppé
13			*/
14			class LearnpathLink extends AbstractLink
15			{
16			private $learnpath_table;
17			private $learnpath_data;
18
19			/**
20			* Constructor.
21			*/
22			public function __construct()
23			{
24			parent::__construct();
25			$this->set_type(LINK_LEARNPATH);
26			}
27
28			/**
29			* Generate an array of all learnpaths available.
30			*
31			* @return array 2-dimensional array - every element contains 2 subelements (id, name)
32			*/
33			public function get_all_links()
34			{
35			if (empty($this->getCourseId())) {
36			return [];
37			}
38
39			$lpRepo = Container::getLpRepository();
40			$session = api_get_session_entity();
41			$course = api_get_course_entity();
42
43			$qb = $lpRepo->getResourcesByCourse($course, $session);
44			$lps = $qb->getQuery()->getResult();
45
46			$list = [];
47			/** @var CLp $lp */
48			foreach ($lps as $lp) {
49			$list[] = [$lp->getIid(), $lp->getTitle()];
50			}
51
52			return $list;
53			}
54
55			/**
56			* Has anyone used this learnpath yet ?
57			*/
58			public function has_results()
59			{
60			$tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
61			$sql = "SELECT count(id) AS number FROM $tbl_stats
62			WHERE lp_id = ".$this->get_ref_id();
63			$result = Database::query($sql);
64			$number = Database::fetch_array($result, 'NUM');
65
66			return 0 != $number[0];
67			}
68
69			/**
70			* Get the progress of this learnpath. Only the last attempt are taken into account.
71			*
72			* @param $studentId student id (default: all students who have results - then the average is returned)
73			* @param $type The type of score we want to get: best\|average\|ranking
74			*
75			* @return array (score, max) if student is given
76			* array (sum of scores, number of scores) otherwise
77			* or null if no scores available
78			*/
79			public function calc_score($studentId = null, $type = null)
80			{
81			$tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
82			$session_id = $this->get_session_id();
83
84			$sql = "SELECT * FROM $tbl_stats
85			WHERE lp_id = ".$this->get_ref_id();
86
87			if (isset($studentId)) {
88			$sql .= ' AND user_id = '.intval($studentId);
89			}
90
91			// order by id, that way the student's first attempt is accessed first
92			$sql .= ' ORDER BY view_count DESC';
93
94			$scores = Database::query($sql);
95			// for 1 student
96			if (isset($studentId)) {
97			if ($data = Database::fetch_assoc($scores)) {
98			return [$data['progress'], 100];
99			} else {
100			return null;
101			}
102			} else {
103			// all students -> get average
104			$students = []; // user list, needed to make sure we only
105			// take first attempts into account
106			$rescount = 0;
107			$sum = 0;
108			$bestResult = 0;
109			$sumResult = 0;
110			while ($data = Database::fetch_array($scores)) {
111			if (!(array_key_exists($data['user_id'], $students))) {
112			$students[$data['user_id']] = $data['progress'];
113			$rescount++;
114			$sum += $data['progress'] / 100;
115			$sumResult += $data['progress'];
116
117			if ($data['progress'] > $bestResult) {
118			$bestResult = $data['progress'];
119			}
120			}
121			}
122
123			if (0 == $rescount) {
124			return [null, null];
125			} else {
126			switch ($type) {
127			case 'best':
128			return [$bestResult, 100];
129			break;
			0 ignored issues – show Unused Code introduced 2018-01-05 13:33 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
130			case 'average':
131			return [$sumResult / $rescount, 100];
132			break;
133			case 'ranking':
134			return AbstractLink::getCurrentUserRanking($studentId, $students);
135			break;
136			default:
137			return [$sum, $rescount];
138			break;
139			}
140			}
141			}
142			}
143
144			/**
145			* Get URL where to go to if the user clicks on the link.
146			*/
147			public function get_link()
148			{
149			$session_id = $this->get_session_id();
150			$url = api_get_path(WEB_CODE_PATH).'lp/lp_controller.php?'.api_get_cidreq_params(
151			$this->getCourseId(),
152			$session_id
153			).'&gradebook=view';
154
155			if (!api_is_allowed_to_edit() \|\| null == $this->calc_score(api_get_user_id())) {
156			$url .= '&action=view&lp_id='.$this->get_ref_id();
157			} else {
158			$url .= '&action=build&lp_id='.$this->get_ref_id();
159			}
160
161			return $url;
162			}
163
164			/**
165			* Get name to display: same as learnpath title.
166			*/
167			public function get_name()
168			{
169			$data = $this->get_learnpath_data();
170
171			return $data['title'];
172			}
173
174			/**
175			* Get description to display: same as learnpath description.
176			*/
177			public function get_description()
178			{
179			$data = $this->get_learnpath_data();
180
181			return $data['description'];
182			}
183
184			/**
185			* Check if this still links to a learnpath.
186			*/
187			public function is_valid_link()
188			{
189			$sql = 'SELECT count(iid) FROM '.$this->get_learnpath_table().'
190			WHERE iid = '.$this->get_ref_id().' ';
191			$result = Database::query($sql);
192			$number = Database::fetch_row($result, 'NUM');
193
194			return 0 != $number[0];
195			}
196
197			public function get_type_name()
198			{
199			return get_lang('Learning paths');
200			}
201
202			public function needs_name_and_description()
203			{
204			return false;
205			}
206
207			public function needs_max()
208			{
209			return false;
210			}
211
212			public function needs_results()
213			{
214			return false;
215			}
216
217			public function is_allowed_to_change_name()
218			{
219			return false;
220			}
221
222			public function get_icon_name()
223			{
224			return 'learnpath';
225			}
226
227			/**
228			* Lazy load function to get the database table of the learnpath.
229			*/
230			private function get_learnpath_table()
231			{
232			$this->learnpath_table = Database::get_course_table(TABLE_LP_MAIN);
233
234			return $this->learnpath_table;
235			}
236
237			/**
238			* Lazy load function to get the database contents of this learnpath.
239			*/
240			private function get_learnpath_data()
241			{
242			if (!isset($this->learnpath_data)) {
243			$sql = 'SELECT * FROM '.$this->get_learnpath_table().'
244			WHERE iid = '.$this->get_ref_id().' ';
245			$result = Database::query($sql);
246			$this->learnpath_data = Database::fetch_array($result);
247			}
248
249			return $this->learnpath_data;
250			}
251			}
252

chamilo / chamilo-lms

Push — master ( 16cab1...51d316 )

LearnpathLink::calc_score() B

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like