MDL-57455 mod_data: Import and export tags
[moodle.git] / mod / data / export_form.php
1 <?php
3 if (!defined('MOODLE_INTERNAL')) {
4     die('Direct access to this script is forbidden!');
5 }
6 require_once($CFG->libdir . '/formslib.php');
7 require_once($CFG->libdir . '/csvlib.class.php');
9 class mod_data_export_form extends moodleform {
10     var $_datafields = array();
11     var $_cm;
12     var $_data;
14      // @param string $url: the url to post to
15      // @param array $datafields: objects in this database
16     public function __construct($url, $datafields, $cm, $data) {
17         $this->_datafields = $datafields;
18         $this->_cm = $cm;
19         $this->_data = $data;
20         parent::__construct($url);
21     }
23     /**
24      * Old syntax of class constructor. Deprecated in PHP7.
25      *
26      * @deprecated since Moodle 3.1
27      */
28     public function mod_data_export_form($url, $datafields, $cm, $data) {
29         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
30         self::__construct($url, $datafields, $cm, $data);
31     }
33     function definition() {
34         global $CFG;
35         $mform =& $this->_form;
36         $mform->addElement('header', 'notice', get_string('chooseexportformat', 'data'));
37         $choices = csv_import_reader::get_delimiter_list();
38         $key = array_search(';', $choices);
39         if (! $key === FALSE) {
40             // array $choices contains the semicolon -> drop it (because its encrypted form also contains a semicolon):
41             unset($choices[$key]);
42         }
43         $typesarray = array();
44         $str = get_string('csvwithselecteddelimiter', 'data');
45         $typesarray[] = $mform->createElement('radio', 'exporttype', null, $str . '&nbsp;', 'csv');
46         $typesarray[] = $mform->createElement('select', 'delimiter_name', null, $choices);
47         //temporarily commenting out Excel export option. See MDL-19864
48         //$typesarray[] = $mform->createElement('radio', 'exporttype', null, get_string('excel', 'data'), 'xls');
49         $typesarray[] = $mform->createElement('radio', 'exporttype', null, get_string('ods', 'data'), 'ods');
50         $mform->addGroup($typesarray, 'exportar', '', array(''), false);
51         $mform->addRule('exportar', null, 'required');
52         $mform->setDefault('exporttype', 'csv');
53         if (array_key_exists('cfg', $choices)) {
54             $mform->setDefault('delimiter_name', 'cfg');
55         } else if (get_string('listsep', 'langconfig') == ';') {
56             $mform->setDefault('delimiter_name', 'semicolon');
57         } else {
58             $mform->setDefault('delimiter_name', 'comma');
59         }
60         $mform->addElement('header', 'notice', get_string('chooseexportfields', 'data'));
61         $numfieldsthatcanbeselected = 0;
62         foreach($this->_datafields as $field) {
63             if($field->text_export_supported()) {
64                 $numfieldsthatcanbeselected++;
65                 $html = '<div title="' . s($field->field->description) . '" ' .
66                         'class="d-inline-block">' . $field->field->name . '</div>';
67                 $name = ' (' . $field->name() . ')';
68                 $mform->addElement('advcheckbox', 'field_' . $field->field->id, $html, $name, array('group' => 1));
69                 $mform->setDefault('field_' . $field->field->id, 1);
70             } else {
71                 $a = new stdClass();
72                 $a->fieldtype = $field->name();
73                 $str = get_string('unsupportedexport', 'data', $a);
74                 $mform->addElement('static', 'unsupported' . $field->field->id, $field->field->name, $str);
75             }
76         }
77         if ($numfieldsthatcanbeselected > 1) {
78             $this->add_checkbox_controller(1, null, null, 1);
79         }
80         $context = context_module::instance($this->_cm->id);
81         if (has_capability('mod/data:exportuserinfo', $context)) {
82             $mform->addElement('checkbox', 'exportuser', get_string('includeuserdetails', 'data'));
83         }
84         $mform->addElement('checkbox', 'exporttime', get_string('includetime', 'data'));
85         if ($this->_data->approval) {
86             $mform->addElement('checkbox', 'exportapproval', get_string('includeapproval', 'data'));
87         }
89         if (core_tag_tag::is_enabled('mod_data', 'data_records')) {
90             $mform->addElement('checkbox', 'exporttags', get_string('includetags', 'data'));
91         }
93         $this->add_action_buttons(true, get_string('exportentries', 'data'));
94     }
96 }