ForumThreadLink::getThreadData() - Code Metrics - Inspection of "Add ResourceIllustrationInterface in order to impl..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 48aeb9...852133 )

by Julito

created 2021-01-01 13:36 UTC

ForumThreadLink::getThreadData() A

↳ Parent: ForumThreadLink

Complexity

Conditions	3
Paths	4

Size

Total Lines	20
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	13
nc	4
nop	0
dl	0
loc	20
rs	9.8333
c	0
b	0
f	0

<?php

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

/**
 * Class ForumThreadLink.
 *
 * @author Bert Steppé
 */
class ForumThreadLink extends AbstractLink
{
    private $forum_thread_table;

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

    /**
     * @return string
     */
    public function get_type_name()
    {
        return get_lang('Forum threads');
    }

    /**
     * @return bool
     */
    public function is_allowed_to_change_name()
    {
        return false;
    }

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

        $tbl_grade_links = Database::get_course_table(TABLE_FORUM_THREAD);
        $sessionId = $this->get_session_id();

        if ($sessionId) {
            $session_condition = 'tl.session_id='.$sessionId;
        } else {
            $session_condition = '(tl.session_id = 0 OR tl.session_id IS NULL)';
        }

        $sql = 'SELECT tl.iid as thread_id, tl.thread_title, tl.thread_title_qualify
                FROM '.$tbl_grade_links.' tl
                WHERE
                    tl.c_id = '.$this->course_id.' AND
                    '.$session_condition.'
                ';

        $result = Database::query($sql);
        while ($data = Database::fetch_array($result)) {
            if (isset($data['thread_title_qualify']) && '' != $data['thread_title_qualify']) {
                $cats[] = [$data['thread_id'], $data['thread_title_qualify']];
            } else {
                $cats[] = [$data['thread_id'], $data['thread_title']];
            }
        }

        return isset($cats) ? $cats : [];

    }

    /**
     * Has anyone done this exercise yet ?
     *
     * @return bool
     */
    public function has_results()
    {
        $table = Database::get_course_table(TABLE_FORUM_POST);

        $sql = "SELECT count(*) AS number FROM $table
                WHERE
                    c_id = ".$this->course_id." AND
                    iid = '".$this->get_ref_id()."'
                ";
        $result = Database::query($sql);
        $number = Database::fetch_row($result);

        return 0 != $number[0];
    }

    /**
     * @param int    $studentId
     * @param string $type
     *
     * @return array|null
     */
    public function calc_score($studentId = null, $type = null)
    {
        $threadInfo = $this->getThreadData();
        $thread_qualify = Database::get_course_table(TABLE_FORUM_THREAD_QUALIFY);
        $sessionId = $this->get_session_id();
        $sessionCondition = api_get_session_condition(
            $sessionId,
            true,
            false,
            'session_id'
        );

        $sql = 'SELECT thread_qualify_max
                FROM '.Database::get_course_table(TABLE_FORUM_THREAD)."
                WHERE
                    c_id = ".$this->course_id." AND
                    iid = '".$this->get_ref_id()."'
                    $sessionCondition
                ";
        $query = Database::query($sql);
        $assignment = Database::fetch_array($query);

        $sql = "SELECT * FROM $thread_qualify
                WHERE
                    c_id = ".$this->course_id." AND
                    iid = ".$this->get_ref_id()."
                    $sessionCondition
                ";
        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 qualify_time DESC';
        $scores = Database::query($sql);

        // for 1 student
        if (isset($studentId)) {
            if (0 == $threadInfo['thread_peer_qualify']) {
                // Classic way of calculate score
                if ($data = Database::fetch_array($scores)) {
                    return [
                        $data['qualify'],
                        $assignment['thread_qualify_max'],
                    ];
                } else {
                    // We sent the 0/thread_qualify_max instead of null for correct calculations
                    return [0, $assignment['thread_qualify_max']];
                }
            } else {
                // Take average
                $score = 0;
                $counter = 0;
                if (Database::num_rows($scores)) {
                    while ($data = Database::fetch_array($scores, 'ASSOC')) {
                        $score += $data['qualify'];
                        $counter++;
                    }
                }
                // If no result
                if (empty($counter) || $counter <= 2) {
                    return [0, $assignment['thread_qualify_max']];
                }

                return [$score / $counter, $assignment['thread_qualify_max']];
            }
        } else {
            // All students -> get average
            $students = []; // user list, needed to make sure we only
            // take first attempts into account
            $counter = 0;
            $sum = 0;
            $bestResult = 0;
            $weight = 0;
            $sumResult = 0;

            while ($data = Database::fetch_array($scores)) {
                if (!(array_key_exists($data['user_id'], $students))) {
                    if (0 != $assignment['thread_qualify_max']) {
                        $students[$data['user_id']] = $data['qualify'];
                        $counter++;
                        $sum += $data['qualify'] / $assignment['thread_qualify_max'];
                        $sumResult += $data['qualify'];
                        if ($data['qualify'] > $bestResult) {
                            $bestResult = $data['qualify'];
                        }
                        $weight = $assignment['thread_qualify_max'];
                    }
                }
            }

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

    public function needs_name_and_description()
    {
        return false;
    }

    public function needs_max()
    {
        return false;
    }

    public function needs_results()
    {
        return false;
    }

    /**
     * @return string
     */
    public function get_name()
    {
        $this->getThreadData();
        $thread_title = isset($this->exercise_data['thread_title']) ? $this->exercise_data['thread_title'] : '';
        $thread_title_qualify = isset($this->exercise_data['thread_title_qualify']) ? $this->exercise_data['thread_title_qualify'] : '';
        if (isset($thread_title_qualify) && '' != $thread_title_qualify) {
            return $this->exercise_data['thread_title_qualify'];
        }

        return $thread_title;
    }

    /**
     * @return string
     */
    public function get_description()
    {
        return ''; //$this->exercise_data['description'];
    }

    /**
     * Check if this still links to an exercise.
     */
    public function is_valid_link()
    {
        $sessionId = $this->get_session_id();
        $sql = 'SELECT count(iid) FROM '.$this->get_forum_thread_table().'
                WHERE
                    c_id = '.$this->course_id.' AND
                    iid = '.$this->get_ref_id().' AND
                    session_id='.$sessionId;
        $result = Database::query($sql);
        $number = Database::fetch_row($result);

        return 0 != $number[0];
    }

    public function get_link()
    {
        $sessionId = $this->get_session_id();
        $sql = 'SELECT * FROM '.$this->get_forum_thread_table()."
                WHERE
                    c_id = {$this->course_id} AND
                    iid = '".$this->get_ref_id()."' AND
                    session_id = $sessionId ";
        $result = Database::query($sql);
        $row = Database::fetch_array($result, 'ASSOC');

        if ($row) {
            $forum_id = $row['forum_id'];
            return api_get_path(WEB_CODE_PATH).'forum/viewthread.php?'.
                api_get_cidreq_params($this->getCourseId(), $sessionId).
                '&thread='.$this->get_ref_id().'&gradebook=view&forum='.$forum_id;
        }

        return '';
    }

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

    public function save_linked_data()
    {
        $weight = $this->get_weight();
        $ref_id = $this->get_ref_id();

        if (!empty($ref_id)) {
            $sql = 'UPDATE '.$this->get_forum_thread_table().' SET
                    thread_weight='.api_float_val($weight).'
                    WHERE c_id = '.$this->course_id.' AND iid = '.$ref_id;
            Database::query($sql);
        }
    }

    public function delete_linked_data()
    {
        $ref_id = $this->get_ref_id();
        if (!empty($ref_id)) {
            // Cleans forum
            $sql = 'UPDATE '.$this->get_forum_thread_table().' SET
                    thread_qualify_max = 0,
                    thread_weight = 0,
                    thread_title_qualify = ""
                    WHERE c_id = '.$this->course_id.' AND iid = '.$ref_id;
            Database::query($sql);
        }
    }

    /**
     * Lazy load function to get the database table of the student publications.
     */
    private function get_forum_thread_table()
    {
        return $this->forum_thread_table = Database::get_course_table(TABLE_FORUM_THREAD);
    }

    private function getThreadData()
    {
        $sessionId = $this->get_session_id();
        if ($sessionId) {
            $session_condition = 'session_id = '.$sessionId;
        } else {
            $session_condition = '(session_id = 0 OR session_id IS NULL)';
        }

        if (!isset($this->exercise_data)) {
            $sql = 'SELECT * FROM '.$this->get_forum_thread_table().'
                    WHERE
                        c_id = '.$this->course_id.' AND
                        iid = '.$this->get_ref_id().' AND
                        '.$session_condition;
            $query = Database::query($sql);
            $this->exercise_data = Database::fetch_array($query);
        }

        return $this->exercise_data;
    }
}


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			/**
6			* Class ForumThreadLink.
7			*
8			* @author Bert Steppé
9			*/
10			class ForumThreadLink extends AbstractLink
11			{
12			private $forum_thread_table;
13
14			/**
15			* Constructor.
16			*/
17			public function __construct()
18			{
19			parent::__construct();
20			$this->set_type(LINK_FORUM_THREAD);
21			}
22
23			/**
24			* @return string
25			*/
26			public function get_type_name()
27			{
28			return get_lang('Forum threads');
29			}
30
31			/**
32			* @return bool
33			*/
34			public function is_allowed_to_change_name()
35			{
36			return false;
37			}
38
39			/**
40			* Generate an array of all exercises available.
41			*
42			* @return array 2-dimensional array - every element contains 2 subelements (id, name)
43			*/
44			public function get_all_links()
45			{
46			if (empty($this->course_code)) {
47			return [];
48			}
49
50			$tbl_grade_links = Database::get_course_table(TABLE_FORUM_THREAD);
51			$sessionId = $this->get_session_id();
52
53			if ($sessionId) {
54			$session_condition = 'tl.session_id='.$sessionId;
55			} else {
56			$session_condition = '(tl.session_id = 0 OR tl.session_id IS NULL)';
57			}
58
59			$sql = 'SELECT tl.iid as thread_id, tl.thread_title, tl.thread_title_qualify
60			FROM '.$tbl_grade_links.' tl
61			WHERE
62			tl.c_id = '.$this->course_id.' AND
63			'.$session_condition.'
64			';
65
66			$result = Database::query($sql);
67			while ($data = Database::fetch_array($result)) {
68			if (isset($data['thread_title_qualify']) && '' != $data['thread_title_qualify']) {
69			$cats[] = [$data['thread_id'], $data['thread_title_qualify']];
70			} else {
71			$cats[] = [$data['thread_id'], $data['thread_title']];
72			}
73			}
74
75			return isset($cats) ? $cats : [];
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-08-26 12:29 UTC by Report Bug Copy Issue Report The variable `$cats` does not seem to be defined for all execution paths leading up to this point. Loading history...
76			}
77
78			/**
79			* Has anyone done this exercise yet ?
80			*
81			* @return bool
82			*/
83			public function has_results()
84			{
85			$table = Database::get_course_table(TABLE_FORUM_POST);
86
87			$sql = "SELECT count(*) AS number FROM $table
88			WHERE
89			c_id = ".$this->course_id." AND
90			iid = '".$this->get_ref_id()."'
91			";
92			$result = Database::query($sql);
93			$number = Database::fetch_row($result);
94
95			return 0 != $number[0];
96			}
97
98			/**
99			* @param int $studentId
100			* @param string $type
101			*
102			* @return array\|null
103			*/
104			public function calc_score($studentId = null, $type = null)
105			{
106			$threadInfo = $this->getThreadData();
107			$thread_qualify = Database::get_course_table(TABLE_FORUM_THREAD_QUALIFY);
108			$sessionId = $this->get_session_id();
109			$sessionCondition = api_get_session_condition(
110			$sessionId,
111			true,
112			false,
113			'session_id'
114			);
115
116			$sql = 'SELECT thread_qualify_max
117			FROM '.Database::get_course_table(TABLE_FORUM_THREAD)."
118			WHERE
119			c_id = ".$this->course_id." AND
120			iid = '".$this->get_ref_id()."'
121			$sessionCondition
122			";
123			$query = Database::query($sql);
124			$assignment = Database::fetch_array($query);
125
126			$sql = "SELECT * FROM $thread_qualify
127			WHERE
128			c_id = ".$this->course_id." AND
129			iid = ".$this->get_ref_id()."
130			$sessionCondition
131			";
132			if (isset($studentId)) {
133			$sql .= ' AND user_id = '.intval($studentId);
134			}
135
136			// order by id, that way the student's first attempt is accessed first
137			$sql .= ' ORDER BY qualify_time DESC';
138			$scores = Database::query($sql);
139
140			// for 1 student
141			if (isset($studentId)) {
142			if (0 == $threadInfo['thread_peer_qualify']) {
143			// Classic way of calculate score
144			if ($data = Database::fetch_array($scores)) {
145			return [
146			$data['qualify'],
147			$assignment['thread_qualify_max'],
148			];
149			} else {
150			// We sent the 0/thread_qualify_max instead of null for correct calculations
151			return [0, $assignment['thread_qualify_max']];
152			}
153			} else {
154			// Take average
155			$score = 0;
156			$counter = 0;
157			if (Database::num_rows($scores)) {
158			while ($data = Database::fetch_array($scores, 'ASSOC')) {
159			$score += $data['qualify'];
160			$counter++;
161			}
162			}
163			// If no result
164			if (empty($counter) \|\| $counter <= 2) {
165			return [0, $assignment['thread_qualify_max']];
166			}
167
168			return [$score / $counter, $assignment['thread_qualify_max']];
169			}
170			} else {
171			// All students -> get average
172			$students = []; // user list, needed to make sure we only
173			// take first attempts into account
174			$counter = 0;
175			$sum = 0;
176			$bestResult = 0;
177			$weight = 0;
178			$sumResult = 0;
179
180			while ($data = Database::fetch_array($scores)) {
181			if (!(array_key_exists($data['user_id'], $students))) {
182			if (0 != $assignment['thread_qualify_max']) {
183			$students[$data['user_id']] = $data['qualify'];
184			$counter++;
185			$sum += $data['qualify'] / $assignment['thread_qualify_max'];
186			$sumResult += $data['qualify'];
187			if ($data['qualify'] > $bestResult) {
188			$bestResult = $data['qualify'];
189			}
190			$weight = $assignment['thread_qualify_max'];
191			}
192			}
193			}
194
195			if (0 == $counter) {
196			return [null, null];
197			} else {
198			switch ($type) {
199			case 'best':
200			return [$bestResult, $weight];
201			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...
202			case 'average':
203			return [$sumResult / $counter, $weight];
204			break;
205			case 'ranking':
206			return AbstractLink::getCurrentUserRanking($studentId, $students);
207			break;
208			default:
209			return [$sum, $counter];
210			break;
211			}
212			}
213			}
214			}
215
216			public function needs_name_and_description()
217			{
218			return false;
219			}
220
221			public function needs_max()
222			{
223			return false;
224			}
225
226			public function needs_results()
227			{
228			return false;
229			}
230
231			/**
232			* @return string
233			*/
234			public function get_name()
235			{
236			$this->getThreadData();
237			$thread_title = isset($this->exercise_data['thread_title']) ? $this->exercise_data['thread_title'] : '';
238			$thread_title_qualify = isset($this->exercise_data['thread_title_qualify']) ? $this->exercise_data['thread_title_qualify'] : '';
239			if (isset($thread_title_qualify) && '' != $thread_title_qualify) {
240			return $this->exercise_data['thread_title_qualify'];
241			}
242
243			return $thread_title;
244			}
245
246			/**
247			* @return string
248			*/
249			public function get_description()
250			{
251			return ''; //$this->exercise_data['description'];
252			}
253
254			/**
255			* Check if this still links to an exercise.
256			*/
257			public function is_valid_link()
258			{
259			$sessionId = $this->get_session_id();
260			$sql = 'SELECT count(iid) FROM '.$this->get_forum_thread_table().'
261			WHERE
262			c_id = '.$this->course_id.' AND
263			iid = '.$this->get_ref_id().' AND
264			session_id='.$sessionId;
265			$result = Database::query($sql);
266			$number = Database::fetch_row($result);
267
268			return 0 != $number[0];
269			}
270
271			public function get_link()
272			{
273			$sessionId = $this->get_session_id();
274			$sql = 'SELECT * FROM '.$this->get_forum_thread_table()."
275			WHERE
276			c_id = {$this->course_id} AND
277			iid = '".$this->get_ref_id()."' AND
278			session_id = $sessionId ";
279			$result = Database::query($sql);
280			$row = Database::fetch_array($result, 'ASSOC');
281
282			if ($row) {
283			$forum_id = $row['forum_id'];
284			return api_get_path(WEB_CODE_PATH).'forum/viewthread.php?'.
285			api_get_cidreq_params($this->getCourseId(), $sessionId).
286			'&thread='.$this->get_ref_id().'&gradebook=view&forum='.$forum_id;
287			}
288
289			return '';
290			}
291
292			public function get_icon_name()
293			{
294			return 'forum';
295			}
296
297			public function save_linked_data()
298			{
299			$weight = $this->get_weight();
300			$ref_id = $this->get_ref_id();
301
302			if (!empty($ref_id)) {
303			$sql = 'UPDATE '.$this->get_forum_thread_table().' SET
304			thread_weight='.api_float_val($weight).'
305			WHERE c_id = '.$this->course_id.' AND iid = '.$ref_id;
306			Database::query($sql);
307			}
308			}
309
310			public function delete_linked_data()
311			{
312			$ref_id = $this->get_ref_id();
313			if (!empty($ref_id)) {
314			// Cleans forum
315			$sql = 'UPDATE '.$this->get_forum_thread_table().' SET
316			thread_qualify_max = 0,
317			thread_weight = 0,
318			thread_title_qualify = ""
319			WHERE c_id = '.$this->course_id.' AND iid = '.$ref_id;
320			Database::query($sql);
321			}
322			}
323
324			/**
325			* Lazy load function to get the database table of the student publications.
326			*/
327			private function get_forum_thread_table()
328			{
329			return $this->forum_thread_table = Database::get_course_table(TABLE_FORUM_THREAD);
330			}
331
332			private function getThreadData()
333			{
334			$sessionId = $this->get_session_id();
335			if ($sessionId) {
336			$session_condition = 'session_id = '.$sessionId;
337			} else {
338			$session_condition = '(session_id = 0 OR session_id IS NULL)';
339			}
340
341			if (!isset($this->exercise_data)) {
342			$sql = 'SELECT * FROM '.$this->get_forum_thread_table().'
343			WHERE
344			c_id = '.$this->course_id.' AND
345			iid = '.$this->get_ref_id().' AND
346			'.$session_condition;
347			$query = Database::query($sql);
348			$this->exercise_data = Database::fetch_array($query);
349			}
350
351			return $this->exercise_data;
352			}
353			}
354

chamilo / chamilo-lms

Push — master ( 48aeb9...852133 )

ForumThreadLink::getThreadData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like