mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-13 20:42:22 +02:00
Code Issues Projects Releases Wiki Activity

MDL-69521 core: Move all comments in code from 4.0 to 3.10

Browse Source
This commit is contained in:
Eloy Lafuente (stronk7) 2020-09-06 16:48:57 +02:00
parent 99777d963f
commit 6a60111199
12 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
admin/tool/log/store/legacy/classes/log/store.php
View File

@ -17,7 +17,7 @@
/**
* 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
* @todo MDL-52805 This is to be removed in Moodle 3.10
*
* @package logstore_legacy
* @copyright 2013 Petr Skoda {@link http://skodak.org}
@ -34,7 +34,7 @@ class store implements \tool_log\log\store, \core\log\sql_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
* @todo MDL-52805 This is to be removed in Moodle 3.10
*
* @param \tool_log\log\manager $manager
*/
@ -93,7 +93,7 @@ class store implements \tool_log\log\store, \core\log\sql_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
* @todo MDL-52805 This will be removed in Moodle 3.10
*
* @param string $selectwhere
* @param array $params
@ -134,7 +134,7 @@ class store implements \tool_log\log\store, \core\log\sql_reader {
/**
* 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
* @todo MDL-52805 This will be removed in Moodle 3.10
*
* Note that the traversable object contains a moodle_recordset, so
* remember that is important that you call close() once you finish
@ -168,7 +168,7 @@ class store implements \tool_log\log\store, \core\log\sql_reader {
/**
* 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
* @todo MDL-52805 This will be removed in Moodle 3.10
*
* @param stdClass $data Log data
* @return \core\event\base
@ -179,7 +179,7 @@ class store implements \tool_log\log\store, \core\log\sql_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
* @todo MDL-52805 This will be removed in Moodle 3.10
*
* @param string $selectwhere
* @param array $params
@ -202,7 +202,7 @@ class store implements \tool_log\log\store, \core\log\sql_reader {
/**
* 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
* @todo MDL-52805 This will be removed in Moodle 3.10
*
* @return bool true means new log events are being added, false means no new data will be added
*/
@ -212,7 +212,7 @@ class store implements \tool_log\log\store, \core\log\sql_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
* @todo MDL-52805 This will be removed in Moodle 3.10
*/
public function dispose() {
}

4
calendar/classes/external/calendar_event_exporter.php vendored
View File

@ -369,7 +369,7 @@ class calendar_event_exporter extends event_exporter_base {
* and the module's minimum timestamp limit.
*
* @deprecated since Moodle 3.6. Please use get_timestamp_min_limit().
* @todo final deprecation. To be removed in Moodle 4.0
* @todo final deprecation. To be removed in Moodle 3.10
* @param DateTimeInterface $starttime The event start time
* @param array $min The module's minimum limit for the event
* @return array Returns an array with mindaytimestamp and mindayerror keys.
@ -385,7 +385,7 @@ class calendar_event_exporter extends event_exporter_base {
* and the module's maximum timestamp limit.
*
* @deprecated since Moodle 3.6. Please use get_timestamp_max_limit().
* @todo final deprecation. To be removed in Moodle 4.0
* @todo final deprecation. To be removed in Moodle 3.10
* @param DateTimeInterface $starttime The event start time
* @param array $max The module's maximum limit for the event
* @return array Returns an array with maxdaytimestamp and maxdayerror keys.

4
lib/adminlib.php
View File

@ -3276,7 +3276,7 @@ class admin_setting_configselect extends admin_setting {
* an empty string '' if the value is OK, or an error message if not.
*
* @param callable|null $validatefunction Validate function or null to clear
* @since Moodle 4.0
* @since Moodle 3.10
*/
public function set_validate_function(?callable $validatefunction = null) {
$this->validatefunction = $validatefunction;
@ -3362,7 +3362,7 @@ class admin_setting_configselect extends admin_setting {
*
* @param string $data New value being set
* @return string Empty string if valid, or error message text
* @since Moodle 4.0
* @since Moodle 3.10
*/
protected function validate_setting(string $data): string {
// If validation function is specified, call it now.

4
lib/classes/lock/db_record_lock_factory.php
View File

@ -92,7 +92,7 @@ class db_record_lock_factory implements lock_factory {
/**
* Multiple locks for the same resource can be held by a single process.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @return boolean - False - not process specific.
*/
public function supports_recursion() {
@ -192,7 +192,7 @@ class db_record_lock_factory implements lock_factory {
/**
* Extend a lock that was previously obtained with @lock.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @param lock $lock - a lock obtained from this factory.
* @param int $maxlifetime - the new lifetime for the lock (in seconds).
* @return boolean - true if the lock was extended.

4
lib/classes/lock/file_lock_factory.php
View File

@ -109,7 +109,7 @@ class file_lock_factory implements lock_factory {
/**
* Multiple locks for the same resource cannot be held from a single process.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @return boolean - False
*/
public function supports_recursion() {
@ -193,7 +193,7 @@ class file_lock_factory implements lock_factory {
/**
* Extend a lock that was previously obtained with @lock.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @param lock $lock - not used
* @param int $maxlifetime - not used
* @return boolean - true if the lock was extended.

4
lib/classes/lock/installation_lock_factory.php
View File

@ -76,7 +76,7 @@ class installation_lock_factory implements lock_factory {
/**
* Multiple locks for the same resource cannot be held from a single process.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @return boolean - False
*/
public function supports_recursion() {
@ -118,7 +118,7 @@ class installation_lock_factory implements lock_factory {
/**
* Extend a lock that was previously obtained with @lock.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @param lock $lock - not used
* @param int $maxlifetime - not used
* @return boolean - true if the lock was extended.

2
lib/classes/lock/lock.php
View File

@ -81,7 +81,7 @@ class lock {
/**
* Extend the lifetime of this lock. Not supported by all factories.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @param int $maxlifetime - the new lifetime for the lock (in seconds).
* @return bool
*/

4
lib/classes/lock/lock_factory.php
View File

@ -63,7 +63,7 @@ interface lock_factory {
/**
* Supports recursion.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @return boolean - True if attempting to get 2 locks on the same resource will "stack"
*/
public function supports_recursion();
@ -99,7 +99,7 @@ interface lock_factory {
/**
* Extend the timeout on a held lock.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @param lock $lock - lock obtained from this factory
* @param int $maxlifetime - new max time to hold the lock
* @return boolean - True if the lock was extended.

4
lib/classes/lock/mysql_lock_factory.php
View File

@ -106,7 +106,7 @@ class mysql_lock_factory implements lock_factory {
* Hard coded to false and workaround inconsistent support in different
* versions of MySQL / MariaDB.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @return boolean - false
*/
public function supports_recursion() {
@ -169,7 +169,7 @@ class mysql_lock_factory implements lock_factory {
/**
* Extend a lock that was previously obtained with @lock.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @param lock $lock - a lock obtained from this factory.
* @param int $maxlifetime - the new lifetime for the lock (in seconds).
* @return boolean - true if the lock was extended.

4
lib/classes/lock/postgres_lock_factory.php
View File

@ -120,7 +120,7 @@ class postgres_lock_factory implements lock_factory {
/**
* Multiple locks for the same resource can NOT be held by a single process.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @return boolean - false.
*/
public function supports_recursion() {
@ -206,7 +206,7 @@ class postgres_lock_factory implements lock_factory {
/**
* Extend a lock that was previously obtained with @lock.
*
* @deprecated since Moodle 4.0.
* @deprecated since Moodle 3.10.
* @param lock $lock - a lock obtained from this factory.
* @param int $maxlifetime - the new lifetime for the lock (in seconds).
* @return boolean - true if the lock was extended.

2
lib/deprecatedlib.php
View File

@ -3357,7 +3357,7 @@ function user_get_participants($courseid, $groupid = 0, $accesssince, $roleid, $
*
* Calls {@see core_course_category::make_categories_list()} to build the list.
*
* @deprecated since Moodle 4.0
* @deprecated since Moodle 3.10
* @todo This will be finally removed for Moodle 4.4 as part of MDL-69124.
* @return array array mapping course category id to the display name
*/

4
search/classes/manager.php
View File

@ -1196,7 +1196,7 @@ class manager {
} else if (count($result) === 5) {
// Backward compatibility for engines that don't return a batch count.
[$numrecords, $numdocs, $numdocsignored, $lastindexeddoc, $partial] = $result;
// Deprecated since Moodle 4.0 MDL-68690.
// Deprecated since Moodle 3.10 MDL-68690.
// TODO: MDL-68776 This will be deleted in Moodle 4.4.
debugging('engine::add_documents() should return $batches (5-value return is deprecated)',
DEBUG_DEVELOPER);
@ -1361,7 +1361,7 @@ class manager {
} else if (count($result) === 5) {
// Backward compatibility for engines that don't return a batch count.
[$numrecords, $numdocs, $numdocsignored, $lastindexeddoc, $partial] = $result;
// Deprecated since Moodle 4.0 MDL-68690.
// Deprecated since Moodle 3.10 MDL-68690.
// TODO: MDL-68776 This will be deleted in Moodle 4.4 (as should the below bit).
debugging('engine::add_documents() should return $batches (5-value return is deprecated)',
DEBUG_DEVELOPER);