HotpotatoesExerciseResult::exportCompleteReportXLS() - Code Metrics - Inspection of "Use autowire in repositories, convert CDocumentRep..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 76abd2...ab5d59 )

by Julito

created 2018-11-14 14:39 UTC

exportCompleteReportXLS() D

↳ Parent: HotpotatoesExerciseResult

Complexity

Conditions	14
Paths	252

Size

Total Lines	130
Code Lines	84

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	14
eloc	84
nc	252
nop	6
dl	0
loc	130
rs	4.1757
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/* For licensing terms, see /license.txt */

/**
 * Class HotpotatoesExerciseResult
 * Allows you to export exercises results in multiple presentation forms.
 *
 * @package chamilo.exercise
 */
class HotpotatoesExerciseResult
{
    //stores the list of exercises
    private $exercises_list = [];


    //stores the results
    private $results = [];

    /**
     * Gets the results of all students (or just one student if access is limited).
     *
     * @param string $document_path The document path (for HotPotatoes retrieval)
     * @param    int        User ID. Optional. If no user ID is provided, we take all the results. Defauts to null
     *
     * @return bool
     */
    public function getExercisesReporting($document_path, $hotpotato_name)
    {
        $return = [];
        $TBL_USER = Database::get_main_table(TABLE_MAIN_USER);
        $TBL_TRACK_HOTPOTATOES = Database::get_main_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
        $course_id = api_get_course_int_id();
        $user_id = null;
        $session_id_and = ' AND te.session_id = '.api_get_session_id().' ';
        $hotpotato_name = Database::escape_string($hotpotato_name);

        if (!empty($exercise_id)) {

            $session_id_and .= " AND exe_exo_id = $exercise_id ";
        }

        if (empty($user_id)) {
            $sql = "SELECT firstname as userpart1, lastname as userpart2 ,
                    email,
                    tth.exe_name,
                    tth.score,
                    tth.max_score,
                    tth.exe_date
                    FROM $TBL_TRACK_HOTPOTATOES tth, $TBL_USER tu
                    WHERE   tu.user_id=tth.exe_user_id AND
                            tth.c_id = $course_id AND
                            tth.exe_name = '$hotpotato_name'
                    ORDER BY tth.c_id ASC, tth.exe_date ASC";
        } else {
            // get only this user's results
            $sql = "SELECT '', exe_name, score, max_score, exe_date
                    FROM $TBL_TRACK_HOTPOTATOES
                    WHERE
                        exe_user_id = '".$user_id."' AND
                        c_id = $course_id AND
                        tth.exe_name = '$hotpotato_name'
                    ORDER BY c_id ASC, exe_date ASC";
        }

        $results = [];

        $resx = Database::query($sql);
        while ($rowx = Database::fetch_array($resx, 'ASSOC')) {
            $results[] = $rowx;
        }

        $hpresults = [];
        $resx = Database::query($sql);
        while ($rowx = Database::fetch_array($resx, 'ASSOC')) {
            $hpresults[] = $rowx;
        }

        // Print the Result of Hotpotatoes Tests
        if (is_array($hpresults)) {
            for ($i = 0; $i < sizeof($hpresults); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $return[$i] = [];
                $title = GetQuizName($hpresults[$i]['exe_name'], $document_path);
                if ($title == '') {
                    $title = basename($hpresults[$i]['exe_name']);
                }
                if (empty($user_id)) {
                    $return[$i]['email'] = $hpresults[$i]['email'];
                    $return[$i]['first_name'] = $hpresults[$i]['userpart1'];
                    $return[$i]['last_name'] = $hpresults[$i]['userpart2'];
                }
                $return[$i]['title'] = $title;
                $return[$i]['exe_date'] = $hpresults[$i]['exe_date'];

                $return[$i]['result'] = $hpresults[$i]['score'];
                $return[$i]['max'] = $hpresults[$i]['max_score'];
            }
        }
        $this->results = $return;

        return true;
    }

    /**
     * Exports the complete report as a CSV file.
     *
     * @param string $document_path  Document path inside the document tool
     * @param string $hotpotato_name
     *
     * @return bool False on error
     */
    public function exportCompleteReportCSV($document_path = '', $hotpotato_name = '')
    {
        global $charset;
        $this->getExercisesReporting($document_path, $hotpotato_name);
        $filename = 'exercise_results_'.date('YmdGis').'.csv';
        if (!empty($user_id)) {

            $filename = 'exercise_results_user_'.$user_id.'_'.date('YmdGis').'.csv';
        }
        $data = '';

        if (api_is_western_name_order()) {
            if (!empty($this->results[0]['first_name'])) {
                $data .= get_lang('FirstName').';';
            }
            if (!empty($this->results[0]['last_name'])) {
                $data .= get_lang('LastName').';';
            }
        } else {
            if (!empty($this->results[0]['last_name'])) {
                $data .= get_lang('LastName').';';
            }
            if (!empty($this->results[0]['first_name'])) {
                $data .= get_lang('FirstName').';';
            }
        }
        $data .= get_lang('Email').';';
        $data .= get_lang('Title').';';
        $data .= get_lang('StartDate').';';
        $data .= get_lang('Score').';';
        $data .= get_lang('Total').';';
        $data .= "\n";

        // Results
        foreach ($this->results as $row) {
            if (api_is_western_name_order()) {
                $data .= str_replace("\r\n", '  ', api_html_entity_decode(strip_tags($row['first_name']), ENT_QUOTES, $charset)).';';
                $data .= str_replace("\r\n", '  ', api_html_entity_decode(strip_tags($row['last_name']), ENT_QUOTES, $charset)).';';
            } else {
                $data .= str_replace("\r\n", '  ', api_html_entity_decode(strip_tags($row['last_name']), ENT_QUOTES, $charset)).';';
                $data .= str_replace("\r\n", '  ', api_html_entity_decode(strip_tags($row['first_name']), ENT_QUOTES, $charset)).';';
            }

            $data .= str_replace("\r\n", '  ', api_html_entity_decode(strip_tags($row['email']), ENT_QUOTES, $charset)).';';
            $data .= str_replace("\r\n", '  ', api_html_entity_decode(strip_tags($row['title']), ENT_QUOTES, $charset)).';';
            $data .= str_replace("\r\n", '  ', $row['exe_date']).';';
            $data .= str_replace("\r\n", '  ', $row['result']).';';
            $data .= str_replace("\r\n", '  ', $row['max']).';';
            $data .= "\n";
        }

        //output the results
        $len = strlen($data);
        header('Content-type: application/octet-stream');
        header('Content-Type: application/force-download');
        header('Content-length: '.$len);
        if (preg_match("/MSIE 5.5/", $_SERVER['HTTP_USER_AGENT'])) {
            header('Content-Disposition: filename= '.$filename);
        } else {
            header('Content-Disposition: attachment; filename= '.$filename);
        }
        if (strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE')) {
            header('Pragma: ');
            header('Cache-Control: ');
            header('Cache-Control: public'); // IE cannot download from sessions without a cache
        }
        header('Content-Description: '.$filename);
        header('Content-transfer-encoding: binary');
        // @todo add this utf-8 header for all csv files
        echo "\xEF\xBB\xBF"; // force utf-8 header of csv file
        echo $data;

        return true;
    }

    /**
     * Exports the complete report as an XLS file.
     *
     * @param string $document_path
     * @param null   $user_id

     * @param bool   $export_user_fields
     * @param int    $export_filter
     * @param int    $exercise_id
     * @param null   $hotpotato_name

     *
     * @return bool
     */
    public function exportCompleteReportXLS(
        $document_path = '',
        $user_id = null,
        $export_user_fields = false,
        $export_filter = 0,
        $exercise_id = 0,
        $hotpotato_name = null
    ) {
        global $charset;
        $this->getExercisesReporting(
            $document_path,
            $user_id,
            $export_filter,
            $exercise_id,
            $hotpotato_name
        );
        $filename = 'exercise_results_'.api_get_local_time();
        if (!empty($user_id)) {
            $filename = 'exercise_results_user_'.$user_id.'_'.api_get_local_time();
        }

        // check if exists column 'user'
        $withColumnUser = false;
        foreach ($this->results as $result) {
            if (!empty($result['last_name']) && !empty($result['first_name'])) {
                $withColumnUser = true;
                break;
            }
        }
        $list = [];
        if ($withColumnUser) {
            $list[0][] = get_lang('Email');
            if (api_is_western_name_order()) {
                $list[0][] = get_lang('FirstName');
                $list[0][] = get_lang('LastName');
            } else {
                $list[0][] = get_lang('LastName');
                $list[0][] = get_lang('FirstName');
            }
        }

        if ($export_user_fields) {
            //show user fields section with a big th colspan that spans over all fields
            $extra_user_fields = UserManager::get_extra_fields(
                0,
                1000,
                5,
                'ASC',
                false,
                1
            );

            //show the fields names for user fields
            foreach ($extra_user_fields as $field) {
                $list[0][] = api_html_entity_decode(
                    strip_tags($field[3]),
                    ENT_QUOTES,
                    $charset
                );
            }
        }

        $list[0][] = get_lang('Title');
        $list[0][] = get_lang('StartDate');
        $list[0][] = get_lang('EndDate');
        $list[0][] = get_lang('Duration').' ('.get_lang('MinMinutes').')';
        $list[0][] = get_lang('Score');
        $list[0][] = get_lang('Total');
        $list[0][] = get_lang('Status');

        $column = 1;
        foreach ($this->results as $row) {
            if ($withColumnUser) {
                $list[$column][] = api_html_entity_decode(
                    strip_tags($row['email']),
                    ENT_QUOTES,
                    $charset
                );

                if (api_is_western_name_order()) {
                    $list[$column][] = api_html_entity_decode(
                        strip_tags($row['first_name']),
                        ENT_QUOTES,
                        $charset
                    );
                    $list[$column][] = api_html_entity_decode(
                        strip_tags($row['last_name']),
                        ENT_QUOTES,
                        $charset
                    );
                } else {
                    $list[$column][] = api_html_entity_decode(
                        strip_tags($row['last_name']),
                        ENT_QUOTES,
                        $charset
                    );
                    $list[$column][] = api_html_entity_decode(
                        strip_tags($row['first_name']),
                        ENT_QUOTES,
                        $charset
                    );
                }
            }

            if ($export_user_fields) {
                //show user fields data, if any, for this user
                $values = UserManager::get_extra_user_data(
                    $row['user_id'],
                    false,
                    false,
                    false,
                    true
                );
                foreach ($values as $value) {
                    $list[$column][] = api_html_entity_decode(strip_tags($value), ENT_QUOTES, $charset);
                }
            }

            $list[$column][] = api_html_entity_decode(strip_tags($row['title']), ENT_QUOTES, $charset);
            $list[$column][] = $row['start_date'];
            $list[$column][] = $row['end_date'];
            $list[$column][] = $row['duration'];
            $list[$column][] = $row['result'];
            $list[$column][] = $row['max'];
            $list[$column][] = $row['status'];
        }

        Export::arrayToXls($list, $filename);

        return true;
    }
}


1			<?php
2			/* For licensing terms, see /license.txt */
3
4			/**
5			* Class HotpotatoesExerciseResult
6			* Allows you to export exercises results in multiple presentation forms.
7			*
8			* @package chamilo.exercise
9			*/
10			class HotpotatoesExerciseResult
11			{
12			//stores the list of exercises
13			private $exercises_list = [];
			0 ignored issues – show introduced 2018-01-05 13:33 UTC by Report Bug Copy Issue Report The private property `$exercises_list` is not used, and could be removed. Loading history...
14
15			//stores the results
16			private $results = [];
17
18			/**
19			* Gets the results of all students (or just one student if access is limited).
20			*
21			* @param string $document_path The document path (for HotPotatoes retrieval)
22			* @param int User ID. Optional. If no user ID is provided, we take all the results. Defauts to null
23			*
24			* @return bool
25			*/
26			public function getExercisesReporting($document_path, $hotpotato_name)
27			{
28			$return = [];
29			$TBL_USER = Database::get_main_table(TABLE_MAIN_USER);
30			$TBL_TRACK_HOTPOTATOES = Database::get_main_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
31			$course_id = api_get_course_int_id();
32			$user_id = null;
33			$session_id_and = ' AND te.session_id = '.api_get_session_id().' ';
34			$hotpotato_name = Database::escape_string($hotpotato_name);
35
36			if (!empty($exercise_id)) {
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-01-05 13:33 UTC by Report Bug Copy Issue Report The variable `$exercise_id` seems to never exist and therefore `empty` should always be `true`. Loading history...
37			$session_id_and .= " AND exe_exo_id = $exercise_id ";
38			}
39
40			if (empty($user_id)) {
41			$sql = "SELECT firstname as userpart1, lastname as userpart2 ,
42			email,
43			tth.exe_name,
44			tth.score,
45			tth.max_score,
46			tth.exe_date
47			FROM $TBL_TRACK_HOTPOTATOES tth, $TBL_USER tu
48			WHERE tu.user_id=tth.exe_user_id AND
49			tth.c_id = $course_id AND
50			tth.exe_name = '$hotpotato_name'
51			ORDER BY tth.c_id ASC, tth.exe_date ASC";
52			} else {
53			// get only this user's results
54			$sql = "SELECT '', exe_name, score, max_score, exe_date
55			FROM $TBL_TRACK_HOTPOTATOES
56			WHERE
57			exe_user_id = '".$user_id."' AND
58			c_id = $course_id AND
59			tth.exe_name = '$hotpotato_name'
60			ORDER BY c_id ASC, exe_date ASC";
61			}
62
63			$results = [];
64
65			$resx = Database::query($sql);
66			while ($rowx = Database::fetch_array($resx, 'ASSOC')) {
67			$results[] = $rowx;
68			}
69
70			$hpresults = [];
71			$resx = Database::query($sql);
72			while ($rowx = Database::fetch_array($resx, 'ASSOC')) {
73			$hpresults[] = $rowx;
74			}
75
76			// Print the Result of Hotpotatoes Tests
77			if (is_array($hpresults)) {
78			for ($i = 0; $i < sizeof($hpresults); $i++) {
			0 ignored issues – show Performance Best Practice introduced 2018-01-05 13:33 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `sizeof()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
79			$return[$i] = [];
80			$title = GetQuizName($hpresults[$i]['exe_name'], $document_path);
81			if ($title == '') {
82			$title = basename($hpresults[$i]['exe_name']);
83			}
84			if (empty($user_id)) {
85			$return[$i]['email'] = $hpresults[$i]['email'];
86			$return[$i]['first_name'] = $hpresults[$i]['userpart1'];
87			$return[$i]['last_name'] = $hpresults[$i]['userpart2'];
88			}
89			$return[$i]['title'] = $title;
90			$return[$i]['exe_date'] = $hpresults[$i]['exe_date'];
91
92			$return[$i]['result'] = $hpresults[$i]['score'];
93			$return[$i]['max'] = $hpresults[$i]['max_score'];
94			}
95			}
96			$this->results = $return;
97
98			return true;
99			}
100
101			/**
102			* Exports the complete report as a CSV file.
103			*
104			* @param string $document_path Document path inside the document tool
105			* @param string $hotpotato_name
106			*
107			* @return bool False on error
108			*/
109			public function exportCompleteReportCSV($document_path = '', $hotpotato_name = '')
110			{
111			global $charset;
112			$this->getExercisesReporting($document_path, $hotpotato_name);
113			$filename = 'exercise_results_'.date('YmdGis').'.csv';
114			if (!empty($user_id)) {
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-01-05 13:33 UTC by Report Bug Copy Issue Report The variable `$user_id` seems to never exist and therefore `empty` should always be `true`. Loading history...
115			$filename = 'exercise_results_user_'.$user_id.'_'.date('YmdGis').'.csv';
116			}
117			$data = '';
118
119			if (api_is_western_name_order()) {
120			if (!empty($this->results[0]['first_name'])) {
121			$data .= get_lang('FirstName').';';
122			}
123			if (!empty($this->results[0]['last_name'])) {
124			$data .= get_lang('LastName').';';
125			}
126			} else {
127			if (!empty($this->results[0]['last_name'])) {
128			$data .= get_lang('LastName').';';
129			}
130			if (!empty($this->results[0]['first_name'])) {
131			$data .= get_lang('FirstName').';';
132			}
133			}
134			$data .= get_lang('Email').';';
135			$data .= get_lang('Title').';';
136			$data .= get_lang('StartDate').';';
137			$data .= get_lang('Score').';';
138			$data .= get_lang('Total').';';
139			$data .= "\n";
140
141			// Results
142			foreach ($this->results as $row) {
143			if (api_is_western_name_order()) {
144			$data .= str_replace("\r\n", ' ', api_html_entity_decode(strip_tags($row['first_name']), ENT_QUOTES, $charset)).';';
145			$data .= str_replace("\r\n", ' ', api_html_entity_decode(strip_tags($row['last_name']), ENT_QUOTES, $charset)).';';
146			} else {
147			$data .= str_replace("\r\n", ' ', api_html_entity_decode(strip_tags($row['last_name']), ENT_QUOTES, $charset)).';';
148			$data .= str_replace("\r\n", ' ', api_html_entity_decode(strip_tags($row['first_name']), ENT_QUOTES, $charset)).';';
149			}
150
151			$data .= str_replace("\r\n", ' ', api_html_entity_decode(strip_tags($row['email']), ENT_QUOTES, $charset)).';';
152			$data .= str_replace("\r\n", ' ', api_html_entity_decode(strip_tags($row['title']), ENT_QUOTES, $charset)).';';
153			$data .= str_replace("\r\n", ' ', $row['exe_date']).';';
154			$data .= str_replace("\r\n", ' ', $row['result']).';';
155			$data .= str_replace("\r\n", ' ', $row['max']).';';
156			$data .= "\n";
157			}
158
159			//output the results
160			$len = strlen($data);
161			header('Content-type: application/octet-stream');
162			header('Content-Type: application/force-download');
163			header('Content-length: '.$len);
164			if (preg_match("/MSIE 5.5/", $_SERVER['HTTP_USER_AGENT'])) {
165			header('Content-Disposition: filename= '.$filename);
166			} else {
167			header('Content-Disposition: attachment; filename= '.$filename);
168			}
169			if (strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE')) {
170			header('Pragma: ');
171			header('Cache-Control: ');
172			header('Cache-Control: public'); // IE cannot download from sessions without a cache
173			}
174			header('Content-Description: '.$filename);
175			header('Content-transfer-encoding: binary');
176			// @todo add this utf-8 header for all csv files
177			echo "\xEF\xBB\xBF"; // force utf-8 header of csv file
178			echo $data;
179
180			return true;
181			}
182
183			/**
184			* Exports the complete report as an XLS file.
185			*
186			* @param string $document_path
187			* @param null $user_id
			0 ignored issues – show Documentation Bug introduced 2018-01-05 13:33 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$user_id` is correct as it would always require `null` to be passed? Loading history...
188			* @param bool $export_user_fields
189			* @param int $export_filter
190			* @param int $exercise_id
191			* @param null $hotpotato_name
			0 ignored issues – show Documentation Bug introduced 2018-05-24 14:18 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$hotpotato_name` is correct as it would always require `null` to be passed? Loading history...
192			*
193			* @return bool
194			*/
195			public function exportCompleteReportXLS(
196			$document_path = '',
197			$user_id = null,
198			$export_user_fields = false,
199			$export_filter = 0,
200			$exercise_id = 0,
201			$hotpotato_name = null
202			) {
203			global $charset;
204			$this->getExercisesReporting(
205			$document_path,
206			$user_id,
207			$export_filter,
208			$exercise_id,
209			$hotpotato_name
210			);
211			$filename = 'exercise_results_'.api_get_local_time();
212			if (!empty($user_id)) {
213			$filename = 'exercise_results_user_'.$user_id.'_'.api_get_local_time();
214			}
215
216			// check if exists column 'user'
217			$withColumnUser = false;
218			foreach ($this->results as $result) {
219			if (!empty($result['last_name']) && !empty($result['first_name'])) {
220			$withColumnUser = true;
221			break;
222			}
223			}
224			$list = [];
225			if ($withColumnUser) {
226			$list[0][] = get_lang('Email');
227			if (api_is_western_name_order()) {
228			$list[0][] = get_lang('FirstName');
229			$list[0][] = get_lang('LastName');
230			} else {
231			$list[0][] = get_lang('LastName');
232			$list[0][] = get_lang('FirstName');
233			}
234			}
235
236			if ($export_user_fields) {
237			//show user fields section with a big th colspan that spans over all fields
238			$extra_user_fields = UserManager::get_extra_fields(
239			0,
240			1000,
241			5,
242			'ASC',
243			false,
244			1
245			);
246
247			//show the fields names for user fields
248			foreach ($extra_user_fields as $field) {
249			$list[0][] = api_html_entity_decode(
250			strip_tags($field[3]),
251			ENT_QUOTES,
252			$charset
253			);
254			}
255			}
256
257			$list[0][] = get_lang('Title');
258			$list[0][] = get_lang('StartDate');
259			$list[0][] = get_lang('EndDate');
260			$list[0][] = get_lang('Duration').' ('.get_lang('MinMinutes').')';
261			$list[0][] = get_lang('Score');
262			$list[0][] = get_lang('Total');
263			$list[0][] = get_lang('Status');
264
265			$column = 1;
266			foreach ($this->results as $row) {
267			if ($withColumnUser) {
268			$list[$column][] = api_html_entity_decode(
269			strip_tags($row['email']),
270			ENT_QUOTES,
271			$charset
272			);
273
274			if (api_is_western_name_order()) {
275			$list[$column][] = api_html_entity_decode(
276			strip_tags($row['first_name']),
277			ENT_QUOTES,
278			$charset
279			);
280			$list[$column][] = api_html_entity_decode(
281			strip_tags($row['last_name']),
282			ENT_QUOTES,
283			$charset
284			);
285			} else {
286			$list[$column][] = api_html_entity_decode(
287			strip_tags($row['last_name']),
288			ENT_QUOTES,
289			$charset
290			);
291			$list[$column][] = api_html_entity_decode(
292			strip_tags($row['first_name']),
293			ENT_QUOTES,
294			$charset
295			);
296			}
297			}
298
299			if ($export_user_fields) {
300			//show user fields data, if any, for this user
301			$values = UserManager::get_extra_user_data(
302			$row['user_id'],
303			false,
304			false,
305			false,
306			true
307			);
308			foreach ($values as $value) {
309			$list[$column][] = api_html_entity_decode(strip_tags($value), ENT_QUOTES, $charset);
310			}
311			}
312
313			$list[$column][] = api_html_entity_decode(strip_tags($row['title']), ENT_QUOTES, $charset);
314			$list[$column][] = $row['start_date'];
315			$list[$column][] = $row['end_date'];
316			$list[$column][] = $row['duration'];
317			$list[$column][] = $row['result'];
318			$list[$column][] = $row['max'];
319			$list[$column][] = $row['status'];
320			}
321
322			Export::arrayToXls($list, $filename);
323
324			return true;
325			}
326			}
327

chamilo / chamilo-lms

Push — master ( 76abd2...ab5d59 )

exportCompleteReportXLS() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like