63e607eafdfe1a870fb0f87f1022cca2df55a2dd
[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 /**#@-*/
39 /**#@+
40  * Constants that indicate whether the paging bar for the table
41  * appears above or below the table.
42  */
43 define('TABLE_P_TOP',    1);
44 define('TABLE_P_BOTTOM', 2);
45 /**#@-*/
48 /**
49  * @package   moodlecore
50  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
51  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
52  */
53 class flexible_table {
55     var $uniqueid        = NULL;
56     var $attributes      = array();
57     var $headers         = array();
58     var $columns         = array();
59     var $column_style    = array();
60     var $column_class    = array();
61     var $column_suppress = array();
62     var $column_nosort   = array('userpic');
63     private $column_textsort = array();
64     var $setup           = false;
65     var $sess            = NULL;
66     var $baseurl         = NULL;
67     var $request         = array();
69     var $is_collapsible = false;
70     var $is_sortable    = false;
71     var $use_pages      = false;
72     var $use_initials   = false;
74     var $maxsortkeys = 2;
75     var $pagesize    = 30;
76     var $currpage    = 0;
77     var $totalrows   = 0;
78     var $sort_default_column = NULL;
79     var $sort_default_order  = SORT_ASC;
81     /**
82      * Array of positions in which to display download controls.
83      */
84     var $showdownloadbuttonsat= array(TABLE_P_TOP);
86     /**
87      * @var string Key of field returned by db query that is the id field of the
88      * user table or equivalent.
89      */
90     public $useridfield = 'id';
92     /**
93      * @var string which download plugin to use. Default '' means none - print
94      * html table with paging. Property set by is_downloading which typically
95      * passes in cleaned data from $
96      */
97     var $download  = '';
99     /**
100      * @var bool whether data is downloadable from table. Determines whether
101      * to display download buttons. Set by method downloadable().
102      */
103     var $downloadable = false;
105     /**
106      * @var string which download plugin to use. Default '' means none - print
107      * html table with paging.
108      */
109     var $defaultdownloadformat  = 'csv';
111     /**
112      * @var bool Has start output been called yet?
113      */
114     var $started_output = false;
116     var $exportclass = null;
118     /**
119      * Constructor
120      * @param int $uniqueid all tables have to have a unique id, this is used
121      *      as a key when storing table properties like sort order in the session.
122      */
123     function __construct($uniqueid) {
124         $this->uniqueid = $uniqueid;
125         $this->request  = array(
126             TABLE_VAR_SORT   => 'tsort',
127             TABLE_VAR_HIDE   => 'thide',
128             TABLE_VAR_SHOW   => 'tshow',
129             TABLE_VAR_IFIRST => 'tifirst',
130             TABLE_VAR_ILAST  => 'tilast',
131             TABLE_VAR_PAGE   => 'page',
132         );
133     }
135     /**
136      * Call this to pass the download type. Use :
137      *         $download = optional_param('download', '', PARAM_ALPHA);
138      * To get the download type. We assume that if you call this function with
139      * params that this table's data is downloadable, so we call is_downloadable
140      * for you (even if the param is '', which means no download this time.
141      * Also you can call this method with no params to get the current set
142      * download type.
143      * @param string $download download type. One of csv, tsv, xhtml, ods, etc
144      * @param string $filename filename for downloads without file extension.
145      * @param string $sheettitle title for downloaded data.
146      * @return string download type.  One of csv, tsv, xhtml, ods, etc
147      */
148     function is_downloading($download = null, $filename='', $sheettitle='') {
149         if ($download!==null) {
150             $this->sheettitle = $sheettitle;
151             $this->is_downloadable(true);
152             $this->download = $download;
153             $this->filename = clean_filename($filename);
154             $this->export_class_instance();
155         }
156         return $this->download;
157     }
159     /**
160      * Get, and optionally set, the export class.
161      * @param $exportclass (optional) if passed, set the table to use this export class.
162      * @return table_default_export_format_parent the export class in use (after any set).
163      */
164     function export_class_instance($exportclass = null) {
165         if (!is_null($exportclass)) {
166             $this->started_output = true;
167             $this->exportclass = $exportclass;
168             $this->exportclass->table = $this;
169         } else if (is_null($this->exportclass) && !empty($this->download)) {
170             $classname = 'table_'.$this->download.'_export_format';
171             $this->exportclass = new $classname($this);
172             if (!$this->exportclass->document_started()) {
173                 $this->exportclass->start_document($this->filename);
174             }
175         }
176         return $this->exportclass;
177     }
179     /**
180      * Probably don't need to call this directly. Calling is_downloading with a
181      * param automatically sets table as downloadable.
182      *
183      * @param bool $downloadable optional param to set whether data from
184      * table is downloadable. If ommitted this function can be used to get
185      * current state of table.
186      * @return bool whether table data is set to be downloadable.
187      */
188     function is_downloadable($downloadable = null) {
189         if ($downloadable !== null) {
190             $this->downloadable = $downloadable;
191         }
192         return $this->downloadable;
193     }
195     /**
196      * Where to show download buttons.
197      * @param array $showat array of postions in which to show download buttons.
198      * Containing TABLE_P_TOP and/or TABLE_P_BOTTOM
199      */
200     function show_download_buttons_at($showat) {
201         $this->showdownloadbuttonsat = $showat;
202     }
204     /**
205      * Sets the is_sortable variable to the given boolean, sort_default_column to
206      * the given string, and the sort_default_order to the given integer.
207      * @param bool $bool
208      * @param string $defaultcolumn
209      * @param int $defaultorder
210      * @return void
211      */
212     function sortable($bool, $defaultcolumn = NULL, $defaultorder = SORT_ASC) {
213         $this->is_sortable = $bool;
214         $this->sort_default_column = $defaultcolumn;
215         $this->sort_default_order  = $defaultorder;
216     }
218     /**
219      * Use text sorting functions for this column (required for text columns with Oracle).
220      * @param string column name
221      */
222     function text_sorting($column) {
223         $this->column_textsort[] = $column;
224     }
226     /**
227      * Do not sort using this column
228      * @param string column name
229      */
230     function no_sorting($column) {
231         $this->column_nosort[] = $column;
232     }
234     /**
235      * Is the column sortable?
236      * @param string column name, null means table
237      * @return bool
238      */
239     function is_sortable($column = null) {
240         if (empty($column)) {
241             return $this->is_sortable;
242         }
243         if (!$this->is_sortable) {
244             return false;
245         }
246         return !in_array($column, $this->column_nosort);
247     }
249     /**
250      * Sets the is_collapsible variable to the given boolean.
251      * @param bool $bool
252      * @return void
253      */
254     function collapsible($bool) {
255         $this->is_collapsible = $bool;
256     }
258     /**
259      * Sets the use_pages variable to the given boolean.
260      * @param bool $bool
261      * @return void
262      */
263     function pageable($bool) {
264         $this->use_pages = $bool;
265     }
267     /**
268      * Sets the use_initials variable to the given boolean.
269      * @param bool $bool
270      * @return void
271      */
272     function initialbars($bool) {
273         $this->use_initials = $bool;
274     }
276     /**
277      * Sets the pagesize variable to the given integer, the totalrows variable
278      * to the given integer, and the use_pages variable to true.
279      * @param int $perpage
280      * @param int $total
281      * @return void
282      */
283     function pagesize($perpage, $total) {
284         $this->pagesize  = $perpage;
285         $this->totalrows = $total;
286         $this->use_pages = true;
287     }
289     /**
290      * Assigns each given variable in the array to the corresponding index
291      * in the request class variable.
292      * @param array $variables
293      * @return void
294      */
295     function set_control_variables($variables) {
296         foreach ($variables as $what => $variable) {
297             if (isset($this->request[$what])) {
298                 $this->request[$what] = $variable;
299             }
300         }
301     }
303     /**
304      * Gives the given $value to the $attribute index of $this->attributes.
305      * @param string $attribute
306      * @param mixed $value
307      * @return void
308      */
309     function set_attribute($attribute, $value) {
310         $this->attributes[$attribute] = $value;
311     }
313     /**
314      * What this method does is set the column so that if the same data appears in
315      * consecutive rows, then it is not repeated.
316      *
317      * For example, in the quiz overview report, the fullname column is set to be suppressed, so
318      * that when one student has made multiple attempts, their name is only printed in the row
319      * for their first attempt.
320      * @param int $column the index of a column.
321      */
322     function column_suppress($column) {
323         if (isset($this->column_suppress[$column])) {
324             $this->column_suppress[$column] = true;
325         }
326     }
328     /**
329      * Sets the given $column index to the given $classname in $this->column_class.
330      * @param int $column
331      * @param string $classname
332      * @return void
333      */
334     function column_class($column, $classname) {
335         if (isset($this->column_class[$column])) {
336             $this->column_class[$column] = ' '.$classname; // This space needed so that classnames don't run together in the HTML
337         }
338     }
340     /**
341      * Sets the given $column index and $property index to the given $value in $this->column_style.
342      * @param int $column
343      * @param string $property
344      * @param mixed $value
345      * @return void
346      */
347     function column_style($column, $property, $value) {
348         if (isset($this->column_style[$column])) {
349             $this->column_style[$column][$property] = $value;
350         }
351     }
353     /**
354      * Sets all columns' $propertys to the given $value in $this->column_style.
355      * @param int $property
356      * @param string $value
357      * @return void
358      */
359     function column_style_all($property, $value) {
360         foreach (array_keys($this->columns) as $column) {
361             $this->column_style[$column][$property] = $value;
362         }
363     }
365     /**
366      * Sets $this->baseurl.
367      * @param moodle_url|string $url the url with params needed to call up this page
368      */
369     function define_baseurl($url) {
370         $this->baseurl = new moodle_url($url);
371     }
373     /**
374      * @param array $columns an array of identifying names for columns. If
375      * columns are sorted then column names must correspond to a field in sql.
376      */
377     function define_columns($columns) {
378         $this->columns = array();
379         $this->column_style = array();
380         $this->column_class = array();
381         $colnum = 0;
383         foreach ($columns as $column) {
384             $this->columns[$column]         = $colnum++;
385             $this->column_style[$column]    = array();
386             $this->column_class[$column]    = '';
387             $this->column_suppress[$column] = false;
388         }
389     }
391     /**
392      * @param array $headers numerical keyed array of displayed string titles
393      * for each column.
394      */
395     function define_headers($headers) {
396         $this->headers = $headers;
397     }
399     /**
400      * Must be called after table is defined. Use methods above first. Cannot
401      * use functions below till after calling this method.
402      * @return type?
403      */
404     function setup() {
405         global $SESSION, $CFG;
407         if (empty($this->columns) || empty($this->uniqueid)) {
408             return false;
409         }
411         if (!isset($SESSION->flextable)) {
412             $SESSION->flextable = array();
413         }
415         if (!isset($SESSION->flextable[$this->uniqueid])) {
416             $SESSION->flextable[$this->uniqueid] = new stdClass;
417             $SESSION->flextable[$this->uniqueid]->uniqueid = $this->uniqueid;
418             $SESSION->flextable[$this->uniqueid]->collapse = array();
419             $SESSION->flextable[$this->uniqueid]->sortby   = array();
420             $SESSION->flextable[$this->uniqueid]->i_first  = '';
421             $SESSION->flextable[$this->uniqueid]->i_last   = '';
422         }
424         $this->sess = &$SESSION->flextable[$this->uniqueid];
426         if (($showcol = optional_param($this->request[TABLE_VAR_SHOW], '', PARAM_ALPHANUMEXT)) &&
427                 isset($this->columns[$showcol])) {
428             $this->sess->collapse[$showcol] = false;
430         } else if (($hidecol = optional_param($this->request[TABLE_VAR_HIDE], '', PARAM_ALPHANUMEXT)) &&
431                 isset($this->columns[$hidecol])) {
432             $this->sess->collapse[$hidecol] = true;
433             if (array_key_exists($hidecol, $this->sess->sortby)) {
434                 unset($this->sess->sortby[$hidecol]);
435             }
436         }
438         // Now, update the column attributes for collapsed columns
439         foreach (array_keys($this->columns) as $column) {
440             if (!empty($this->sess->collapse[$column])) {
441                 $this->column_style[$column]['width'] = '10px';
442             }
443         }
445         if (($sortcol = optional_param($this->request[TABLE_VAR_SORT], '', PARAM_ALPHANUMEXT)) &&
446                 $this->is_sortable($sortcol) && empty($this->sess->collapse[$sortcol]) &&
447                 (isset($this->columns[$sortcol]) || in_array($sortcol, array('firstname', 'lastname')) && isset($this->columns['fullname']))) {
449             if (array_key_exists($sortcol, $this->sess->sortby)) {
450                 // This key already exists somewhere. Change its sortorder and bring it to the top.
451                 $sortorder = $this->sess->sortby[$sortcol] == SORT_ASC ? SORT_DESC : SORT_ASC;
452                 unset($this->sess->sortby[$sortcol]);
453                 $this->sess->sortby = array_merge(array($sortcol => $sortorder), $this->sess->sortby);
454             } else {
455                 // Key doesn't exist, so just add it to the beginning of the array, ascending order
456                 $this->sess->sortby = array_merge(array($sortcol => SORT_ASC), $this->sess->sortby);
457             }
459             // Finally, make sure that no more than $this->maxsortkeys are present into the array
460             $this->sess->sortby = array_slice($this->sess->sortby, 0, $this->maxsortkeys);
461         }
463         // 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.
464         // This prevents results from being returned in a random order if the only order by column contains equal values.
465         if (!empty($this->sort_default_column))  {
466             if (!array_key_exists($this->sort_default_column, $this->sess->sortby)) {
467                 $defaultsort = array($this->sort_default_column => $this->sort_default_order);
468                 $this->sess->sortby = array_merge($this->sess->sortby, $defaultsort);
469             }
470         }
472         $ilast = optional_param($this->request[TABLE_VAR_ILAST], null, PARAM_RAW);
473         if (!is_null($ilast) && ($ilast ==='' || strpos(get_string('alphabet', 'langconfig'), $ilast) !== false)) {
474             $this->sess->i_last = $ilast;
475         }
477         $ifirst = optional_param($this->request[TABLE_VAR_IFIRST], null, PARAM_RAW);
478         if (!is_null($ifirst) && ($ifirst === '' || strpos(get_string('alphabet', 'langconfig'), $ifirst) !== false)) {
479             $this->sess->i_first = $ifirst;
480         }
482         if (empty($this->baseurl)) {
483             debugging('You should set baseurl when using flexible_table.');
484             global $PAGE;
485             $this->baseurl = $PAGE->url;
486         }
488         $this->currpage = optional_param($this->request[TABLE_VAR_PAGE], 0, PARAM_INT);
489         $this->setup = true;
491         // Always introduce the "flexible" class for the table if not specified
492         if (empty($this->attributes)) {
493             $this->attributes['class'] = 'flexible';
494         } else if (!isset($this->attributes['class'])) {
495             $this->attributes['class'] = 'flexible';
496         } else if (!in_array('flexible', explode(' ', $this->attributes['class']))) {
497             $this->attributes['class'] = trim('flexible ' . $this->attributes['class']);
498         }
499     }
501     /**
502      * Get the order by clause from the session, for the table with id $uniqueid.
503      * @param string $uniqueid the identifier for a table.
504      * @return SQL fragment that can be used in an ORDER BY clause.
505      */
506     public static function get_sort_for_table($uniqueid) {
507         global $SESSION;
508         if (empty($SESSION->flextable[$uniqueid])) {
509            return '';
510         }
512         $sess = &$SESSION->flextable[$uniqueid];
513         if (empty($sess->sortby)) {
514             return '';
515         }
517         return self::construct_order_by($sess->sortby);
518     }
520     /**
521      * Prepare an an order by clause from the list of columns to be sorted.
522      * @param array $cols column name => SORT_ASC or SORT_DESC
523      * @return SQL fragment that can be used in an ORDER BY clause.
524      */
525     public static function construct_order_by($cols, $textsortcols=array()) {
526         global $DB;
527         $bits = array();
529         foreach ($cols as $column => $order) {
530             if (in_array($column, $textsortcols)) {
531                 $column = $DB->sql_order_by_text($column);
532             }
533             if ($order == SORT_ASC) {
534                 $bits[] = $column . ' ASC';
535             } else {
536                 $bits[] = $column . ' DESC';
537             }
538         }
540         return implode(', ', $bits);
541     }
543     /**
544      * @return SQL fragment that can be used in an ORDER BY clause.
545      */
546     public function get_sql_sort() {
547         return self::construct_order_by($this->get_sort_columns(), $this->column_textsort);
548     }
550     /**
551      * Get the columns to sort by, in the form required by {@link construct_order_by()}.
552      * @return array column name => SORT_... constant.
553      */
554     public function get_sort_columns() {
555         if (!$this->setup) {
556             throw new coding_exception('Cannot call get_sort_columns until you have called setup.');
557         }
559         if (empty($this->sess->sortby)) {
560             return array();
561         }
563         foreach ($this->sess->sortby as $column => $notused) {
564             if (isset($this->columns[$column])) {
565                 continue; // This column is OK.
566             }
567             if (in_array($column, array('firstname', 'lastname')) &&
568                     isset($this->columns['fullname'])) {
569                 continue; // This column is OK.
570             }
571             // This column is not OK.
572             unset($this->sess->sortby[$column]);
573         }
575         return $this->sess->sortby;
576     }
578     /**
579      * @return int the offset for LIMIT clause of SQL
580      */
581     function get_page_start() {
582         if (!$this->use_pages) {
583             return '';
584         }
585         return $this->currpage * $this->pagesize;
586     }
588     /**
589      * @return int the pagesize for LIMIT clause of SQL
590      */
591     function get_page_size() {
592         if (!$this->use_pages) {
593             return '';
594         }
595         return $this->pagesize;
596     }
598     /**
599      * @return string sql to add to where statement.
600      */
601     function get_sql_where() {
602         global $DB;
604         $conditions = array();
605         $params = array();
607         if (isset($this->columns['fullname'])) {
608             static $i = 0;
609             $i++;
611             if (!empty($this->sess->i_first)) {
612                 $conditions[] = $DB->sql_like('firstname', ':ifirstc'.$i, false, false);
613                 $params['ifirstc'.$i] = $this->sess->i_first.'%';
614             }
615             if (!empty($this->sess->i_last)) {
616                 $conditions[] = $DB->sql_like('lastname', ':ilastc'.$i, false, false);
617                 $params['ilastc'.$i] = $this->sess->i_last.'%';
618             }
619         }
621         return array(implode(" AND ", $conditions), $params);
622     }
624     /**
625      * Add a row of data to the table. This function takes an array with
626      * column names as keys.
627      * It ignores any elements with keys that are not defined as columns. It
628      * puts in empty strings into the row when there is no element in the passed
629      * array corresponding to a column in the table. It puts the row elements in
630      * the proper order.
631      * @param $rowwithkeys array
632      * @param string $classname CSS class name to add to this row's tr tag.
633      */
634     function add_data_keyed($rowwithkeys, $classname = '') {
635         $this->add_data($this->get_row_from_keyed($rowwithkeys), $classname);
636     }
638     /**
639      * Add a seperator line to table.
640      */
641     function add_separator() {
642         if (!$this->setup) {
643             return false;
644         }
645         $this->add_data(NULL);
646     }
648     /**
649      * This method actually directly echoes the row passed to it now or adds it
650      * to the download. If this is the first row and start_output has not
651      * already been called this method also calls start_output to open the table
652      * or send headers for the downloaded.
653      * Can be used as before. print_html now calls finish_html to close table.
654      *
655      * @param array $row a numerically keyed row of data to add to the table.
656      * @param string $classname CSS class name to add to this row's tr tag.
657      * @return bool success.
658      */
659     function add_data($row, $classname = '') {
660         if (!$this->setup) {
661             return false;
662         }
663         if (!$this->started_output) {
664             $this->start_output();
665         }
666         if ($this->exportclass!==null) {
667             if ($row === null) {
668                 $this->exportclass->add_seperator();
669             } else {
670                 $this->exportclass->add_data($row);
671             }
672         } else {
673             $this->print_row($row, $classname);
674         }
675         return true;
676     }
678     /**
679      * You should call this to finish outputting the table data after adding
680      * data to the table with add_data or add_data_keyed.
681      *
682      */
683     function finish_output($closeexportclassdoc = true) {
684         if ($this->exportclass!==null) {
685             $this->exportclass->finish_table();
686             if ($closeexportclassdoc) {
687                 $this->exportclass->finish_document();
688             }
689         } else {
690             $this->finish_html();
691         }
692     }
694     /**
695      * Hook that can be overridden in child classes to wrap a table in a form
696      * for example. Called only when there is data to display and not
697      * downloading.
698      */
699     function wrap_html_start() {
700     }
702     /**
703      * Hook that can be overridden in child classes to wrap a table in a form
704      * for example. Called only when there is data to display and not
705      * downloading.
706      */
707     function wrap_html_finish() {
708     }
710     /**
711      *
712      * @param array $row row of data from db used to make one row of the table.
713      * @return array one row for the table, added using add_data_keyed method.
714      */
715     function format_row($row) {
716         $formattedrow = array();
717         foreach (array_keys($this->columns) as $column) {
718             $colmethodname = 'col_'.$column;
719             if (method_exists($this, $colmethodname)) {
720                 $formattedcolumn = $this->$colmethodname($row);
721             } else {
722                 $formattedcolumn = $this->other_cols($column, $row);
723                 if ($formattedcolumn===NULL) {
724                     $formattedcolumn = $row->$column;
725                 }
726             }
727             $formattedrow[$column] = $formattedcolumn;
728         }
729         return $formattedrow;
730     }
732     /**
733      * Fullname is treated as a special columname in tablelib and should always
734      * be treated the same as the fullname of a user.
735      * @uses $this->useridfield if the userid field is not expected to be id
736      * then you need to override $this->useridfield to point at the correct
737      * field for the user id.
738      *
739      */
740     function col_fullname($row) {
741         global $COURSE, $CFG;
743         $name = fullname($row);
744         if ($this->download) {
745             return $name;
746         }
748         $userid = $row->{$this->useridfield};
749         if ($COURSE->id == SITEID) {
750             $profileurl = new moodle_url('/user/profile.php', array('id' => $userid));
751         } else {
752             $profileurl = new moodle_url('/user/view.php',
753                     array('id' => $userid, 'course' => $COURSE->id));
754         }
755         return html_writer::link($profileurl, $name);
756     }
758     /**
759      * You can override this method in a child class. See the description of
760      * build_table which calls this method.
761      */
762     function other_cols($column, $row) {
763         return NULL;
764     }
766     /**
767      * Used from col_* functions when text is to be displayed. Does the
768      * right thing - either converts text to html or strips any html tags
769      * depending on if we are downloading and what is the download type. Params
770      * are the same as format_text function in weblib.php but some default
771      * options are changed.
772      */
773     function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL) {
774         if (!$this->is_downloading()) {
775             if (is_null($options)) {
776                 $options = new stdClass;
777             }
778             //some sensible defaults
779             if (!isset($options->para)) {
780                 $options->para = false;
781             }
782             if (!isset($options->newlines)) {
783                 $options->newlines = false;
784             }
785             if (!isset($options->smiley)) {
786                 $options->smiley = false;
787             }
788             if (!isset($options->filter)) {
789                 $options->filter = false;
790             }
791             return format_text($text, $format, $options);
792         } else {
793             $eci =& $this->export_class_instance();
794             return $eci->format_text($text, $format, $options, $courseid);
795         }
796     }
797     /**
798      * This method is deprecated although the old api is still supported.
799      * @deprecated 1.9.2 - Jun 2, 2008
800      */
801     function print_html() {
802         if (!$this->setup) {
803             return false;
804         }
805         $this->finish_html();
806     }
808     /**
809      * This function is not part of the public api.
810      * @return string initial of first name we are currently filtering by
811      */
812     function get_initial_first() {
813         if (!$this->use_initials) {
814             return NULL;
815         }
817         return $this->sess->i_first;
818     }
820     /**
821      * This function is not part of the public api.
822      * @return string initial of last name we are currently filtering by
823      */
824     function get_initial_last() {
825         if (!$this->use_initials) {
826             return NULL;
827         }
829         return $this->sess->i_last;
830     }
832     /**
833      * Helper function, used by {@link print_initials_bar()} to output one initial bar.
834      * @param array $alpha of letters in the alphabet.
835      * @param string $current the currently selected letter.
836      * @param string $class class name to add to this initial bar.
837      * @param string $title the name to put in front of this initial bar.
838      * @param string $urlvar URL parameter name for this initial.
839      */
840     protected function print_one_initials_bar($alpha, $current, $class, $title, $urlvar) {
841         echo html_writer::start_tag('div', array('class' => 'initialbar ' . $class)) .
842                 $title . ' : ';
843         if ($current) {
844             echo html_writer::link($this->baseurl->out(false, array($urlvar => '')), get_string('all'));
845         } else {
846             echo html_writer::tag('strong', get_string('all'));
847         }
849         foreach ($alpha as $letter) {
850             if ($letter === $current) {
851                 echo html_writer::tag('strong', $letter);
852             } else {
853                 echo html_writer::link($this->baseurl->out(false, array($urlvar => $letter)), $letter);
854             }
855         }
857         echo html_writer::end_tag('div');
858     }
860     /**
861      * This function is not part of the public api.
862      */
863     function print_initials_bar() {
864         if ((!empty($this->sess->i_last) || !empty($this->sess->i_first) ||$this->use_initials)
865                     && isset($this->columns['fullname'])) {
867             $alpha  = explode(',', get_string('alphabet', 'langconfig'));
869             // Bar of first initials
870             if (!empty($this->sess->i_first)) {
871                 $ifirst = $this->sess->i_first;
872             } else {
873                 $ifirst = '';
874             }
875             $this->print_one_initials_bar($alpha, $ifirst, 'firstinitial',
876                     get_string('firstname'), $this->request[TABLE_VAR_IFIRST]);
878             // Bar of last initials
879             if (!empty($this->sess->i_last)) {
880                 $ilast = $this->sess->i_last;
881             } else {
882                 $ilast = '';
883             }
884             $this->print_one_initials_bar($alpha, $ilast, 'lastinitial',
885                     get_string('lastname'), $this->request[TABLE_VAR_ILAST]);
886         }
887     }
889     /**
890      * This function is not part of the public api.
891      */
892     function print_nothing_to_display() {
893         global $OUTPUT;
894         $this->print_initials_bar();
896         echo $OUTPUT->heading(get_string('nothingtodisplay'));
897     }
899     /**
900      * This function is not part of the public api.
901      */
902     function get_row_from_keyed($rowwithkeys) {
903         if (is_object($rowwithkeys)) {
904             $rowwithkeys = (array)$rowwithkeys;
905         }
906         $row = array();
907         foreach (array_keys($this->columns) as $column) {
908             if (isset($rowwithkeys[$column])) {
909                 $row [] = $rowwithkeys[$column];
910             } else {
911                 $row[] ='';
912             }
913         }
914         return $row;
915     }
916     /**
917      * This function is not part of the public api.
918      */
919     function get_download_menu() {
920         $allclasses= get_declared_classes();
921         $exportclasses = array();
922         foreach ($allclasses as $class) {
923             $matches = array();
924             if (preg_match('/^table\_([a-z]+)\_export\_format$/', $class, $matches)) {
925                 $type = $matches[1];
926                 $exportclasses[$type]= get_string("download$type", 'table');
927             }
928         }
929         return $exportclasses;
930     }
932     /**
933      * This function is not part of the public api.
934      */
935     function download_buttons() {
936         if ($this->is_downloadable() && !$this->is_downloading()) {
937             $downloadoptions = $this->get_download_menu();
938             $html = '<form action="'. $this->baseurl .'" method="post">';
939             $html .= '<div class="mdl-align">';
940             $html .= '<input type="submit" value="'.get_string('downloadas', 'table').'"/>';
941             $html .= html_writer::label(get_string('downloadoptions', 'table'), 'menudownload', false, array('class' => 'accesshide'));
942             $html .= html_writer::select($downloadoptions, 'download', $this->defaultdownloadformat, false);
943             $html .= '</div></form>';
945             return $html;
946         } else {
947             return '';
948         }
949     }
950     /**
951      * This function is not part of the public api.
952      * You don't normally need to call this. It is called automatically when
953      * needed when you start adding data to the table.
954      *
955      */
956     function start_output() {
957         $this->started_output = true;
958         if ($this->exportclass!==null) {
959             $this->exportclass->start_table($this->sheettitle);
960             $this->exportclass->output_headers($this->headers);
961         } else {
962             $this->start_html();
963             $this->print_headers();
964         }
965     }
967     /**
968      * This function is not part of the public api.
969      */
970     function print_row($row, $classname = '') {
971         static $suppress_lastrow = NULL;
972         static $oddeven = 1;
973         $rowclasses = array('r' . $oddeven);
974         $oddeven = $oddeven ? 0 : 1;
976         if ($classname) {
977             $rowclasses[] = $classname;
978         }
980         echo html_writer::start_tag('tr', array('class' => implode(' ', $rowclasses)));
982         // If we have a separator, print it
983         if ($row === NULL) {
984             $colcount = count($this->columns);
985             echo html_writer::tag('td', html_writer::tag('div', '',
986                     array('class' => 'tabledivider')), array('colspan' => $colcount));
988         } else {
989             $colbyindex = array_flip($this->columns);
990             foreach ($row as $index => $data) {
991                 $column = $colbyindex[$index];
993                 if (empty($this->sess->collapse[$column])) {
994                     if ($this->column_suppress[$column] && $suppress_lastrow !== NULL && $suppress_lastrow[$index] === $data) {
995                         $content = '&nbsp;';
996                     } else {
997                         $content = $data;
998                     }
999                 } else {
1000                     $content = '&nbsp;';
1001                 }
1003                 echo html_writer::tag('td', $content, array(
1004                         'class' => 'cell c' . $index . $this->column_class[$column],
1005                         'style' => $this->make_styles_string($this->column_style[$column])));
1006             }
1007         }
1009         echo html_writer::end_tag('tr');
1011         $suppress_enabled = array_sum($this->column_suppress);
1012         if ($suppress_enabled) {
1013             $suppress_lastrow = $row;
1014         }
1015     }
1017     /**
1018      * This function is not part of the public api.
1019      */
1020     function finish_html() {
1021         global $OUTPUT;
1022         if (!$this->started_output) {
1023             //no data has been added to the table.
1024             $this->print_nothing_to_display();
1026         } else {
1027             echo html_writer::end_tag('table');
1028             echo html_writer::end_tag('div');
1029             $this->wrap_html_finish();
1031             // Paging bar
1032             if(in_array(TABLE_P_BOTTOM, $this->showdownloadbuttonsat)) {
1033                 echo $this->download_buttons();
1034             }
1036             if($this->use_pages) {
1037                 $pagingbar = new paging_bar($this->totalrows, $this->currpage, $this->pagesize, $this->baseurl);
1038                 $pagingbar->pagevar = $this->request[TABLE_VAR_PAGE];
1039                 echo $OUTPUT->render($pagingbar);
1040             }
1041         }
1042     }
1044     /**
1045      * Generate the HTML for the collapse/uncollapse icon. This is a helper method
1046      * used by {@link print_headers()}.
1047      * @param string $column the column name, index into various names.
1048      * @param int $index numerical index of the column.
1049      * @return string HTML fragment.
1050      */
1051     protected function show_hide_link($column, $index) {
1052         global $OUTPUT;
1053         // Some headers contain <br /> tags, do not include in title, hence the
1054         // strip tags.
1056         if (!empty($this->sess->collapse[$column])) {
1057             return html_writer::link($this->baseurl->out(false, array($this->request[TABLE_VAR_SHOW] => $column)),
1058                     html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/switch_plus'), 'alt' => get_string('show'))),
1059                     array('title' => get_string('show') . ' ' . strip_tags($this->headers[$index])));
1061         } else if ($this->headers[$index] !== NULL) {
1062             return html_writer::link($this->baseurl->out(false, array($this->request[TABLE_VAR_HIDE] => $column)),
1063                     html_writer::empty_tag('img', array('src' => $OUTPUT->pix_url('t/switch_minus'), 'alt' => get_string('hide'))),
1064                     array('title' => get_string('hide') . ' ' . strip_tags($this->headers[$index])));
1065         }
1066     }
1068     /**
1069      * This function is not part of the public api.
1070      */
1071     function print_headers() {
1072         global $CFG, $OUTPUT;
1074         echo html_writer::start_tag('tr');
1075         foreach ($this->columns as $column => $index) {
1077             $icon_hide = '';
1078             if ($this->is_collapsible) {
1079                 $icon_hide = $this->show_hide_link($column, $index);
1080             }
1082             $primary_sort_column = '';
1083             $primary_sort_order  = '';
1084             if (reset($this->sess->sortby)) {
1085                 $primary_sort_column = key($this->sess->sortby);
1086                 $primary_sort_order  = current($this->sess->sortby);
1087             }
1089             switch ($column) {
1091                 case 'fullname':
1092                 if ($this->is_sortable($column)) {
1093                     $firstnamesortlink = $this->sort_link(get_string('firstname'),
1094                             'firstname', $primary_sort_column === 'firstname', $primary_sort_order);
1096                     $lastnamesortlink = $this->sort_link(get_string('lastname'),
1097                             'lastname', $primary_sort_column === 'lastname', $primary_sort_order);
1099                     $override = new stdClass();
1100                     $override->firstname = 'firstname';
1101                     $override->lastname = 'lastname';
1102                     $fullnamelanguage = get_string('fullnamedisplay', '', $override);
1104                     if (($CFG->fullnamedisplay == 'firstname lastname') or
1105                         ($CFG->fullnamedisplay == 'firstname') or
1106                         ($CFG->fullnamedisplay == 'language' and $fullnamelanguage == 'firstname lastname' )) {
1107                         $this->headers[$index] = $firstnamesortlink . ' / ' . $lastnamesortlink;
1108                     } else {
1109                         $this->headers[$index] = $lastnamesortlink . ' / ' . $firstnamesortlink;
1110                     }
1111                 }
1112                 break;
1114                 case 'userpic':
1115                     // do nothing, do not display sortable links
1116                 break;
1118                 default:
1119                 if ($this->is_sortable($column)) {
1120                     $this->headers[$index] = $this->sort_link($this->headers[$index],
1121                             $column, $primary_sort_column == $column, $primary_sort_order);
1122                 }
1123             }
1125             $attributes = array(
1126                 'class' => 'header c' . $index . $this->column_class[$column],
1127                 'scope' => 'col',
1128             );
1129             if ($this->headers[$index] === NULL) {
1130                 $content = '&nbsp;';
1131             } else if (!empty($this->sess->collapse[$column])) {
1132                 $content = $icon_hide;
1133             } else {
1134                 if (is_array($this->column_style[$column])) {
1135                     $attributes['style'] = $this->make_styles_string($this->column_style[$column]);
1136                 }
1137                 $content = $this->headers[$index] . html_writer::tag('div',
1138                         $icon_hide, array('class' => 'commands'));
1139             }
1140             echo html_writer::tag('th', $content, $attributes);
1141         }
1143         echo html_writer::end_tag('tr');
1144     }
1146     /**
1147      * Generate the HTML for the sort icon. This is a helper method used by {@link sort_link()}.
1148      * @param bool $isprimary whether an icon is needed (it is only needed for the primary sort column.)
1149      * @param int $order SORT_ASC or SORT_DESC
1150      * @return string HTML fragment.
1151      */
1152     protected function sort_icon($isprimary, $order) {
1153         global $OUTPUT;
1155         if (!$isprimary) {
1156             return '';
1157         }
1159         if ($order == SORT_ASC) {
1160             return html_writer::empty_tag('img',
1161                     array('src' => $OUTPUT->pix_url('t/down'), 'alt' => get_string('asc')));
1162         } else {
1163             return html_writer::empty_tag('img',
1164                     array('src' => $OUTPUT->pix_url('t/up'), 'alt' => get_string('desc')));
1165         }
1166     }
1168     /**
1169      * Generate the correct tool tip for changing the sort order. This is a
1170      * helper method used by {@link sort_link()}.
1171      * @param bool $isprimary whether the is column is the current primary sort column.
1172      * @param int $order SORT_ASC or SORT_DESC
1173      * @return string the correct title.
1174      */
1175     protected function sort_order_name($isprimary, $order) {
1176         if ($isprimary && $order != SORT_ASC) {
1177             return get_string('desc');
1178         } else {
1179             return get_string('asc');
1180         }
1181     }
1183     /**
1184      * Generate the HTML for the sort link. This is a helper method used by {@link print_headers()}.
1185      * @param string $text the text for the link.
1186      * @param string $column the column name, may be a fake column like 'firstname' or a real one.
1187      * @param bool $isprimary whether the is column is the current primary sort column.
1188      * @param int $order SORT_ASC or SORT_DESC
1189      * @return string HTML fragment.
1190      */
1191     protected function sort_link($text, $column, $isprimary, $order) {
1192         return html_writer::link($this->baseurl->out(false,
1193                 array($this->request[TABLE_VAR_SORT] => $column)),
1194                 $text . get_accesshide(get_string('sortby') . ' ' .
1195                 $text . ' ' . $this->sort_order_name($isprimary, $order))) . ' ' .
1196                 $this->sort_icon($isprimary, $order);
1197     }
1199     /**
1200      * This function is not part of the public api.
1201      */
1202     function start_html() {
1203         global $OUTPUT;
1204         // Do we need to print initial bars?
1205         $this->print_initials_bar();
1207         // Paging bar
1208         if ($this->use_pages) {
1209             $pagingbar = new paging_bar($this->totalrows, $this->currpage, $this->pagesize, $this->baseurl);
1210             $pagingbar->pagevar = $this->request[TABLE_VAR_PAGE];
1211             echo $OUTPUT->render($pagingbar);
1212         }
1214         if (in_array(TABLE_P_TOP, $this->showdownloadbuttonsat)) {
1215             echo $this->download_buttons();
1216         }
1218         $this->wrap_html_start();
1219         // Start of main data table
1221         echo html_writer::start_tag('div', array('class' => 'no-overflow'));
1222         echo html_writer::start_tag('table', $this->attributes);
1224     }
1226     /**
1227      * This function is not part of the public api.
1228      * @param array $styles CSS-property => value
1229      * @return string values suitably to go in a style="" attribute in HTML.
1230      */
1231     function make_styles_string($styles) {
1232         if (empty($styles)) {
1233             return null;
1234         }
1236         $string = '';
1237         foreach($styles as $property => $value) {
1238             $string .= $property . ':' . $value . ';';
1239         }
1240         return $string;
1241     }
1245 /**
1246  * @package   moodlecore
1247  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1248  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1249  */
1250 class table_sql extends flexible_table {
1252     public $countsql = NULL;
1253     public $countparams = NULL;
1254     /**
1255      * @var object sql for querying db. Has fields 'fields', 'from', 'where', 'params'.
1256      */
1257     public $sql = NULL;
1258     /**
1259      * @var array Data fetched from the db.
1260      */
1261     public $rawdata = NULL;
1263     /**
1264      * @var bool Overriding default for this.
1265      */
1266     public $is_sortable    = true;
1267     /**
1268      * @var bool Overriding default for this.
1269      */
1270     public $is_collapsible = true;
1272     /**
1273      * @param string $uniqueid a string identifying this table.Used as a key in
1274      *                          session  vars.
1275      */
1276     function __construct($uniqueid) {
1277         parent::__construct($uniqueid);
1278         // some sensible defaults
1279         $this->set_attribute('cellspacing', '0');
1280         $this->set_attribute('class', 'generaltable generalbox');
1281     }
1283     /**
1284      * Take the data returned from the db_query and go through all the rows
1285      * processing each col using either col_{columnname} method or other_cols
1286      * method or if other_cols returns NULL then put the data straight into the
1287      * table.
1288      */
1289     function build_table() {
1290         if ($this->rawdata) {
1291             foreach ($this->rawdata as $row) {
1292                 $formattedrow = $this->format_row($row);
1293                 $this->add_data_keyed($formattedrow,
1294                         $this->get_row_class($row));
1295             }
1296         }
1297     }
1299     /**
1300      * Get any extra classes names to add to this row in the HTML.
1301      * @param $row array the data for this row.
1302      * @return string added to the class="" attribute of the tr.
1303      */
1304     function get_row_class($row) {
1305         return '';
1306     }
1308     /**
1309      * This is only needed if you want to use different sql to count rows.
1310      * Used for example when perhaps all db JOINS are not needed when counting
1311      * records. You don't need to call this function the count_sql
1312      * will be generated automatically.
1313      *
1314      * We need to count rows returned by the db seperately to the query itself
1315      * as we need to know how many pages of data we have to display.
1316      */
1317     function set_count_sql($sql, array $params = NULL) {
1318         $this->countsql = $sql;
1319         $this->countparams = $params;
1320     }
1322     /**
1323      * Set the sql to query the db. Query will be :
1324      *      SELECT $fields FROM $from WHERE $where
1325      * Of course you can use sub-queries, JOINS etc. by putting them in the
1326      * appropriate clause of the query.
1327      */
1328     function set_sql($fields, $from, $where, array $params = NULL) {
1329         $this->sql = new stdClass();
1330         $this->sql->fields = $fields;
1331         $this->sql->from = $from;
1332         $this->sql->where = $where;
1333         $this->sql->params = $params;
1334     }
1336     /**
1337      * Query the db. Store results in the table object for use by build_table.
1338      *
1339      * @param int $pagesize size of page for paginated displayed table.
1340      * @param bool $useinitialsbar do you want to use the initials bar. Bar
1341      * will only be used if there is a fullname column defined for the table.
1342      */
1343     function query_db($pagesize, $useinitialsbar=true) {
1344         global $DB;
1345         if (!$this->is_downloading()) {
1346             if ($this->countsql === NULL) {
1347                 $this->countsql = 'SELECT COUNT(1) FROM '.$this->sql->from.' WHERE '.$this->sql->where;
1348                 $this->countparams = $this->sql->params;
1349             }
1350             $grandtotal = $DB->count_records_sql($this->countsql, $this->countparams);
1351             if ($useinitialsbar && !$this->is_downloading()) {
1352                 $this->initialbars($grandtotal > $pagesize);
1353             }
1355             list($wsql, $wparams) = $this->get_sql_where();
1356             if ($wsql) {
1357                 $this->countsql .= ' AND '.$wsql;
1358                 $this->countparams = array_merge($this->countparams, $wparams);
1360                 $this->sql->where .= ' AND '.$wsql;
1361                 $this->sql->params = array_merge($this->sql->params, $wparams);
1363                 $total  = $DB->count_records_sql($this->countsql, $this->countparams);
1364             } else {
1365                 $total = $grandtotal;
1366             }
1368             $this->pagesize($pagesize, $total);
1369         }
1371         // Fetch the attempts
1372         $sort = $this->get_sql_sort();
1373         if ($sort) {
1374             $sort = "ORDER BY $sort";
1375         }
1376         $sql = "SELECT
1377                 {$this->sql->fields}
1378                 FROM {$this->sql->from}
1379                 WHERE {$this->sql->where}
1380                 {$sort}";
1382         if (!$this->is_downloading()) {
1383             $this->rawdata = $DB->get_records_sql($sql, $this->sql->params, $this->get_page_start(), $this->get_page_size());
1384         } else {
1385             $this->rawdata = $DB->get_records_sql($sql, $this->sql->params);
1386         }
1387     }
1389     /**
1390      * Convenience method to call a number of methods for you to display the
1391      * table.
1392      */
1393     function out($pagesize, $useinitialsbar, $downloadhelpbutton='') {
1394         global $DB;
1395         if (!$this->columns) {
1396             $onerow = $DB->get_record_sql("SELECT {$this->sql->fields} FROM {$this->sql->from} WHERE {$this->sql->where}", $this->sql->params);
1397             //if columns is not set then define columns as the keys of the rows returned
1398             //from the db.
1399             $this->define_columns(array_keys((array)$onerow));
1400             $this->define_headers(array_keys((array)$onerow));
1401         }
1402         $this->setup();
1403         $this->query_db($pagesize, $useinitialsbar);
1404         $this->build_table();
1405         $this->finish_output();
1406     }
1410 /**
1411  * @package   moodlecore
1412  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1413  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1414  */
1415 class table_default_export_format_parent {
1416     /**
1417      * @var flexible_table or child class reference pointing to table class
1418      * object from which to export data.
1419      */
1420     var $table;
1422     /**
1423      * @var bool output started. Keeps track of whether any output has been
1424      * started yet.
1425      */
1426     var $documentstarted = false;
1427     function table_default_export_format_parent(&$table) {
1428         $this->table =& $table;
1429     }
1431     function set_table(&$table) {
1432         $this->table =& $table;
1433     }
1435     function add_data($row) {
1436         return false;
1437     }
1439     function add_seperator() {
1440         return false;
1441     }
1443     function document_started() {
1444         return $this->documentstarted;
1445     }
1446     /**
1447      * Given text in a variety of format codings, this function returns
1448      * the text as safe HTML or as plain text dependent on what is appropriate
1449      * for the download format. The default removes all tags.
1450      */
1451     function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL) {
1452         //use some whitespace to indicate where there was some line spacing.
1453         $text = str_replace(array('</p>', "\n", "\r"), '   ', $text);
1454         return strip_tags($text);
1455     }
1459 /**
1460  * @package   moodlecore
1461  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1462  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1463  */
1464 class table_spreadsheet_export_format_parent extends table_default_export_format_parent {
1465     var $rownum;
1466     var $workbook;
1467     var $worksheet;
1468     /**
1469      * @var object format object - format for normal table cells
1470      */
1471     var $formatnormal;
1472     /**
1473      * @var object format object - format for header table cells
1474      */
1475     var $formatheaders;
1477     /**
1478      * should be overriden in child class.
1479      */
1480     var $fileextension;
1482     /**
1483      * This method will be overridden in the child class.
1484      */
1485     function define_workbook() {
1486     }
1488     function start_document($filename) {
1489         $filename = $filename.'.'.$this->fileextension;
1490         $this->define_workbook();
1491         // format types
1492         $this->formatnormal =& $this->workbook->add_format();
1493         $this->formatnormal->set_bold(0);
1494         $this->formatheaders =& $this->workbook->add_format();
1495         $this->formatheaders->set_bold(1);
1496         $this->formatheaders->set_align('center');
1497         // Sending HTTP headers
1498         $this->workbook->send($filename);
1499         $this->documentstarted = true;
1500     }
1502     function start_table($sheettitle) {
1503         $this->worksheet = $this->workbook->add_worksheet($sheettitle);
1504         $this->rownum=0;
1505     }
1507     function output_headers($headers) {
1508         $colnum = 0;
1509         foreach ($headers as $item) {
1510             $this->worksheet->write($this->rownum,$colnum,$item,$this->formatheaders);
1511             $colnum++;
1512         }
1513         $this->rownum++;
1514     }
1516     function add_data($row) {
1517         $colnum = 0;
1518         foreach ($row as $item) {
1519             $this->worksheet->write($this->rownum,$colnum,$item,$this->formatnormal);
1520             $colnum++;
1521         }
1522         $this->rownum++;
1523         return true;
1524     }
1526     function add_seperator() {
1527         $this->rownum++;
1528         return true;
1529     }
1531     function finish_table() {
1532     }
1534     function finish_document() {
1535         $this->workbook->close();
1536         exit;
1537     }
1541 /**
1542  * @package   moodlecore
1543  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1544  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1545  */
1546 class table_excel_export_format extends table_spreadsheet_export_format_parent {
1547     var $fileextension = 'xls';
1549     function define_workbook() {
1550         global $CFG;
1551         require_once("$CFG->libdir/excellib.class.php");
1552         // Creating a workbook
1553         $this->workbook = new MoodleExcelWorkbook("-");
1554     }
1559 /**
1560  * @package   moodlecore
1561  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1562  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1563  */
1564 class table_ods_export_format extends table_spreadsheet_export_format_parent {
1565     var $fileextension = 'ods';
1566     function define_workbook() {
1567         global $CFG;
1568         require_once("$CFG->libdir/odslib.class.php");
1569         // Creating a workbook
1570         $this->workbook = new MoodleODSWorkbook("-");
1571     }
1575 /**
1576  * @package   moodlecore
1577  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1578  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1579  */
1580 class table_text_export_format_parent extends table_default_export_format_parent {
1581     protected $seperator = "\t";
1582     protected $mimetype = 'text/tab-separated-values';
1583     protected $ext = '.txt';
1585     public function start_document($filename) {
1586         $this->filename = $filename . $this->ext;
1587         header('Content-Type: ' . $this->mimetype . '; charset=UTF-8');
1588         header('Content-Disposition: attachment; filename="' . $this->filename . '"');
1589         header('Expires: 0');
1590         header('Cache-Control: must-revalidate,post-check=0,pre-check=0');
1591         header('Pragma: public');
1592         $this->documentstarted = true;
1593     }
1595     public function start_table($sheettitle) {
1596         //nothing to do here
1597     }
1599     public function output_headers($headers) {
1600         echo $this->format_row($headers);
1601     }
1603     public function add_data($row) {
1604         echo $this->format_row($row);
1605         return true;
1606     }
1608     public function finish_table() {
1609         echo "\n\n";
1610     }
1612     public function finish_document() {
1613         exit;
1614     }
1616     /**
1617      * Format a row of data.
1618      * @param array $data
1619      */
1620     protected function format_row($data) {
1621         $escapeddata = array();
1622         foreach ($data as $value) {
1623             $escapeddata[] = '"' . str_replace('"', '""', $value) . '"';
1624         }
1625         return implode($this->seperator, $escapeddata) . "\n";
1626     }
1630 /**
1631  * @package   moodlecore
1632  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1633  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1634  */
1635 class table_tsv_export_format extends table_text_export_format_parent {
1636     protected $seperator = "\t";
1637     protected $mimetype = 'text/tab-separated-values';
1638     protected $ext = '.txt';
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_csv_export_format extends table_text_export_format_parent {
1648     protected $seperator = ",";
1649     protected $mimetype = 'text/csv';
1650     protected $ext = '.csv';
1654 /**
1655  * @package   moodlecore
1656  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1657  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1658  */
1659 class table_xhtml_export_format extends table_default_export_format_parent {
1660     function start_document($filename) {
1661         header("Content-Type: application/download\n");
1662         header("Content-Disposition: attachment; filename=\"$filename.html\"");
1663         header("Expires: 0");
1664         header("Cache-Control: must-revalidate,post-check=0,pre-check=0");
1665         header("Pragma: public");
1666         //html headers
1667         echo <<<EOF
1668 <?xml version="1.0" encoding="UTF-8"?>
1669 <!DOCTYPE html
1670   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1671   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1673 <html xmlns="http://www.w3.org/1999/xhtml"
1674   xml:lang="en" lang="en">
1675 <head>
1676 <style type="text/css">/*<![CDATA[*/
1678 .flexible th {
1679 white-space:normal;
1681 th.header, td.header, div.header {
1682 border-color:#DDDDDD;
1683 background-color:lightGrey;
1685 .flexible th {
1686 white-space:nowrap;
1688 th {
1689 font-weight:bold;
1692 .generaltable {
1693 border-style:solid;
1695 .generalbox {
1696 border-style:solid;
1698 body, table, td, th {
1699 font-family:Arial,Verdana,Helvetica,sans-serif;
1700 font-size:100%;
1702 td {
1703     border-style:solid;
1704     border-width:1pt;
1706 table {
1707     border-collapse:collapse;
1708     border-spacing:0pt;
1709     width:80%;
1710     margin:auto;
1713 h1, h2 {
1714     text-align:center;
1716 .bold {
1717 font-weight:bold;
1719 .mdl-align {
1720     text-align:center;
1722 /*]]>*/</style>
1723 <title>$filename</title>
1724 </head>
1725 <body>
1726 EOF;
1727         $this->documentstarted = true;
1728     }
1730     function start_table($sheettitle) {
1731         $this->table->sortable(false);
1732         $this->table->collapsible(false);
1733         echo "<h2>{$sheettitle}</h2>";
1734         $this->table->start_html();
1735     }
1737     function output_headers($headers) {
1738         $this->table->print_headers();
1739     }
1741     function add_data($row) {
1742         $this->table->print_row($row);
1743         return true;
1744     }
1746     function add_seperator() {
1747         $this->table->print_row(NULL);
1748         return true;
1749     }
1751     function finish_table() {
1752         $this->table->finish_html();
1753     }
1755     function finish_document() {
1756         echo "</body>\n</html>";
1757         exit;
1758     }
1760     function format_text($text, $format=FORMAT_MOODLE, $options=NULL, $courseid=NULL) {
1761         if (is_null($options)) {
1762             $options = new stdClass;
1763         }
1764         //some sensible defaults
1765         if (!isset($options->para)) {
1766             $options->para = false;
1767         }
1768         if (!isset($options->newlines)) {
1769             $options->newlines = false;
1770         }
1771         if (!isset($options->smiley)) {
1772             $options->smiley = false;
1773         }
1774         if (!isset($options->filter)) {
1775             $options->filter = false;
1776         }
1777         return format_text($text, $format, $options);
1778     }