8d91e30784955ff2b2183e727d65d0ec1248a148
[moodle.git] / mod / forum / 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  * mod_forum data generator
19  *
20  * @package    mod_forum
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  * Forum module data generator class
31  *
32  * @package    mod_forum
33  * @category   test
34  * @copyright  2012 Petr Skoda {@link http://skodak.org}
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class mod_forum_generator extends testing_module_generator {
39     /**
40      * @var int keep track of how many forum discussions have been created.
41      */
42     protected $forumdiscussioncount = 0;
44     /**
45      * @var int keep track of how many forum posts have been created.
46      */
47     protected $forumpostcount = 0;
49     /**
50      * To be called from data reset code only,
51      * do not use in tests.
52      * @return void
53      */
54     public function reset() {
55         $this->forumdiscussioncount = 0;
56         $this->forumpostcount = 0;
58         parent::reset();
59     }
61     public function create_instance($record = null, array $options = null) {
62         global $CFG;
63         require_once($CFG->dirroot.'/mod/forum/lib.php');
64         $record = (object)(array)$record;
66         if (!isset($record->type)) {
67             $record->type = 'general';
68         }
69         if (!isset($record->assessed)) {
70             $record->assessed = 0;
71         }
72         if (!isset($record->scale)) {
73             $record->scale = 0;
74         }
75         if (!isset($record->forcesubscribe)) {
76             $record->forcesubscribe = FORUM_CHOOSESUBSCRIBE;
77         }
79         return parent::create_instance($record, (array)$options);
80     }
82     /**
83      * Function to create a dummy discussion.
84      *
85      * @param array|stdClass $record
86      * @return stdClass the discussion object
87      */
88     public function create_discussion($record = null) {
89         global $DB;
91         // Increment the forum discussion count.
92         $this->forumdiscussioncount++;
94         $record = (array) $record;
96         if (!isset($record['course'])) {
97             throw new coding_exception('course must be present in phpunit_util::create_discussion() $record');
98         }
100         if (!isset($record['forum'])) {
101             throw new coding_exception('forum must be present in phpunit_util::create_discussion() $record');
102         }
104         if (!isset($record['userid'])) {
105             throw new coding_exception('userid must be present in phpunit_util::create_discussion() $record');
106         }
108         if (!isset($record['name'])) {
109             $record['name'] = "Discussion " . $this->forumdiscussioncount;
110         }
112         if (!isset($record['subject'])) {
113             $record['subject'] = "Subject for discussion " . $this->forumdiscussioncount;
114         }
116         if (!isset($record['message'])) {
117             $record['message'] = html_writer::tag('p', 'Message for discussion ' . $this->forumdiscussioncount);
118         }
120         if (!isset($record['messageformat'])) {
121             $record['messageformat'] = editors_get_preferred_format();
122         }
124         if (!isset($record['messagetrust'])) {
125             $record['messagetrust'] = "";
126         }
128         if (!isset($record['assessed'])) {
129             $record['assessed'] = '1';
130         }
132         if (!isset($record['groupid'])) {
133             $record['groupid'] = "-1";
134         }
136         if (!isset($record['timestart'])) {
137             $record['timestart'] = "0";
138         }
140         if (!isset($record['timeend'])) {
141             $record['timeend'] = "0";
142         }
144         if (!isset($record['mailnow'])) {
145             $record['mailnow'] = "0";
146         }
148         $record = (object) $record;
150         // Add the discussion.
151         $record->id = forum_add_discussion($record, null, null, $record->userid);
153         return $record;
154     }
156     /**
157      * Function to create a dummy post.
158      *
159      * @param array|stdClass $record
160      * @return stdClass the post object
161      */
162     public function create_post($record = null) {
163         global $DB;
165         // Increment the forum post count.
166         $this->forumpostcount++;
168         // Variable to store time.
169         $time = time() + $this->forumpostcount;
171         $record = (array) $record;
173         if (!isset($record['discussion'])) {
174             throw new coding_exception('discussion must be present in phpunit_util::create_post() $record');
175         }
177         if (!isset($record['userid'])) {
178             throw new coding_exception('userid must be present in phpunit_util::create_post() $record');
179         }
181         if (!isset($record['parent'])) {
182             $record['parent'] = 0;
183         }
185         if (!isset($record['subject'])) {
186             $record['subject'] = 'Forum post subject ' . $this->forumpostcount;
187         }
189         if (!isset($record['message'])) {
190             $record['message'] = html_writer::tag('p', 'Forum message post ' . $this->forumpostcount);
191         }
193         if (!isset($record['created'])) {
194             $record['created'] = $time;
195         }
197         if (!isset($record['modified'])) {
198             $record['modified'] = $time;
199         }
201         if (!isset($record['mailed'])) {
202             $record['mailed'] = 0;
203         }
205         if (!isset($record['messageformat'])) {
206             $record['messageformat'] = 0;
207         }
209         if (!isset($record['messagetrust'])) {
210             $record['messagetrust'] = 0;
211         }
213         if (!isset($record['attachment'])) {
214             $record['attachment'] = "";
215         }
217         if (!isset($record['totalscore'])) {
218             $record['totalscore'] = 0;
219         }
221         if (!isset($record['mailnow'])) {
222             $record['mailnow'] = 0;
223         }
225         $record = (object) $record;
227         // Add the post.
228         $record->id = $DB->insert_record('forum_posts', $record);
230         // Update the last post.
231         forum_discussion_update_last_post($record->discussion);
233         return $record;
234     }
236     public function create_content($instance, $record = array()) {
237         global $USER, $DB;
238         $record = (array)$record + array(
239             'forum' => $instance->id,
240             'userid' => $USER->id,
241             'course' => $instance->course
242         );
243         if (empty($record['discussion']) && empty($record['parent'])) {
244             // Create discussion.
245             $discussion = $this->create_discussion($record);
246             $post = $DB->get_record('forum_posts', array('id' => $discussion->firstpost));
247         } else {
248             // Create post.
249             if (empty($record['parent'])) {
250                 $record['parent'] = $DB->get_field('forum_discussions', 'firstpost', array('id' => $record['discussion']), MUST_EXIST);
251             } else if (empty($record['discussion'])) {
252                 $record['discussion'] = $DB->get_field('forum_posts', 'discussion', array('id' => $record['parent']), MUST_EXIST);
253             }
254             $post = $this->create_post($record);
255         }
256         return $post;
257     }