MDL-48595 core_dml: Adding a recordset walker
[moodle.git] / lib / dml / tests / recordset_walk_test.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  * Test \core\dml\recordset_walk.
19  *
20  * @package    core
21  * @category   dml
22  * @copyright  2015 David Monllao
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * Test case for recordset_walk.
30  *
31  * @package    core
32  * @category   dml
33  * @copyright  2015 David Monllao
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class core_recordset_walk_testcase extends advanced_testcase {
38     public function setUp() {
39         parent::setUp();
40         $this->resetAfterTest();
41     }
43     public function test_no_data() {
44         global $DB;
46         $recordset = $DB->get_recordset('assign');
47         $walker = new \core\dml\recordset_walk($recordset, array($this, 'simple_callback'));
48         $this->assertEquals(0, iterator_count($walker));
49         $this->assertFalse($walker->valid());
50         foreach ($walker as $data) {
51             // No error here.
52         }
53         $walker->close();
54     }
56     public function test_simple_callback() {
57         global $DB;
59         $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
60         $courses = array();
61         for ($i = 0; $i < 10; $i++) {
62             $courses[$i] = $generator->create_instance(array('course' => SITEID));
63         }
65         // Simple iteration.
66         $recordset = $DB->get_recordset('assign');
67         $walker = new \core\dml\recordset_walk($recordset, array($this, 'simple_callback'));
68         $this->assertEquals(10, iterator_count($walker));
69         foreach ($walker as $data) {
70             // Checking that the callback is being executed on each iteration.
71             $this->assertEquals($data->id . ' potatoes', $data->newfield);
72         }
73         // No exception if we double-close.
74         $walker->close();
75     }
77     public function test_extra_params_callback() {
78         global $DB;
80         $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
81         $courses = array();
82         for ($i = 0; $i < 10; $i++) {
83             $courses[$i] = $generator->create_instance(array('course' => SITEID));
84         }
86         // Iteration with extra callback arguments.
87         $recordset = $DB->get_recordset('assign');
88         $walker = new \core\dml\recordset_walk(
89             $recordset,
90             array($this, 'extra_callback'),
91             array('brown' => 'onions')
92         );
93         $this->assertEquals(10, iterator_count($walker));
94         foreach ($walker as $data) {
95             // Checking that the callback is being executed on each
96             // iteration and the param is being passed.
97             $this->assertEquals('onions', $data->brown);
98         }
99         $walker->close();
100     }
102     /**
103      * Simple callback requiring 1 row fields.
104      *
105      * @param stdClass $data
106      * @return \Traversable
107      */
108     public function simple_callback($data) {
109         $data->newfield = $data->id . ' potatoes';
110         return $data;
111     }
113     /**
114      * Callback requiring 1 row fields + other params.
115      *
116      * @param stdClass $data
117      * @param mixed $extra
118      * @return \Traversable
119      */
120     public function extra_callback($data, $extra) {
121         $data->brown = $extra['brown'];
122         return $data;
123     }