diff --git a/admin/tool/log/store/legacy/classes/log/store.php b/admin/tool/log/store/legacy/classes/log/store.php index d40eec0ed1ea9..bcb1d546649fa 100644 --- a/admin/tool/log/store/legacy/classes/log/store.php +++ b/admin/tool/log/store/legacy/classes/log/store.php @@ -16,6 +16,8 @@ /** * Legacy log reader. + * @deprecated since Moodle 3.6 MDL-52953 - Please use supported log stores such as "standard" or "external" instead. + * @todo MDL-52805 This is to be removed in Moodle 4.0 * * @package logstore_legacy * @copyright 2013 Petr Skoda {@link http://skodak.org} @@ -30,6 +32,12 @@ class store implements \tool_log\log\store, \core\log\sql_reader { use \tool_log\helper\store, \tool_log\helper\reader; + /** + * @deprecated since Moodle 3.6 MDL-52953 - Please use supported log stores such as "standard" or "external" instead. + * @todo MDL-52805 This is to be removed in Moodle 4.0 + * + * @param \tool_log\log\manager $manager + */ public function __construct(\tool_log\log\manager $manager) { $this->helper_setup($manager); } @@ -83,6 +91,17 @@ protected static function replace_sql_legacy($selectwhere, array $params, $sort return array($selectwhere, $params, $sort); } + /** + * @deprecated since Moodle 3.6 MDL-52953 - Please use supported log stores such as "standard" or "external" instead. + * @todo MDL-52805 This will be removed in Moodle 4.0 + * + * @param string $selectwhere + * @param array $params + * @param string $sort + * @param int $limitfrom + * @param int $limitnum + * @return array + */ public function get_events_select($selectwhere, array $params, $sort, $limitfrom, $limitnum) { global $DB; @@ -114,6 +133,8 @@ public function get_events_select($selectwhere, array $params, $sort, $limitfrom /** * Fetch records using given criteria returning a Traversable object. + * @deprecated since Moodle 3.6 MDL-52953 - Please use supported log stores such as "standard" or "external" instead. + * @todo MDL-52805 This will be removed in Moodle 4.0 * * Note that the traversable object contains a moodle_recordset, so * remember that is important that you call close() once you finish @@ -146,6 +167,8 @@ public function get_events_select_iterator($selectwhere, array $params, $sort, $ /** * Returns an event from the log data. + * @deprecated since Moodle 3.6 MDL-52953 - Please use supported log stores such as "standard" or "external" instead. + * @todo MDL-52805 This will be removed in Moodle 4.0 * * @param stdClass $data Log data * @return \core\event\base @@ -154,6 +177,14 @@ public function get_log_event($data) { return \logstore_legacy\event\legacy_logged::restore_legacy($data); } + /** + * @deprecated since Moodle 3.6 MDL-52953 - Please use supported log stores such as "standard" or "external" instead. + * @todo MDL-52805 This will be removed in Moodle 4.0 + * + * @param string $selectwhere + * @param array $params + * @return int + */ public function get_events_select_count($selectwhere, array $params) { global $DB; @@ -170,6 +201,8 @@ public function get_events_select_count($selectwhere, array $params) { /** * Are the new events appearing in the reader? + * @deprecated since Moodle 3.6 MDL-52953 - Please use supported log stores such as "standard" or "external" instead. + * @todo MDL-52805 This will be removed in Moodle 4.0 * * @return bool true means new log events are being added, false means no new data will be added */ @@ -177,6 +210,10 @@ public function is_logging() { return (bool)$this->get_config('loglegacy', true); } + /** + * @deprecated since Moodle 3.6 MDL-52953 - Please use supported log stores such as "standard" or "external" instead. + * @todo MDL-52805 This will be removed in Moodle 4.0 + */ public function dispose() { } diff --git a/admin/tool/log/upgrade.txt b/admin/tool/log/upgrade.txt new file mode 100644 index 0000000000000..e1b65e3f3884a --- /dev/null +++ b/admin/tool/log/upgrade.txt @@ -0,0 +1,8 @@ +This files describes API changes in /admin/tool/log - plugins, +information provided here is intended especially for developers. + + +=== 3.6 === + +* The legacy log store is in its first stage of deprecation and is due for removal in Moodle 4.0. Please use one of + the other log stores such as "standard" and "database". \ No newline at end of file