MDL-37457 testing Mark current classes as deprecated
[moodle.git] / lib / testing / generator / module_generator.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  * Module generator base class.
19  *
20  * @package    core
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  */
27 /**
28  * Module generator base class.
29  *
30  * Extend in mod/xxxx/tests/generator/lib.php as class mod_xxxx_generator.
31  *
32  * @package    core
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 abstract class testing_module_generator {
39     /**
40      * @var testing_data_generator
41      */
42     protected $datagenerator;
44     /**
45      * @var number of created instances
46      */
47     protected $instancecount = 0;
49     /**
50      * Dumb constructor to throw the deprecated notification
51      * @param testing_data_generator $datagenerator
52      */
53     public function __construct(testing_data_generator $datagenerator) {
54         $this->datagenerator = $datagenerator;
55     }
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->instancecount = 0;
64     }
66     /**
67      * Returns module name
68      * @return string name of module that this class describes
69      * @throws coding_exception if class invalid
70      */
71     public function get_modulename() {
72         $matches = null;
73         if (!preg_match('/^mod_([a-z0-9]+)_generator$/', get_class($this), $matches)) {
74             throw new coding_exception('Invalid module generator class name: '.get_class($this));
75         }
77         if (empty($matches[1])) {
78             throw new coding_exception('Invalid module generator class name: '.get_class($this));
79         }
80         return $matches[1];
81     }
83     /**
84      * Create course module and link it to course
85      * @param integer $courseid
86      * @param array $options section, visible
87      * @return integer $cm instance id
88      */
89     protected function precreate_course_module($courseid, array $options) {
90         global $DB, $CFG;
91         require_once("$CFG->dirroot/course/lib.php");
93         $modulename = $this->get_modulename();
94         $sectionnum = isset($options['section']) ? $options['section'] : 0;
95         unset($options['section']); // Prevent confusion, it would be overridden later in course_add_cm_to_section() anyway.
97         $cm = new stdClass();
98         $cm->course             = $courseid;
99         $cm->module             = $DB->get_field('modules', 'id', array('name'=>$modulename));
100         $cm->instance           = 0;
101         $cm->section            = 0;
102         $cm->idnumber           = isset($options['idnumber']) ? $options['idnumber'] : 0;
103         $cm->added              = time();
105         $columns = $DB->get_columns('course_modules');
106         foreach ($options as $key => $value) {
107             if ($key === 'id' or !isset($columns[$key])) {
108                 continue;
109             }
110             if (property_exists($cm, $key)) {
111                 continue;
112             }
113             $cm->$key = $value;
114         }
116         $cm->id = $DB->insert_record('course_modules', $cm);
118         course_add_cm_to_section($courseid, $cm->id, $sectionnum);
120         return $cm->id;
121     }
123     /**
124      * Called after *_add_instance()
125      * @param int $id
126      * @param int $cmid
127      * @return stdClass module instance
128      */
129     protected function post_add_instance($id, $cmid) {
130         global $DB;
132         $DB->set_field('course_modules', 'instance', $id, array('id'=>$cmid));
134         $instance = $DB->get_record($this->get_modulename(), array('id'=>$id), '*', MUST_EXIST);
136         $cm = get_coursemodule_from_id($this->get_modulename(), $cmid, $instance->course, true, MUST_EXIST);
137         context_module::instance($cm->id);
139         $instance->cmid = $cm->id;
141         return $instance;
142     }
144     /**
145      * Create a test module
146      * @param array|stdClass $record
147      * @param array $options
148      * @return stdClass activity record
149      */
150     abstract public function create_instance($record = null, array $options = null);
153 /**
154  * Deprecated in favour of testing_module_generator
155  *
156  * @deprecated since Moodle 2.5 MDL-37457 - please do not use this function any more.
157  * @todo       MDL-37517 This will be deleted in Moodle 2.7
158  * @see        testing_module_generator
159  * @package    core
160  * @category   test
161  * @copyright  2012 David MonllaĆ³
162  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
163  */
164 abstract class phpunit_module_generator extends testing_module_generator {
166     /**
167      * Dumb constructor to throw the deprecated notification
168      * @param testing_data_generator $datagenerator
169      */
170     public function __construct(testing_data_generator $datagenerator) {
171         debugging('Class phpunit_module_generator is deprecated, please use class testing_module_generator instead', DEBUG_DEVELOPER);
172         parent::__construct($datagenerator);
173     }