MDL-48595 log: Replacing current interfaces

Deprecating sql_internal_reader and sql_select_reader in favour of the new interfaces including get_events_select_iterator.
2015-03-09 08:25:15 +08:00
parent ad23227bd6
commit 45a1a16bfc
5 changed files with 164 additions and 2 deletions
@@ -0,0 +1,51 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Log storage sql internal table reader interface.
+ *
+ * @package    core
+ * @copyright  2015 David Monllao
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core\log;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Sql internal table reader.
+ *
+ * Replaces sql_internal_reader and extends sql_reader.
+ *
+ * @since      Moodle 2.9
+ * @package    core
+ * @copyright  2015 David Monllao
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+interface sql_internal_table_reader extends sql_reader {
+
+    /**
+     * Returns name of the table or database view that
+     * holds the log data in standardised format.
+     *
+     * Note: this table must be used for reading only,
+     * it is strongly recommended to use this in complex reports only.
+     *
+     * @return string
+     */
+    public function get_internal_log_table_name();
+}