MDL-48595 log: Replacing current interfaces
[moodle.git] / lib / classes / log / sql_internal_reader.php
CommitLineData
309ae892
DW
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/>.
16
17/**
7eaca5a8 18 * Log storage sql reader interface.
309ae892
DW
19 *
20 * @package core
993d8d83 21 * @copyright 2014 Petr Skoda
309ae892
DW
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
309ae892 24
7eaca5a8
25namespace core\log;
26
27defined('MOODLE_INTERNAL') || die();
28
45a1a16b
DM
29/**
30 * Sql internal 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 */
993d8d83 39interface sql_internal_reader extends sql_select_reader {
309ae892
DW
40
41 /**
45a1a16b 42 * Returns name of the table or database view that holds the log data in standardised format.
7eaca5a8
43 *
44 * Note: this table must be used for reading only,
45 * it is strongly recommended to use this in complex reports only.
46 *
309ae892
DW
47 * @return string
48 */
993d8d83 49 public function get_internal_log_table_name();
309ae892 50}