Merge branch 'MDL-55320-master-fix2' of https://github.com/lameze/moodle
[moodle.git] / mod / data / tests / generator / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Data generator class for mod_data.
19  *
20  * @package    mod_data
21  * @category   test
22  * @copyright  2012 Petr Skoda {@link http://skodak.org}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Data generator class for mod_data.
31  *
32  * Currently, the field types in the ignoredfieldtypes array aren't supported.
33  *
34  * @package    mod_data
35  * @category   test
36  * @copyright  2012 Petr Skoda {@link http://skodak.org}
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class mod_data_generator extends testing_module_generator {
41     /**
42      * @var int keep track of how many database fields have been created.
43      */
44     protected $databasefieldcount = 0;
46     /**
47      * @var int keep track of how many database records have been created.
48      */
49     protected $databaserecordcount = 0;
51     /**
52      * @var The field types which not handled by the generator as of now.
53      */
54     protected $ignoredfieldtypes = array('latlong', 'file', 'picture');
57     /**
58      * To be called from data reset code only,
59      * do not use in tests.
60      * @return void
61      */
62     public function reset() {
63         $this->databasefieldcount = 0;
64         $this->databaserecordcount = 0;
66         parent::reset();
67     }
69     /**
70      * Creates a mod_data instance
71      *
72      * @param array $record
73      * @param array $options
74      * @return StdClass
75      */
76     public function create_instance($record = null, array $options = null) {
77         // Note, the parent class does not type $record to cast to array and then to object.
78         $record = (object) (array) $record;
80         if (!isset($record->assessed)) {
81             $record->assessed = 0;
82         }
83         if (!isset($record->scale)) {
84             $record->scale = 0;
85         }
87         return parent::create_instance((array) $record, $options);
88     }
90     /**
91      * Creates a field for a mod_data instance.
92      * Currently, the field types in the ignoredfieldtypes array aren't supported.
93      *
94      * @param StdClass $record
95      * @param mod_data $data
96      * @return data_field_{type}
97      */
98     public function create_field(stdClass $record = null, $data = null) {
99         $record = (array) $record;
101         if (in_array($record['type'], $this->ignoredfieldtypes)) {
102             throw new coding_exception('$record\'s type value must not be same as values in ignoredfieldtypes
103                     in phpunit_util::create_field()');
104             return false;
105         }
107         $this->databasefieldcount++;
109         if (!isset($data->course)) {
110             throw new coding_exception('course must be present in phpunit_util::create_field() $data');
111         }
113         if (!isset($data->id)) {
114             throw new coding_exception('dataid must be present in phpunit_util::create_field() $data');
115         } else {
116             $record['dataid'] = $data->id;
117         }
119         if (!isset($record['type'])) {
120             throw new coding_exception('type must be present in phpunit_util::create_field() $record');
121         }
123         if (!isset($record['required'])) {
124             $record['required'] = 0;
125         }
127         if (!isset($record['name'])) {
128             $record['name'] = "testField - " . $this->databasefieldcount;
129         }
131         if (!isset($record['description'])) {
132             $record['description'] = " This is testField - " . $this->databasefieldcount;
133         }
135         if (!isset($record['param1'])) {
136             if (in_array($record['type'], array('checkbox', 'radiobutton'))) {
137                 $record['param1'] = implode("\n", array('opt1', 'opt2', 'opt3', 'opt4'));
138             } else if (in_array($record['type'], array('multimenu', 'menu'))) {
139                 $record['param1'] = implode("\n", array('menu1', 'menu2', 'menu3', 'menu4'));
140             } else if (($record['type'] === 'text') || ($record['type'] === 'url')) {
141                 $record['param1'] = 1;
142             } else {
143                 $record['param1'] = '';
144             }
145         }
147         if (!isset($record['param2'])) {
149             if ($record['type'] === 'textarea') {
150                 $record['param2'] = 60;
151             } else {
152                 $record['param2'] = '';
153             }
154         }
156         if (!isset($record['param3'])) {
158             if (($record['type'] === 'textarea')) {
159                 $record['param3'] = 35;
160             } else {
161                 $record['param3'] = '';
162             }
163         }
165         if (!isset($record['param4'])) {
167             if (($record['type'] === 'textarea')) {
168                 $record['param4'] = 1;
169             }
170         }
172         if (!isset($record['param5'])) {
173             if (($record['type'] === 'textarea')) {
174                 $record['param5'] = 0;
175             }
176         }
178         $record = (object) $record;
180         $field = data_get_field($record, $data);
181         $field->insert_field();
183         data_generate_default_template($data, 'addtemplate', 0, false, true);
185         return $field;
186     }
188     /**
189      * Creates a field for a mod_data instance.
190      * Keep in mind the default data field params created in create_field() function!
191      * ...if you haven't provided your own custom data field parameters there.
192      * Currently, the field types in the ignoredfieldtypes array aren't supported.
193      * The developers using the generator must adhere to the following format :
194      *
195      *   Syntax : $contents[ fieldid ] = fieldvalue
196      *   $contents['checkbox'] = array('val1', 'val2', 'val3' .....)
197      *   $contents['data'] = 'dd-mm-yyyy'
198      *   $contents['menu'] = 'value';
199      *   $contents['multimenu'] =  array('val1', 'val2', 'val3' .....)
200      *   $contents['number'] = 'numeric value'
201      *   $contents['radiobuton'] = 'value'
202      *   $contents['text'] = 'text'
203      *   $contents['textarea'] = 'text'
204      *   $contents['url'] = 'example.url' or array('example.url', 'urlname')
205      *
206      * @param mod_data $data
207      * @param array $contents
208      * @return data_field_{type}
209      */
210     public function create_entry($data, array $contents, $groupid = 0) {
211         global $DB;
213         $this->databaserecordcount++;
215         $recordid = data_add_record($data, $groupid);
217         $fields = $DB->get_records('data_fields', array('dataid' => $data->id));
219         // Validating whether required field are filled.
220         foreach ($fields as $field) {
221             $fieldhascontent = true;
223             if (in_array($field->type, $this->ignoredfieldtypes)) {
224                 continue;
225             }
227             $field = data_get_field($field, $data);
229             $fieldid = $field->field->id;
231             if ($field->type === 'date') {
232                 $values = array();
234                 $temp = explode('-', $contents[$fieldid], 3);
236                 $values['field_' . $fieldid . '_day'] = (int)trim($temp[0]);
237                 $values['field_' . $fieldid . '_month'] = (int)trim($temp[1]);
238                 $values['field_' . $fieldid . '_year'] = (int)trim($temp[2]);
240                 // Year should be less than 2038, so it can be handled by 32 bit windows.
241                 if ($values['field_' . $fieldid . '_year'] > 2038) {
242                     throw new coding_exception('DateTime::getTimestamp resturns false on 32 bit win for year beyond ' .
243                         '2038. Please use year less than 2038.');
244                 }
246                 $contents[$fieldid] = $values;
248                 foreach ($values as $fieldname => $value) {
249                     if (!$field->notemptyfield($value, $fieldname)) {
250                         $fieldhascontent = false;
251                     }
252                 }
253             } else if ($field->type === 'textarea') {
254                 $values = array();
256                 $values['field_' . $fieldid] = $contents[$fieldid];
257                 $values['field_' . $fieldid . '_content1'] = 1;
259                 $contents[$fieldid] = $values;
261                 $fieldname = 'field_' . $fieldid;
262                 if (!$field->notemptyfield($values[$fieldname], $fieldname)) {
263                     $fieldhascontent = false;
264                 }
266             } else if ($field->type === 'url') {
267                 $values = array();
269                 if (is_array($contents[$fieldid])) {
270                     foreach ($contents[$fieldid] as $key => $value) {
271                         $values['field_' . $fieldid . '_' . $key] = $value;
272                     }
273                 } else {
274                     $values['field_' . $fieldid . '_0'] = $contents[$fieldid];
275                 }
277                 $contents[$fieldid] = $values;
278                 $fieldname = 'field_' . $fieldid . '_0';
279                 if (!$field->notemptyfield($values[$fieldname], $fieldname)) {
280                     $fieldhascontent = false;
281                 }
283             } else {
284                 if ($field->notemptyfield($contents[$fieldid], 'field_' . $fieldid . '_0')) {
285                     continue;
286                 }
287             }
289             if ($field->field->required && !$fieldhascontent) {
290                 return false;
291             }
292         }
294         foreach ($contents as $fieldid => $content) {
295             $field = data_get_field_from_id($fieldid, $data);
297             if (is_array($content) and in_array($field->type, array('date', 'textarea', 'url'))) {
299                 foreach ($content as $fieldname => $value) {
300                     $field->update_content($recordid, $value, $fieldname);
301                 }
303             } else {
304                 $field->update_content($recordid, $content);
305             }
306         }
308         return $recordid;
309     }