MDL-48595 log: Replacing current interfaces
[moodle.git] / lib / classes / log / sql_select_reader.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  * Log storage reader interface.
19  *
20  * @package    core
21  * @copyright  2013 Petr Skoda {@link http://skodak.org}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core\log;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Sql select reader.
31  *
32  * @deprecated since Moodle 2.9 MDL-48595 - please do not use this interface any more.
33  * @see        sql_reader
34  * @todo       MDL-49291 This will be deleted in Moodle 3.1.
35  * @package    core
36  * @copyright  2013 Petr Skoda {@link http://skodak.org}
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 interface sql_select_reader extends reader {
40     /**
41      * Fetch records using given criteria.
42      *
43      * @param string $selectwhere
44      * @param array $params
45      * @param string $sort
46      * @param int $limitfrom
47      * @param int $limitnum
48      * @return \core\event\base[]
49      */
50     public function get_events_select($selectwhere, array $params, $sort, $limitfrom, $limitnum);
52     /**
53      * Return number of events matching given criteria.
54      *
55      * @param string $selectwhere
56      * @param array $params
57      * @return int
58      */
59     public function get_events_select_count($selectwhere, array $params);
60 }