e2c4b7f2c5e049a606189f299d0ef4775c7d19d5
[moodle.git] / lib / tablelib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package    core
20  * @subpackage lib
21  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
26 defined('MOODLE_INTERNAL') || die();
28 /**#@+
29  * These constants relate to the table's handling of URL parameters.
30  */
31 define('TABLE_VAR_SORT',   1);
32 define('TABLE_VAR_HIDE',   2);
33 define('TABLE_VAR_SHOW',   3);
34 define('TABLE_VAR_IFIRST', 4);
35 define('TABLE_VAR_ILAST',  5);
36 define('TABLE_VAR_PAGE',   6);
37 define('TABLE_VAR_RESET',  7);
38 /**#@-*/
40 /**#@+
41  * Constants that indicate whether the paging bar for the table
42  * appears above or below the table.
43  */
44 define('TABLE_P_TOP',    1);
45 define('TABLE_P_BOTTOM', 2);
46 /**#@-*/
49 /**
50  * @package   moodlecore
51  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
52  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
53  */
54 class flexible_table {
56     var $uniqueid        = NULL;
57     var $attributes      = array();
58     var $headers         = array();
60     /**
61      * @var string For create header with help icon.
62      */
63     private $helpforheaders = array();
64     var $columns         = array();
65     var $column_style    = array();
66     var $column_class    = array();
67     var $column_suppress = array();
68     var $column_nosort   = array('userpic');
69     private $column_textsort = array();
70     var $setup           = false;
71     var $baseurl         = NULL;
72     var $request         = array();
74     /**
75      * @var bool Whether or not to store table properties in the user_preferences table.
76      */
77     private $persistent = false;
78     var $is_collapsible = false;
79     var $is_sortable    = false;
80     var $use_pages      = false;
81     var $use_initials   = false;
83     var $maxsortkeys = 2;
84     var $pagesize    = 30;
85     var $currpage    = 0;
86     var $totalrows   = 0;
87     var $currentrow  = 0;
88     var $sort_default_column = NULL;
89     var $sort_default_order  = SORT_ASC;
91     /**
92      * Array of positions in which to display download controls.
93      */
94     var $showdownloadbuttonsat= array(TABLE_P_TOP);
96     /**
97      * @var string Key of field returned by db query that is the id field of the
98      * user table or equivalent.
99      */
100     public $useridfield = 'id';
102     /**
103      * @var string which download plugin to use. Default '' means none - print
104      * html table with paging. Property set by is_downloading which typically
105      * passes in cleaned data from $
106      */
107     var $download  = '';
109     /**
110      * @var bool whether data is downloadable from table. Determines whether
111      * to display download buttons. Set by method downloadable().
112      */
113     var $downloadable = false;
115     /**
116      * @var string which download plugin to use. Default '' means none - print
117      * html table with paging.
118      */
119     var $defaultdownloadformat  = 'csv';
121     /**
122      * @var bool Has start output been called yet?
123      */
124     var $started_output = false;
126     var $exportclass = null;
128     /**
129      * @var array For storing user-customised table properties in the user_preferences db table.
130      */
131     private $prefs = array();
133     /**
134      * Constructor
135      * @param int $uniqueid all tables have to have a unique id, this is used
136      *      as a key when storing table properties like sort order in the session.
137      */
138     function __construct($uniqueid) {
139         $this->uniqueid = $uniqueid;
140         $this->request  = array(
141             TABLE_VAR_SORT   => 'tsort',
142             TABLE_VAR_HIDE   => 'thide',
143             TABLE_VAR_SHOW   => 'tshow',
144             TABLE_VAR_IFIRST => 'tifirst',
145             TABLE_VAR_ILAST  => 'tilast',
146             TABLE_VAR_PAGE   => 'page',
147             TABLE_VAR_RESET  => 'treset'
148         );
149     }
151     /**
152      * Call this to pass the download type. Use :
153      *         $download = optional_param('download', '', PARAM_ALPHA);
154      * To get the download type. We assume that if you call this function with
155      * params that this table's data is downloadable, so we call is_downloadable
156      * for you (even if the param is '', which means no download this time.
157      * Also you can call this method with no params to get the current set
158      * download type.
159      * @param string $download download type. One of csv, tsv, xhtml, ods, etc
160      * @param string $filename filename for downloads without file extension.
161      * @param string $sheettitle title for downloaded data.
162      * @return string download type.  One of csv, tsv, xhtml, ods, etc
163      */
164     function is_downloading($download = null, $filename='', $sheettitle='') {
165         if ($download!==null) {
166             $this->sheettitle = $sheettitle;
167             $this->is_downloadable(true);
168             $this->download = $download;
169             $this->filename = clean_filename($filename);
170             $this->export_class_instance();
171         }
172         return $this->download;
173     }
175     /**
176      * Get, and optionally set, the export class.
177      * @param $exportclass (optional) if passed, set the table to use this export class.
178      * @return table_default_export_format_parent the export class in use (after any set).
179      */
180     function export_class_instance($exportclass = null) {
181         if (!is_null($exportclass)) {
182             $this->started_output = true;
183             $this->exportclass = $exportclass;
184             $this->exportclass->table = $this;
185         } else if (is_null($this->exportclass) && !empty($this->download)) {
186             $classname = 'table_'.$this->download.'_export_format';
187             $this->exportclass = new $classname($this);
188             if (!$this->exportclass->document_started()) {
189                 $this->exportclass->start_document($this->filename);
190             }
191         }
192         return $this->exportclass;
193     }
195     /**
196      * Probably don't need to call this directly. Calling is_downloading with a
197      * param automatically sets table as downloadable.
198      *
199      * @param bool $downloadable optional param to set whether data from
200      * table is downloadable. If ommitted this function can be used to get
201      * current state of table.
202      * @return bool whether table data is set to be downloadable.
203      */
204     function is_downloadable($downloadable = null) {
205         if ($downloadable !== null) {
206             $this->downloadable = $downloadable;
207         }
208         return $this->downloadable;
209     }
211     /**
212      * Call with boolean true to store table layout changes in the user_preferences table.
213      * Note: user_preferences.value has a maximum length of 1333 characters.
214      * Call with no parameter to get current state of table persistence.
215      *
216      * @param bool $persistent Optional parameter to set table layout persistence.
217      * @return bool Whether or not the table layout preferences will persist.
218      */
219     public function is_persistent($persistent = null) {
220         if ($persistent == true) {
221             $this->persistent = true;
222         }
223         return $this->persistent;
224     }
226     /**
227      * Where to show download buttons.
228      * @param array $showat array of postions in which to show download buttons.
229      * Containing TABLE_P_TOP and/or TABLE_P_BOTTOM
230      */
231     function show_download_buttons_at($showat) {
232         $this->showdownloadbuttonsat = $showat;
233     }
235     /**
236      * Sets the is_sortable variable to the given boolean, sort_default_column to
237      * the given string, and the sort_default_order to the given integer.
238      * @param bool $bool
239      * @param string $defaultcolumn
240      * @param int $defaultorder
241      * @return void
242      */
243     function sortable($bool, $defaultcolumn = NULL, $defaultorder = SORT_ASC) {
244         $this->is_sortable = $bool;
245         $this->sort_default_column = $defaultcolumn;
246         $this->sort_default_order  = $defaultorder;
247     }
249     /**
250      * Use text sorting functions for this column (required for text columns with Oracle).
251      * Be warned that you cannot use this with column aliases. You can only do this
252      * with real columns. See MDL-40481 for an example.
253      * @param string column name
254      */
255     function text_sorting($column) {
256         $this->column_textsort[] = $column;
257     }
259     /**
260      * Do not sort using this column
261      * @param string column name
262      */
263     function no_sorting($column) {
264         $this->column_nosort[] = $column;
265     }
267     /**
268      * Is the column sortable?
269      * @param string column name, null means table
270      * @return bool
271      */
272     function is_sortable($column = null) {
273         if (empty($column)) {
274             return $this->is_sortable;
275         }
276         if (!$this->is_sortable) {
277             return false;
278         }
279         return !in_array($column, $this->column_nosort);
280     }
282     /**
283      * Sets the is_collapsible variable to the given boolean.
284      * @param bool $bool
285      * @return void
286      */
287     function collapsible($bool) {
288         $this->is_collapsible = $bool;
289     }
291     /**
292      * Sets the use_pages variable to the given boolean.
293      * @param bool $bool
294      * @return void
295      */
296     function pageable($bool) {
297         $this->use_pages = $bool;
298     }
300     /**
301      * Sets the use_initials variable to the given boolean.
302      * @param bool $bool
303      * @return void
304      */
305     function initialbars($bool) {
306         $this->use_initials = $bool;
307     }
309     /**
310      * Sets the pagesize variable to the given integer, the totalrows variable
311      * to the given integer, and the use_pages variable to true.
312      * @param int $perpage
313      * @param int $total
314      * @return void
315      */
316     function pagesize($perpage, $total) {
317         $this->pagesize  = $perpage;
318         $this->totalrows = $total;
319         $this->use_pages = true;
320     }
322     /**
323      * Assigns each given variable in the array to the corresponding index
324      * in the request class variable.
325      * @param array $variables
326      * @return void
327      */
328     function set_control_variables($variables) {
329         foreach ($variables as $what => $variable) {
330             if (isset($this->request[$what])) {
331                 $this->request[$what] = $variable;
332             }
333         }
334     }
336     /**
337      * Gives the given $value to the $attribute index of $this->attributes.
338      * @param string $attribute
339      * @param mixed $value
340      * @return void
341      */
342     function set_attribute($attribute, $value) {
343         $this->attributes[$attribute] = $value;
344     }
346     /**
347      * What this method does is set the column so that if the same data appears in
348      * consecutive rows, then it is not repeated.
349      *
350      * For example, in the quiz overview report, the fullname column is set to be suppressed, so
351      * that when one student has made multiple attempts, their name is only printed in the row
352      * for their first attempt.
353      * @param int $column the index of a column.
354      */
355     function column_suppress($column) {
356         if (isset($this->column_suppress[$column])) {
357             $this->column_suppress[$column] = true;
358         }
359     }
361     /**
362      * Sets the given $column index to the given $classname in $this->column_class.
363      * @param int $column
364      * @param string $classname
365      * @return void
366      */
367     function column_class($column, $classname) {
368         if (isset($this->column_class[$column])) {
369             $this->column_class[$column] = ' '.$classname; // This space needed so that classnames don't run together in the HTML
370         }
371     }
373     /**
374      * Sets the given $column index and $property index to the given $value in $this->column_style.
375      * @param int $column
376      * @param string $property
377      * @param mixed $value
378      * @return void
379      */
380     function column_style($column, $property, $value) {
381         if (isset($this->column_style[$column])) {
382             $this->column_style[$column][$property] = $value;
383         }
384     }
386     /**
387      * Sets all columns' $propertys to the given $value in $this->column_style.
388      * @param int $property
389      * @param string $value
390      * @return void
391      */
392     function column_style_all($property, $value) {
393         foreach (array_keys($this->columns) as $column) {
394             $this->column_style[$column][$property] = $value;
395         }
396     }
398     /**
399      * Sets $this->baseurl.
400      * @param moodle_url|string $url the url with params needed to call up this page
401      */
402     function define_baseurl($url) {
403         $this->baseurl = new moodle_url($url);
404     }
406     /**
407      * @param array $columns an array of identifying names for columns. If
408      * columns are sorted then column names must correspond to a field in sql.
409      */
410     function define_columns($columns) {
411         $this->columns = array();
412         $this->column_style = array();
413         $this->column_class = array();
414         $colnum = 0;
416         foreach ($columns as $column) {
417             $this->columns[$column]         = $colnum++;
418             $this->column_style[$column]    = array();
419             $this->column_class[$column]    = '';
420             $this->column_suppress[$column] = false;
421         }
422     }
424     /**
425      * @param array $headers numerical keyed array of displayed string titles
426      * for each column.
427      */
428     function define_headers($headers) {
429         $this->headers = $headers;
430     }
432     /**
433      * Defines a help icon for the header
434      *
435      * Always use this function if you need to create header with sorting and help icon.
436      *
437      * @param renderable[] $helpicons An array of renderable objects to be used as help icons
438      */
439     public function define_help_for_headers($helpicons) {
440         $this->helpforheaders = $helpicons;
441     }
443     /**
444      * Must be called after table is defined. Use methods above first. Cannot
445      * use functions below till after calling this method.
446      * @return type?
447      */
448     function setup() {
449         global $SESSION;
451         if (empty($this->columns) || empty($this->uniqueid)) {
452             return false;
453         }
455         // Load any existing user preferences.
456         if ($this->persistent) {
457             $this->prefs = json_decode(get_user_preferences('flextable_' . $this->uniqueid), true);
458         } else if (isset($SESSION->flextable[$this->uniqueid])) {
459             $this->prefs = $SESSION->flextable[$this->uniqueid];
460         }
462         // Set up default preferences if needed.
463         if (!$this->prefs or optional_param($this->request[TABLE_VAR_RESET], false, PARAM_BOOL)) {
464             $this->prefs = array(
465                 'collapse' => array(),
466                 'sortby'   => array(),
467                 'i_first'  => '',
468                 'i_last'   => '',
469                 'textsort' => $this->column_textsort,
470             );
471         }
472         $oldprefs = $this->prefs;
474         if (($showcol = optional_param($this->request[TABLE_VAR_SHOW], '', PARAM_ALPHANUMEXT)) &&
475                 isset($this->columns[$showcol])) {
476             $this->prefs['collapse'][$showcol] = false;
478         } else if (($hidecol = optional_param($this->request[TABLE_VAR_HIDE], '', PARAM_ALPHANUMEXT)) &&
479                 isset($this->columns[$hidecol])) {
480             $this->prefs['collapse'][$hidecol] = true;
481             if (array_key_exists($hidecol, $this->prefs['sortby'])) {
482                 unset($this->prefs['sortby'][$hidecol]);
483             }
484         }
486         // Now, update the column attributes for collapsed columns
487         foreach (array_keys($this->columns) as $column) {
488             if (!empty($this->prefs['collapse'][$column])) {
489                 $this->column_style[$column]['width'] = '10px';
490             }
491         }
493         if (($sortcol = optional_param($this->request[TABLE_VAR_SORT], '', PARAM_ALPHANUMEXT)) &&
494                 $this->is_sortable($sortcol) && empty($this->prefs['collapse'][$sortcol]) &&
495                 (isset($this->columns[$sortcol]) || in_array($sortcol, get_all_user_name_fields())
496                 && isset($this->columns['fullname']))) {
498             if (array_key_exists($sortcol, $this->prefs['sortby'])) {
499                 // This key already exists somewhere. Change its sortorder and bring it to the top.
500                 $sortorder = $this->prefs['sortby'][$sortcol] == SORT_ASC ? SORT_DESC : SORT_ASC;
501                 unset($this->prefs['sortby'][$sortcol]);
502                 $this->prefs['sortby'] = array_merge(array($sortcol => $sortorder), $this->prefs['sortby']);
503             } else {
504                 // Key doesn't exist, so just add it to the beginning of the array, ascending order
505                 $this->prefs['sortby'] = array_merge(array($sortcol => SORT_ASC), $this->prefs['sortby']);
506             }
508             // Finally, make sure that no more than $this->maxsortkeys are present into the array
509             $this->prefs['sortby'] = array_slice($this->prefs['sortby'], 0, $this->maxsortkeys);
510         }
512         // MDL-35375 - If a default order is defined and it is not in the current list of order by columns, add it at the end.
513         // This prevents results from being returned in a random order if the only order by column contains equal values.
514         if (!empty($this->sort_default_column))  {
515             if (!array_key_exists($this->sort_default_column, $this->prefs['sortby'])) {
516                 $defaultsort = array($this->sort_default_column => $this->sort_default_order);
517                 $this->prefs['sortby'] = array_merge($this->prefs['sortby'], $defaultsort);
518             }
519         }
521         $ilast = optional_param($this->request[TABLE_VAR_ILAST], null, PARAM_RAW);
522         if (!is_null($ilast) && ($ilast ==='' || strpos(get_string('alphabet', 'langconfig'), $ilast) !== false)) {
523             $this->prefs['i_last'] = $ilast;
524         }
526         $ifirst = optional_param($this->request[TABLE_VAR_IFIRST], null, PARAM_RAW);
527         if (!is_null($ifirst) && ($ifirst === '' || strpos(get_string('alphabet', 'langconfig'), $ifirst) !== false)) {
528             $this->prefs['i_first'] = $ifirst;
529         }
531         // Save user preferences if they have changed.
532         if ($this->prefs != $oldprefs) {
533             if ($this->persistent) {
534                 set_user_preference('flextable_' . $this->uniqueid, json_encode($this->prefs));
535             } else {
536                 $SESSION->flextable[$this->uniqueid] = $this->prefs;
537             }
538         }
539         unset($oldprefs);
541         if (empty($this->baseurl)) {
542             debugging('You should set baseurl when using flexible_table.');
543             global $PAGE;
544             $this->baseurl = $PAGE->url;
545         }
547         $this->currpage = optional_param($this->request[TABLE_VAR_PAGE], 0, PARAM_INT);
548         $this->setup = true;
550         // Always introduce the "flexible" class for the table if not specified
551         if (empty($this->attributes)) {
552             $this->attributes['class'] = 'flexible';
553         } else if (!isset($this->attributes['class'])) {
554             $this->attributes['class'] = 'flexible';
555         } else if (!in_array('flexible', explode(' ', $this->attributes['class']))) {
556             $this->attributes['class'] = trim('flexible ' . $this->attributes['class']);
557         }
558     }
560     /**
561      * Get the order by clause from the session or user preferences, for the table with id $uniqueid.
562      * @param string $uniqueid the identifier for a table.
563      * @return SQL fragment that can be used in an ORDER BY clause.
564      */
565     public static function get_sort_for_table($uniqueid) {
566         global $SESSION;
567         if (isset($SESSION->flextable[$uniqueid])) {
568             $prefs = $SESSION->flextable[$uniqueid];
569         } else if (!$prefs = json_decode(get_user_preferences('flextable_' . $uniqueid), true)) {
570             return '';
571         }
573         if (empty($prefs['sortby'])) {
574             return '';
575         }
576         if (empty($prefs['textsort'])) {
577             $prefs['textsort'] = array();
578         }
580         return self::construct_order_by($prefs['sortby'], $prefs['textsort']);
581     }
583     /**
584      * Prepare an an order by clause from the list of columns to be sorted.
585      * @param array $cols column name => SORT_ASC or SORT_DESC
586      * @return SQL fragment that can be used in an ORDER BY clause.
587      */
588     public static function construct_order_by($cols, $textsortcols=array()) {
589         global $DB;
590         $bits = array();
592         foreach ($cols as $column => $order) {
593             if (in_array($column, $textsortcols)) {
594                 $column = $DB->sql_order_by_text($column);
595             }
596             if ($order == SORT_ASC) {
597                 $bits[] = $column . ' ASC';
598             } else {
599                 $bits[] = $column . ' DESC';
600             }
601         }
603         return implode(', ', $bits);
604     }
606     /**
607      * @return SQL fragment that can be used in an ORDER BY clause.
608      */
609     public function get_sql_sort() {
610         return self::construct_order_by($this->get_sort_columns(), $this->column_textsort);
611     }
613     /**
614      * Get the columns to sort by, in the form required by {@link construct_order_by()}.
615      * @return array column name => SORT_... constant.
616      */
617     public function get_sort_columns() {
618         if (!$this->setup) {
619             throw new coding_exception('Cannot call get_sort_columns until you have called setup.');
620         }
622         if (empty($this->prefs['sortby'])) {
623             return array();
624         }
626         foreach ($this->prefs['sortby'] as $column => $notused) {
627             if (isset($this->columns[$column])) {
628                 continue; // This column is OK.
629             }
630             if (in_array($column, get_all_user_name_fields()) &&
631                     isset($this->columns['fullname'])) {
632                 continue; // This column is OK.
633             }
634             // This column is not OK.
635             unset($this->prefs['sortby'][$column]);
636         }
638         return $this->prefs['sortby'];
639     }
641     /**
642      * @return int the offset for LIMIT clause of SQL
643      */
644     function get_page_start() {
645         if (!$this->use_pages) {
646             return '';
647         }
648         return $this->currpage * $this->pagesize;
649     }
651     /**
652      * @return int the pagesize for LIMIT clause of SQL
653      */
654     function get_page_size() {
655         if (!$this->use_pages) {
656             return '';
657         }
658         return $this->pagesize;
659     }
661     /**
662      * @return string sql to add to where statement.
663      */
664     function get_sql_where() {
665         global $DB;
667         $conditions = array();
668         $params = array();
670         if (isset($this->columns['fullname'])) {
671             static $i = 0;
672             $i++;
674             if (!empty($this->prefs['i_first'])) {
675                 $conditions[] = $DB->sql_like('firstname', ':ifirstc'.$i, false, false);
676                 $params['ifirstc'.$i] = $this->prefs['i_first'].'%';
677             }
678             if (!empty($this->prefs['i_last'])) {
679                 $conditions[] = $DB->sql_like('lastname', ':ilastc'.$i, false, false);
680                 $params['ilastc'.$i] = $this->prefs['i_last'].'%';
681             }
682         }
684         return array(implode(" AND ", $conditions), $params);
685     }
687     /**
688      * Add a row of data to the table. This function takes an array or object with
689      * column names as keys or property names.
690      *
691      * It ignores any elements with keys that are not defined as columns. It
692      * puts in empty strings into the row when there is no element in the passed
693      * array corresponding to a column in the table. It puts the row elements in
694      * the proper order (internally row table data is stored by in arrays with
695      * a numerical index corresponding to the column number).
696      *
697      * @param object|array $rowwithkeys array keys or object property names are column names,
698      *                                      as defined in call to define_columns.
699      * @param string $classname CSS class name to add to this row's tr tag.
700      */
701     function add_data_keyed($rowwithkeys, $classname = '') {
702         $this->add_data($this->get_row_from_keyed($rowwithkeys), $classname);
703     }
705     /**
706      * Add a number of rows to the table at once. And optionally finish output after they have been added.
707      *
708      * @param (object|array|null)[] $rowstoadd Array of rows to add to table, a null value in array adds a separator row. Or a
709      *                                  object or array is added to table. We expect properties for the row array as would be
710      *                                  passed to add_data_keyed.
711      * @param bool     $finish
712      */
713     public function format_and_add_array_of_rows($rowstoadd, $finish = true) {
714         foreach ($rowstoadd as $row) {
715             if (is_null($row)) {
716                 $this->add_separator();
717             } else {
718                 $this->add_data_keyed($this->format_row($row));
719             }
720         }
721         if ($finish) {
722             $this->finish_output(!$this->is_downloading());
723         }
724     }
726     /**
727      * Add a seperator line to table.
728      */
729     function add_separator() {
730         if (!$this->setup) {
731             return false;
732         }
733         $this->add_data(NULL);
734     }
736     /**
737      * This method actually directly echoes the row passed to it now or adds it
738      * to the download. If this is the first row and start_output has not
739      * already been called this method also calls start_output to open the table
740      * or send headers for the downloaded.
741      * Can be used as before. print_html now calls finish_html to close table.
742      *
743      * @param array $row a numerically keyed row of data to add to the table.
744      * @param string $classname CSS class name to add to this row's tr tag.
745      * @return bool success.
746      */
747     function add_data($row, $classname = '') {
748         if (!$this->setup) {
749             return false;
750         }
751         if (!$this->started_output) {
752             $this->start_output();
753         }
754         if ($this->exportclass!==null) {
755             if ($row === null) {
756                 $this->exportclass->add_seperator();
757             } else {
758                 $this->exportclass->add_data($row);
759             }
760         } else {
761             $this->print_row($row, $classname);
762         }
763         return true;
764     }
766     /**
767      * You should call this to finish outputting the table data after adding
768      * data to the table with add_data or add_data_keyed.
769      *
770      */
771     function finish_output($closeexportclassdoc = true) {
772         if ($this->exportclass!==null) {
773             $this->exportclass->finish_table();
774             if ($closeexportclassdoc) {
775                 $this->exportclass->finish_document();
776             }
777         } else {
778             $this->finish_html();
779         }
780     }
782     /**
783      * Hook that can be overridden in child classes to wrap a table in a form
784      * for example. Called only when there is data to display and not
785      * downloading.
786      */
787     function wrap_html_start() {
788     }
790     /**
791      * Hook that can be overridden in child classes to wrap a table in a form
792      * for example. Called only when there is data to display and not
793      * downloading.
794      */
795     function wrap_html_finish() {
796     }
798     /**
799      * Call appropriate methods on this table class to perform any processing on values before displaying in table.
800      * Takes raw data from the database and process it into human readable format, perhaps also adding html linking when
801      * displaying table as html, adding a div wrap, etc.
802      *
803      * See for example col_fullname below which will be called for a column whose name is 'fullname'.
804      *
805      * @param array|object $row row of data from db used to make one row of the table.
806      * @return array one row for the table, added using add_data_keyed method.
807      */
808     function format_row($row) {
809         if (is_array($row)) {
810             $row = (object)$row;
811         }
812         $formattedrow = array();
813         foreach (array_keys($this->columns) as $column) {
814             $colmethodname = 'col_'.$column;
815             if (method_exists($this, $colmethodname)) {
816                 $formattedcolumn = $this->$colmethodname($row);
817             } else {
818                 $formattedcolumn = $this->other_cols($column, $row);
819                 if ($formattedcolumn===NULL) {
820                     $formattedcolumn = $row->$column;
821                 }
822             }
823             $formattedrow[$column] = $formattedcolumn;
824         }
825         return $formattedrow;
826     }
828     /**
829      * Fullname is treated as a special columname in tablelib and should always
830      * be treated the same as the fullname of a user.
831      * @uses $this->useridfield if the userid field is not expected to be id
832      * then you need to override $this->useridfield to point at the correct
833      * field for the user id.
834      *
835      * @param object $row the data from the db containing all fields from the
836      *                    users table necessary to construct the full name of the user in
837      *                    current language.
838      * @return string contents of cell in column 'fullname', for this row.
839      */
840     function col_fullname($row) {
841         global $COURSE;
843         $name = fullname($row);
844         if ($this->download) {
845             return $name;
846         }
848         $userid = $row->{$this->useridfield};
849         if ($COURSE->id == SITEID) {
850             $profileurl = new moodle_url('/user/profile.php', array('id' => $userid));
851         } else {
852             $profileurl = new moodle_url('/user/view.php',
853                     array('id' => $userid, 'course' => $COURSE->id));
854         }
855         return html_writer::link($profileurl, $name);
856     }
858     /**
859      * You can override this method in a child class. See the description of
860      * build_table which calls this method.
861      */
862     function other_cols($column, $row) {
863         return NULL;
864     }
866     /**
867      * Used from col_* functions when text is to be displayed. Does the
868      * right thing - either converts text to html or strips any html tags
869      * depending on if we are downloading and what is the download type. Params
870      * are the same as format_text function in weblib.php but some default
871      * options are changed.
872      */
873     function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL) {
874         if (!$this->is_downloading()) {
875             if (is_null($options)) {
876                 $options = new stdClass;
877             }
878             //some sensible defaults
879             if (!isset($options->para)) {
880                 $options->para = false;
881             }
882             if (!isset($options->newlines)) {
883                 $options->newlines = false;
884             }
885             if (!isset($options->smiley)) {
886                 $options->smiley = false;
887             }
888             if (!isset($options->filter)) {
889                 $options->filter = false;
890             }
891             return format_text($text, $format, $options);
892         } else {
893             $eci = $this->export_class_instance();
894             return $eci->format_text($text, $format, $options, $courseid);
895         }
896     }
897     /**
898      * This method is deprecated although the old api is still supported.
899      * @deprecated 1.9.2 - Jun 2, 2008
900      */
901     function print_html() {
902         if (!$this->setup) {
903             return false;
904         }
905         $this->finish_html();
906     }
908     /**
909      * This function is not part of the public api.
910      * @return string initial of first name we are currently filtering by
911      */
912     function get_initial_first() {
913         if (!$this->use_initials) {
914             return NULL;
915         }
917         return $this->prefs['i_first'];
918     }
920     /**
921      * This function is not part of the public api.
922      * @return string initial of last name we are currently filtering by
923      */
924     function get_initial_last() {
925         if (!$this->use_initials) {
926             return NULL;
927         }
929         return $this->prefs['i_last'];
930     }
932     /**
933      * Helper function, used by {@link print_initials_bar()} to output one initial bar.
934      * @param array $alpha of letters in the alphabet.
935      * @param string $current the currently selected letter.
936      * @param string $class class name to add to this initial bar.
937      * @param string $title the name to put in front of this initial bar.
938      * @param string $urlvar URL parameter name for this initial.
939      */
940     protected function print_one_initials_bar($alpha, $current, $class, $title, $urlvar) {
941         echo html_writer::start_tag('div', array('class' => 'initialbar ' . $class)) .
942                 $title . ' : ';
943         if ($current) {
944             echo html_writer::link($this->baseurl->out(false, array($urlvar => '')), get_string('all'));
945         } else {
946             echo html_writer::tag('strong', get_string('all'));
947         }
949         foreach ($alpha as $letter) {
950             if ($letter === $current) {
951                 echo html_writer::tag('strong', $letter);
952             } else {
953                 echo html_writer::link($this->baseurl->out(false, array($urlvar => $letter)), $letter);
954             }
955         }
957         echo html_writer::end_tag('div');
958     }
960     /**
961      * This function is not part of the public api.
962      */
963     function print_initials_bar() {
964         if ((!empty($this->prefs['i_last']) || !empty($this->prefs['i_first']) ||$this->use_initials)
965                     && isset($this->columns['fullname'])) {
967             $alpha  = explode(',', get_string('alphabet', 'langconfig'));
969             // Bar of first initials
970             if (!empty($this->prefs['i_first'])) {
971                 $ifirst = $this->prefs['i_first'];
972             } else {
973                 $ifirst = '';
974             }
975             $this->print_one_initials_bar($alpha, $ifirst, 'firstinitial',
976                     get_string('firstname'), $this->request[TABLE_VAR_IFIRST]);
978             // Bar of last initials
979             if (!empty($this->prefs['i_last'])) {
980                 $ilast = $this->prefs['i_last'];
981             } else {
982                 $ilast = '';
983             }
984             $this->print_one_initials_bar($alpha, $ilast, 'lastinitial',
985                     get_string('lastname'), $this->request[TABLE_VAR_ILAST]);
986         }
987     }
989     /**
990      * This function is not part of the public api.
991      */
992     function print_nothing_to_display() {
993         global $OUTPUT;
995         // Render button to allow user to reset table preferences.
996         echo $this->render_reset_button();
998         $this->print_initials_bar();
1000         echo $OUTPUT->heading(get_string('nothingtodisplay'));
1001     }
1003     /**
1004      * This function is not part of the public api.
1005      */
1006     function get_row_from_keyed($rowwithkeys) {
1007         if (is_object($rowwithkeys)) {
1008             $rowwithkeys = (array)$rowwithkeys;
1009         }
1010         $row = array();
1011         foreach (array_keys($this->columns) as $column) {
1012             if (isset($rowwithkeys[$column])) {
1013                 $row [] = $rowwithkeys[$column];
1014             } else {
1015                 $row[] ='';
1016             }
1017         }
1018         return $row;
1019     }
1020     /**
1021      * This function is not part of the public api.
1022      */
1023     function get_download_menu() {
1024         $allclasses= get_declared_classes();
1025         $exportclasses = array();
1026         foreach ($allclasses as $class) {
1027             $matches = array();
1028             if (preg_match('/^table\_([a-z]+)\_export\_format$/', $class, $matches)) {
1029                 $type = $matches[1];
1030                 $exportclasses[$type]= get_string("download$type", 'table');
1031             }
1032         }
1033         return $exportclasses;
1034     }
1036     /**
1037      * This function is not part of the public api.
1038      */
1039     function download_buttons() {
1040         if ($this->is_downloadable() && !$this->is_downloading()) {
1041             $downloadoptions = $this->get_download_menu();
1043             $downloadelements = new stdClass();
1044             $downloadelements->formatsmenu = html_writer::select($downloadoptions,
1045                     'download', $this->defaultdownloadformat, false);
1046             $downloadelements->downloadbutton = '<input type="submit" value="'.
1047                     get_string('download').'"/>';
1048             $html = '<form action="'. $this->baseurl .'" method="post">';
1049             $html .= '<div class="mdl-align">';
1050             $html .= html_writer::tag('label', get_string('downloadas', 'table', $downloadelements));
1051             $html .= '</div></form>';
1053             return $html;
1054         } else {
1055             return '';
1056         }
1057     }
1058     /**
1059      * This function is not part of the public api.
1060      * You don't normally need to call this. It is called automatically when
1061      * needed when you start adding data to the table.
1062      *
1063      */
1064     function start_output() {
1065         $this->started_output = true;
1066         if ($this->exportclass!==null) {
1067             $this->exportclass->start_table($this->sheettitle);
1068             $this->exportclass->output_headers($this->headers);
1069         } else {
1070             $this->start_html();
1071             $this->print_headers();
1072             echo html_writer::start_tag('tbody');
1073         }
1074     }
1076     /**
1077      * This function is not part of the public api.
1078      */
1079     function print_row($row, $classname = '') {
1080         echo $this->get_row_html($row, $classname);
1081     }
1083     /**
1084      * Generate html code for the passed row.
1085      *
1086      * @param array $row Row data.
1087      * @param string $classname classes to add.
1088      *
1089      * @return string $html html code for the row passed.
1090      */
1091     public function get_row_html($row, $classname = '') {
1092         static $suppress_lastrow = NULL;
1093         $rowclasses = array();
1095         if ($classname) {
1096             $rowclasses[] = $classname;
1097         }
1099         $rowid = $this->uniqueid . '_r' . $this->currentrow;
1100         $html = '';
1102         $html .= html_writer::start_tag('tr', array('class' => implode(' ', $rowclasses), 'id' => $rowid));
1104         // If we have a separator, print it
1105         if ($row === NULL) {
1106             $colcount = count($this->columns);
1107             $html .= html_writer::tag('td', html_writer::tag('div', '',
1108                     array('class' => 'tabledivider')), array('colspan' => $colcount));
1110         } else {
1111             $colbyindex = array_flip($this->columns);
1112             foreach ($row as $index => $data) {
1113                 $column = $colbyindex[$index];
1115                 if (empty($this->prefs['collapse'][$column])) {
1116                     if ($this->column_suppress[$column] && $suppress_lastrow !== NULL && $suppress_lastrow[$index] === $data) {
1117                         $content = '&nbsp;';
1118                     } else {
1119                         $content = $data;
1120                     }
1121                 } else {
1122                     $content = '&nbsp;';
1123                 }
1125                 $html .= html_writer::tag('td', $content, array(
1126                         'class' => 'cell c' . $index . $this->column_class[$column],
1127                         'id' => $rowid . '_c' . $index,
1128                         'style' => $this->make_styles_string($this->column_style[$column])));
1129             }
1130         }
1132         $html .= html_writer::end_tag('tr');
1134         $suppress_enabled = array_sum($this->column_suppress);
1135         if ($suppress_enabled) {
1136             $suppress_lastrow = $row;
1137         }
1138         $this->currentrow++;
1139         return $html;
1140     }
1142     /**
1143      * This function is not part of the public api.
1144      */
1145     function finish_html() {
1146         global $OUTPUT;
1147         if (!$this->started_output) {
1148             //no data has been added to the table.
1149             $this->print_nothing_to_display();
1151         } else {
1152             // Print empty rows to fill the table to the current pagesize.
1153             // This is done so the header aria-controls attributes do not point to
1154             // non existant elements.
1155             $emptyrow = array_fill(0, count($this->columns), '');
1156             while ($this->currentrow < $this->pagesize) {
1157                 $this->print_row($emptyrow, 'emptyrow');
1158             }
1160             echo html_writer::end_tag('tbody');
1161             echo html_writer::end_tag('table');
1162             echo html_writer::end_tag('div');
1163             $this->wrap_html_finish();
1165             // Paging bar
1166             if(in_array(TABLE_P_BOTTOM, $this->showdownloadbuttonsat)) {
1167                 echo $this->download_buttons();
1168             }
1170             if($this->use_pages) {
1171                 $pagingbar = new paging_bar($this->totalrows, $this->currpage, $this->pagesize, $this->baseurl);
1172                 $pagingbar->pagevar = $this->request[TABLE_VAR_PAGE];
1173                 echo $OUTPUT->render($pagingbar);
1174             }
1175         }
1176     }
1178     /**
1179      * Generate the HTML for the collapse/uncollapse icon. This is a helper method
1180      * used by {@link print_headers()}.
1181      * @param string $column the column name, index into various names.
1182      * @param int $index numerical index of the column.
1183      * @return string HTML fragment.
1184      */
1185     protected function show_hide_link($column, $index) {
1186         global $OUTPUT;
1187         // Some headers contain <br /> tags, do not include in title, hence the
1188         // strip tags.
1190         $ariacontrols = '';
1191         for ($i = 0; $i < $this->pagesize; $i++) {
1192             $ariacontrols .= $this->uniqueid . '_r' . $i . '_c' . $index . ' ';
1193         }
1195         $ariacontrols = trim($ariacontrols);
1197         if (!empty($this->prefs['collapse'][$column])) {
1198             $linkattributes = array('title' => get_string('show') . ' ' . strip_tags($this->headers[$index]),
1199                                     'aria-expanded' => 'false',
1200                                     'aria-controls' => $ariacontrols);
1201             return html_writer::link($this->baseurl->out(false, array($this->request[TABLE_VAR_SHOW] => $column)),
1202                     html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/switch_plus'), 'alt' => get_string('show'))),
1203                     $linkattributes);
1205         } else if ($this->headers[$index] !== NULL) {
1206             $linkattributes = array('title' => get_string('hide') . ' ' . strip_tags($this->headers[$index]),
1207                                     'aria-expanded' => 'true',
1208                                     'aria-controls' => $ariacontrols);
1209             return html_writer::link($this->baseurl->out(false, array($this->request[TABLE_VAR_HIDE] => $column)),
1210                     html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/switch_minus'), 'alt' => get_string('hide'))),
1211                     $linkattributes);
1212         }
1213     }
1215     /**
1216      * This function is not part of the public api.
1217      */
1218     function print_headers() {
1219         global $CFG, $OUTPUT;
1221         echo html_writer::start_tag('thead');
1222         echo html_writer::start_tag('tr');
1223         foreach ($this->columns as $column => $index) {
1225             $icon_hide = '';
1226             if ($this->is_collapsible) {
1227                 $icon_hide = $this->show_hide_link($column, $index);
1228             }
1230             $primarysortcolumn = '';
1231             $primarysortorder  = '';
1232             if (reset($this->prefs['sortby'])) {
1233                 $primarysortcolumn = key($this->prefs['sortby']);
1234                 $primarysortorder  = current($this->prefs['sortby']);
1235             }
1237             switch ($column) {
1239                 case 'fullname':
1240                 // Check the full name display for sortable fields.
1241                 $nameformat = $CFG->fullnamedisplay;
1242                 if ($nameformat == 'language') {
1243                     $nameformat = get_string('fullnamedisplay');
1244                 }
1245                 $requirednames = order_in_string(get_all_user_name_fields(), $nameformat);
1247                 if (!empty($requirednames)) {
1248                     if ($this->is_sortable($column)) {
1249                         // Done this way for the possibility of more than two sortable full name display fields.
1250                         $this->headers[$index] = '';
1251                         foreach ($requirednames as $name) {
1252                             $sortname = $this->sort_link(get_string($name),
1253                                     $name, $primarysortcolumn === $name, $primarysortorder);
1254                             $this->headers[$index] .= $sortname . ' / ';
1255                         }
1256                         $helpicon = '';
1257                         if (isset($this->helpforheaders[$index])) {
1258                             $helpicon = $OUTPUT->render($this->helpforheaders[$index]);
1259                         }
1260                         $this->headers[$index] = substr($this->headers[$index], 0, -3). $helpicon;
1261                     }
1262                 }
1263                 break;
1265                 case 'userpic':
1266                     // do nothing, do not display sortable links
1267                 break;
1269                 default:
1270                 if ($this->is_sortable($column)) {
1271                     $helpicon = '';
1272                     if (isset($this->helpforheaders[$index])) {
1273                         $helpicon = $OUTPUT->render($this->helpforheaders[$index]);
1274                     }
1275                     $this->headers[$index] = $this->sort_link($this->headers[$index],
1276                             $column, $primarysortcolumn == $column, $primarysortorder) . $helpicon;
1277                 }
1278             }
1280             $attributes = array(
1281                 'class' => 'header c' . $index . $this->column_class[$column],
1282                 'scope' => 'col',
1283             );
1284             if ($this->headers[$index] === NULL) {
1285                 $content = '&nbsp;';
1286             } else if (!empty($this->prefs['collapse'][$column])) {
1287                 $content = $icon_hide;
1288             } else {
1289                 if (is_array($this->column_style[$column])) {
1290                     $attributes['style'] = $this->make_styles_string($this->column_style[$column]);
1291                 }
1292                 $helpicon = '';
1293                 if (isset($this->helpforheaders[$index]) && !$this->is_sortable($column)) {
1294                     $helpicon  = $OUTPUT->render($this->helpforheaders[$index]);
1295                 }
1296                 $content = $this->headers[$index] . $helpicon . html_writer::tag('div',
1297                         $icon_hide, array('class' => 'commands'));
1298             }
1299             echo html_writer::tag('th', $content, $attributes);
1300         }
1302         echo html_writer::end_tag('tr');
1303         echo html_writer::end_tag('thead');
1304     }
1306     /**
1307      * Generate the HTML for the sort icon. This is a helper method used by {@link sort_link()}.
1308      * @param bool $isprimary whether an icon is needed (it is only needed for the primary sort column.)
1309      * @param int $order SORT_ASC or SORT_DESC
1310      * @return string HTML fragment.
1311      */
1312     protected function sort_icon($isprimary, $order) {
1313         global $OUTPUT;
1315         if (!$isprimary) {
1316             return '';
1317         }
1319         if ($order == SORT_ASC) {
1320             return html_writer::empty_tag('img',
1321                     array('src' => $OUTPUT->pix_url('t/sort_asc'), 'alt' => get_string('asc'), 'class' => 'iconsort'));
1322         } else {
1323             return html_writer::empty_tag('img',
1324                     array('src' => $OUTPUT->pix_url('t/sort_desc'), 'alt' => get_string('desc'), 'class' => 'iconsort'));
1325         }
1326     }
1328     /**
1329      * Generate the correct tool tip for changing the sort order. This is a
1330      * helper method used by {@link sort_link()}.
1331      * @param bool $isprimary whether the is column is the current primary sort column.
1332      * @param int $order SORT_ASC or SORT_DESC
1333      * @return string the correct title.
1334      */
1335     protected function sort_order_name($isprimary, $order) {
1336         if ($isprimary && $order != SORT_ASC) {
1337             return get_string('desc');
1338         } else {
1339             return get_string('asc');
1340         }
1341     }
1343     /**
1344      * Generate the HTML for the sort link. This is a helper method used by {@link print_headers()}.
1345      * @param string $text the text for the link.
1346      * @param string $column the column name, may be a fake column like 'firstname' or a real one.
1347      * @param bool $isprimary whether the is column is the current primary sort column.
1348      * @param int $order SORT_ASC or SORT_DESC
1349      * @return string HTML fragment.
1350      */
1351     protected function sort_link($text, $column, $isprimary, $order) {
1352         return html_writer::link($this->baseurl->out(false,
1353                 array($this->request[TABLE_VAR_SORT] => $column)),
1354                 $text . get_accesshide(get_string('sortby') . ' ' .
1355                 $text . ' ' . $this->sort_order_name($isprimary, $order))) . ' ' .
1356                 $this->sort_icon($isprimary, $order);
1357     }
1359     /**
1360      * This function is not part of the public api.
1361      */
1362     function start_html() {
1363         global $OUTPUT;
1365         // Render button to allow user to reset table preferences.
1366         echo $this->render_reset_button();
1368         // Do we need to print initial bars?
1369         $this->print_initials_bar();
1371         // Paging bar
1372         if ($this->use_pages) {
1373             $pagingbar = new paging_bar($this->totalrows, $this->currpage, $this->pagesize, $this->baseurl);
1374             $pagingbar->pagevar = $this->request[TABLE_VAR_PAGE];
1375             echo $OUTPUT->render($pagingbar);
1376         }
1378         if (in_array(TABLE_P_TOP, $this->showdownloadbuttonsat)) {
1379             echo $this->download_buttons();
1380         }
1382         $this->wrap_html_start();
1383         // Start of main data table
1385         echo html_writer::start_tag('div', array('class' => 'no-overflow'));
1386         echo html_writer::start_tag('table', $this->attributes);
1388     }
1390     /**
1391      * This function is not part of the public api.
1392      * @param array $styles CSS-property => value
1393      * @return string values suitably to go in a style="" attribute in HTML.
1394      */
1395     function make_styles_string($styles) {
1396         if (empty($styles)) {
1397             return null;
1398         }
1400         $string = '';
1401         foreach($styles as $property => $value) {
1402             $string .= $property . ':' . $value . ';';
1403         }
1404         return $string;
1405     }
1407     /**
1408      * Generate the HTML for the table preferences reset button.
1409      *
1410      * @return string HTML fragment, empty string if no need to reset
1411      */
1412     protected function render_reset_button() {
1414         if (!$this->can_be_reset()) {
1415             return '';
1416         }
1418         $url = $this->baseurl->out(false, array($this->request[TABLE_VAR_RESET] => 1));
1420         $html  = html_writer::start_div('resettable mdl-right');
1421         $html .= html_writer::link($url, get_string('resettable'));
1422         $html .= html_writer::end_div();
1424         return $html;
1425     }
1427     /**
1428      * Are there some table preferences that can be reset?
1429      *
1430      * If true, then the "reset table preferences" widget should be displayed.
1431      *
1432      * @return bool
1433      */
1434     protected function can_be_reset() {
1436         // Loop through preferences and make sure they are empty or set to the default value.
1437         foreach ($this->prefs as $prefname => $prefval) {
1439             if ($prefname === 'sortby' and !empty($this->sort_default_column)) {
1440                 // Check if the actual sorting differs from the default one.
1441                 if (empty($prefval) or $prefval !== array($this->sort_default_column => $this->sort_default_order)) {
1442                     return true;
1443                 }
1445             } else if ($prefname === 'collapse' and !empty($prefval)) {
1446                 // Check if there are some collapsed columns (all are expanded by default).
1447                 foreach ($prefval as $columnname => $iscollapsed) {
1448                     if ($iscollapsed) {
1449                         return true;
1450                     }
1451                 }
1453             } else if (!empty($prefval)) {
1454                 // For all other cases, we just check if some preference is set.
1455                 return true;
1456             }
1457         }
1459         return false;
1460     }
1464 /**
1465  * @package   moodlecore
1466  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1467  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1468  */
1469 class table_sql extends flexible_table {
1471     public $countsql = NULL;
1472     public $countparams = NULL;
1473     /**
1474      * @var object sql for querying db. Has fields 'fields', 'from', 'where', 'params'.
1475      */
1476     public $sql = NULL;
1477     /**
1478      * @var array|\Traversable Data fetched from the db.
1479      */
1480     public $rawdata = NULL;
1482     /**
1483      * @var bool Overriding default for this.
1484      */
1485     public $is_sortable    = true;
1486     /**
1487      * @var bool Overriding default for this.
1488      */
1489     public $is_collapsible = true;
1491     /**
1492      * @param string $uniqueid a string identifying this table.Used as a key in
1493      *                          session  vars.
1494      */
1495     function __construct($uniqueid) {
1496         parent::__construct($uniqueid);
1497         // some sensible defaults
1498         $this->set_attribute('cellspacing', '0');
1499         $this->set_attribute('class', 'generaltable generalbox');
1500     }
1502     /**
1503      * Take the data returned from the db_query and go through all the rows
1504      * processing each col using either col_{columnname} method or other_cols
1505      * method or if other_cols returns NULL then put the data straight into the
1506      * table.
1507      *
1508      * @return void
1509      */
1510     function build_table() {
1512         if ($this->rawdata instanceof \Traversable && !$this->rawdata->valid()) {
1513             return;
1514         }
1515         if (!$this->rawdata) {
1516             return;
1517         }
1519         foreach ($this->rawdata as $row) {
1520             $formattedrow = $this->format_row($row);
1521             $this->add_data_keyed($formattedrow,
1522                 $this->get_row_class($row));
1523         }
1525         if ($this->rawdata instanceof \core\dml\recordset_walk ||
1526                 $this->rawdata instanceof moodle_recordset) {
1527             $this->rawdata->close();
1528         }
1529     }
1531     /**
1532      * Get any extra classes names to add to this row in the HTML.
1533      * @param $row array the data for this row.
1534      * @return string added to the class="" attribute of the tr.
1535      */
1536     function get_row_class($row) {
1537         return '';
1538     }
1540     /**
1541      * This is only needed if you want to use different sql to count rows.
1542      * Used for example when perhaps all db JOINS are not needed when counting
1543      * records. You don't need to call this function the count_sql
1544      * will be generated automatically.
1545      *
1546      * We need to count rows returned by the db seperately to the query itself
1547      * as we need to know how many pages of data we have to display.
1548      */
1549     function set_count_sql($sql, array $params = NULL) {
1550         $this->countsql = $sql;
1551         $this->countparams = $params;
1552     }
1554     /**
1555      * Set the sql to query the db. Query will be :
1556      *      SELECT $fields FROM $from WHERE $where
1557      * Of course you can use sub-queries, JOINS etc. by putting them in the
1558      * appropriate clause of the query.
1559      */
1560     function set_sql($fields, $from, $where, array $params = NULL) {
1561         $this->sql = new stdClass();
1562         $this->sql->fields = $fields;
1563         $this->sql->from = $from;
1564         $this->sql->where = $where;
1565         $this->sql->params = $params;
1566     }
1568     /**
1569      * Query the db. Store results in the table object for use by build_table.
1570      *
1571      * @param int $pagesize size of page for paginated displayed table.
1572      * @param bool $useinitialsbar do you want to use the initials bar. Bar
1573      * will only be used if there is a fullname column defined for the table.
1574      */
1575     function query_db($pagesize, $useinitialsbar=true) {
1576         global $DB;
1577         if (!$this->is_downloading()) {
1578             if ($this->countsql === NULL) {
1579                 $this->countsql = 'SELECT COUNT(1) FROM '.$this->sql->from.' WHERE '.$this->sql->where;
1580                 $this->countparams = $this->sql->params;
1581             }
1582             $grandtotal = $DB->count_records_sql($this->countsql, $this->countparams);
1583             if ($useinitialsbar && !$this->is_downloading()) {
1584                 $this->initialbars($grandtotal > $pagesize);
1585             }
1587             list($wsql, $wparams) = $this->get_sql_where();
1588             if ($wsql) {
1589                 $this->countsql .= ' AND '.$wsql;
1590                 $this->countparams = array_merge($this->countparams, $wparams);
1592                 $this->sql->where .= ' AND '.$wsql;
1593                 $this->sql->params = array_merge($this->sql->params, $wparams);
1595                 $total  = $DB->count_records_sql($this->countsql, $this->countparams);
1596             } else {
1597                 $total = $grandtotal;
1598             }
1600             $this->pagesize($pagesize, $total);
1601         }
1603         // Fetch the attempts
1604         $sort = $this->get_sql_sort();
1605         if ($sort) {
1606             $sort = "ORDER BY $sort";
1607         }
1608         $sql = "SELECT
1609                 {$this->sql->fields}
1610                 FROM {$this->sql->from}
1611                 WHERE {$this->sql->where}
1612                 {$sort}";
1614         if (!$this->is_downloading()) {
1615             $this->rawdata = $DB->get_records_sql($sql, $this->sql->params, $this->get_page_start(), $this->get_page_size());
1616         } else {
1617             $this->rawdata = $DB->get_records_sql($sql, $this->sql->params);
1618         }
1619     }
1621     /**
1622      * Convenience method to call a number of methods for you to display the
1623      * table.
1624      */
1625     function out($pagesize, $useinitialsbar, $downloadhelpbutton='') {
1626         global $DB;
1627         if (!$this->columns) {
1628             $onerow = $DB->get_record_sql("SELECT {$this->sql->fields} FROM {$this->sql->from} WHERE {$this->sql->where}", $this->sql->params);
1629             //if columns is not set then define columns as the keys of the rows returned
1630             //from the db.
1631             $this->define_columns(array_keys((array)$onerow));
1632             $this->define_headers(array_keys((array)$onerow));
1633         }
1634         $this->setup();
1635         $this->query_db($pagesize, $useinitialsbar);
1636         $this->build_table();
1637         $this->finish_output();
1638     }
1642 /**
1643  * @package   moodlecore
1644  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1645  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1646  */
1647 class table_default_export_format_parent {
1648     /**
1649      * @var flexible_table or child class reference pointing to table class
1650      * object from which to export data.
1651      */
1652     var $table;
1654     /**
1655      * @var bool output started. Keeps track of whether any output has been
1656      * started yet.
1657      */
1658     var $documentstarted = false;
1659     function table_default_export_format_parent(&$table) {
1660         $this->table =& $table;
1661     }
1663     function set_table(&$table) {
1664         $this->table =& $table;
1665     }
1667     function add_data($row) {
1668         return false;
1669     }
1671     function add_seperator() {
1672         return false;
1673     }
1675     function document_started() {
1676         return $this->documentstarted;
1677     }
1678     /**
1679      * Given text in a variety of format codings, this function returns
1680      * the text as safe HTML or as plain text dependent on what is appropriate
1681      * for the download format. The default removes all tags.
1682      */
1683     function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL) {
1684         //use some whitespace to indicate where there was some line spacing.
1685         $text = str_replace(array('</p>', "\n", "\r"), '   ', $text);
1686         return strip_tags($text);
1687     }
1691 /**
1692  * @package   moodlecore
1693  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1694  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1695  */
1696 class table_spreadsheet_export_format_parent extends table_default_export_format_parent {
1697     var $currentrow;
1698     var $workbook;
1699     var $worksheet;
1700     /**
1701      * @var object format object - format for normal table cells
1702      */
1703     var $formatnormal;
1704     /**
1705      * @var object format object - format for header table cells
1706      */
1707     var $formatheaders;
1709     /**
1710      * should be overriden in child class.
1711      */
1712     var $fileextension;
1714     /**
1715      * This method will be overridden in the child class.
1716      */
1717     function define_workbook() {
1718     }
1720     function start_document($filename) {
1721         $filename = $filename.'.'.$this->fileextension;
1722         $this->define_workbook();
1723         // format types
1724         $this->formatnormal = $this->workbook->add_format();
1725         $this->formatnormal->set_bold(0);
1726         $this->formatheaders = $this->workbook->add_format();
1727         $this->formatheaders->set_bold(1);
1728         $this->formatheaders->set_align('center');
1729         // Sending HTTP headers
1730         $this->workbook->send($filename);
1731         $this->documentstarted = true;
1732     }
1734     function start_table($sheettitle) {
1735         $this->worksheet = $this->workbook->add_worksheet($sheettitle);
1736         $this->currentrow=0;
1737     }
1739     function output_headers($headers) {
1740         $colnum = 0;
1741         foreach ($headers as $item) {
1742             $this->worksheet->write($this->currentrow,$colnum,$item,$this->formatheaders);
1743             $colnum++;
1744         }
1745         $this->currentrow++;
1746     }
1748     function add_data($row) {
1749         $colnum = 0;
1750         foreach ($row as $item) {
1751             $this->worksheet->write($this->currentrow,$colnum,$item,$this->formatnormal);
1752             $colnum++;
1753         }
1754         $this->currentrow++;
1755         return true;
1756     }
1758     function add_seperator() {
1759         $this->currentrow++;
1760         return true;
1761     }
1763     function finish_table() {
1764     }
1766     function finish_document() {
1767         $this->workbook->close();
1768         exit;
1769     }
1773 /**
1774  * @package   moodlecore
1775  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1776  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1777  */
1778 class table_excel_export_format extends table_spreadsheet_export_format_parent {
1779     var $fileextension = 'xls';
1781     function define_workbook() {
1782         global $CFG;
1783         require_once("$CFG->libdir/excellib.class.php");
1784         // Creating a workbook
1785         $this->workbook = new MoodleExcelWorkbook("-");
1786     }
1791 /**
1792  * @package   moodlecore
1793  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1794  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1795  */
1796 class table_ods_export_format extends table_spreadsheet_export_format_parent {
1797     var $fileextension = 'ods';
1798     function define_workbook() {
1799         global $CFG;
1800         require_once("$CFG->libdir/odslib.class.php");
1801         // Creating a workbook
1802         $this->workbook = new MoodleODSWorkbook("-");
1803     }
1807 /**
1808  * @package   moodlecore
1809  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1810  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1811  */
1812 class table_text_export_format_parent extends table_default_export_format_parent {
1813     protected $seperator = "tab";
1814     protected $mimetype = 'text/tab-separated-values';
1815     protected $ext = '.txt';
1816     protected $myexporter;
1818     public function __construct() {
1819         $this->myexporter = new csv_export_writer($this->seperator, '"', $this->mimetype);
1820     }
1822     public function start_document($filename) {
1823         $this->filename = $filename;
1824         $this->documentstarted = true;
1825         $this->myexporter->set_filename($filename, $this->ext);
1826     }
1828     public function start_table($sheettitle) {
1829         //nothing to do here
1830     }
1832     public function output_headers($headers) {
1833         $this->myexporter->add_data($headers);
1834     }
1836     public function add_data($row) {
1837         $this->myexporter->add_data($row);
1838         return true;
1839     }
1841     public function finish_table() {
1842         //nothing to do here
1843     }
1845     public function finish_document() {
1846         $this->myexporter->download_file();
1847         exit;
1848     }
1850     /**
1851      * Format a row of data.
1852      * @param array $data
1853      */
1854     protected function format_row($data) {
1855         $escapeddata = array();
1856         foreach ($data as $value) {
1857             $escapeddata[] = '"' . str_replace('"', '""', $value) . '"';
1858         }
1859         return implode($this->seperator, $escapeddata) . "\n";
1860     }
1864 /**
1865  * @package   moodlecore
1866  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1867  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1868  */
1869 class table_tsv_export_format extends table_text_export_format_parent {
1870     protected $seperator = "tab";
1871     protected $mimetype = 'text/tab-separated-values';
1872     protected $ext = '.txt';
1875 require_once($CFG->libdir . '/csvlib.class.php');
1876 /**
1877  * @package   moodlecore
1878  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1879  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1880  */
1881 class table_csv_export_format extends table_text_export_format_parent {
1882     protected $seperator = "comma";
1883     protected $mimetype = 'text/csv';
1884     protected $ext = '.csv';
1887 /**
1888  * @package   moodlecore
1889  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1890  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1891  */
1892 class table_xhtml_export_format extends table_default_export_format_parent {
1893     function start_document($filename) {
1894         header("Content-Type: application/download\n");
1895         header("Content-Disposition: attachment; filename=\"$filename.html\"");
1896         header("Expires: 0");
1897         header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
1898         header("Pragma: public");
1899         //html headers
1900         echo <<<EOF
1901 <?xml version="1.0" encoding="UTF-8"?>
1902 <!DOCTYPE html
1903   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1904   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1906 <html xmlns="http://www.w3.org/1999/xhtml"
1907   xml:lang="en" lang="en">
1908 <head>
1909 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
1910 <style type="text/css">/*<![CDATA[*/
1912 .flexible th {
1913 white-space:normal;
1915 th.header, td.header, div.header {
1916 border-color:#DDDDDD;
1917 background-color:lightGrey;
1919 .flexible th {
1920 white-space:nowrap;
1922 th {
1923 font-weight:bold;
1926 .generaltable {
1927 border-style:solid;
1929 .generalbox {
1930 border-style:solid;
1932 body, table, td, th {
1933 font-family:Arial,Verdana,Helvetica,sans-serif;
1934 font-size:100%;
1936 td {
1937     border-style:solid;
1938     border-width:1pt;
1940 table {
1941     border-collapse:collapse;
1942     border-spacing:0pt;
1943     width:80%;
1944     margin:auto;
1947 h1, h2 {
1948     text-align:center;
1950 .bold {
1951 font-weight:bold;
1953 .mdl-align {
1954     text-align:center;
1956 /*]]>*/</style>
1957 <title>$filename</title>
1958 </head>
1959 <body>
1960 EOF;
1961         $this->documentstarted = true;
1962     }
1964     function start_table($sheettitle) {
1965         $this->table->sortable(false);
1966         $this->table->collapsible(false);
1967         echo "<h2>{$sheettitle}</h2>";
1968         $this->table->start_html();
1969     }
1971     function output_headers($headers) {
1972         $this->table->print_headers();
1973         echo html_writer::start_tag('tbody');
1974     }
1976     function add_data($row) {
1977         $this->table->print_row($row);
1978         return true;
1979     }
1981     function add_seperator() {
1982         $this->table->print_row(NULL);
1983         return true;
1984     }
1986     function finish_table() {
1987         $this->table->finish_html();
1988     }
1990     function finish_document() {
1991         echo "</body>\n</html>";
1992         exit;
1993     }
1995     function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL) {
1996         if (is_null($options)) {
1997             $options = new stdClass;
1998         }
1999         //some sensible defaults
2000         if (!isset($options->para)) {
2001             $options->para = false;
2002         }
2003         if (!isset($options->newlines)) {
2004             $options->newlines = false;
2005         }
2006         if (!isset($options->smiley)) {
2007             $options->smiley = false;
2008         }
2009         if (!isset($options->filter)) {
2010             $options->filter = false;
2011         }
2012         return format_text($text, $format, $options);
2013     }