weekly release 3.1dev
[moodle.git] / lib / classes / log / sql_internal_table_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 sql internal table reader interface.
19  *
20  * @package    core
21  * @copyright  2015 David Monllao
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 internal table reader.
31  *
32  * Replaces sql_internal_reader and extends sql_reader.
33  *
34  * @since      Moodle 2.9
35  * @package    core
36  * @copyright  2015 David Monllao
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 interface sql_internal_table_reader extends sql_reader {
41     /**
42      * Returns name of the table or database view that
43      * holds the log data in standardised format.
44      *
45      * Note: this table must be used for reading only,
46      * it is strongly recommended to use this in complex reports only.
47      *
48      * @return string
49      */
50     public function get_internal_log_table_name();
51 }