MDL-38030 new core_user_get_users_by_field function deprecates core_user_get_users_by_id
authorJerome Mouneyrac <jerome@mouneyrac.com>
Fri, 5 Apr 2013 05:14:49 +0000 (13:14 +0800)
committerJerome Mouneyrac <jerome@mouneyrac.com>
Fri, 5 Apr 2013 05:14:49 +0000 (13:14 +0800)
lib/db/services.php
user/externallib.php

index 8cdb376..b0ef0e5 100644 (file)
@@ -304,7 +304,7 @@ $functions = array(
         'classname'   => 'core_user_external',
         'methodname'  => 'get_users_by_id',
         'classpath'   => 'user/externallib.php',
         'classname'   => 'core_user_external',
         'methodname'  => 'get_users_by_id',
         'classpath'   => 'user/externallib.php',
-        'description' => 'Get users by id.',
+        'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has been replaced by core_user_get_users_by_field()',
         'type'        => 'read',
         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
     ),
         'type'        => 'read',
         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
     ),
index 7bc342e..735290a 100644 (file)
@@ -640,6 +640,8 @@ class core_user_external extends external_api {
      *
      * @return external_function_parameters
      * @since Moodle 2.2
      *
      * @return external_function_parameters
      * @since Moodle 2.2
+     * @deprecated Moodle 2.5 MDL-38030 - Please do not call this function any more.
+     * @see core_user_external::get_users_by_field_parameters()
      */
     public static function get_users_by_id_parameters() {
         return new external_function_parameters(
      */
     public static function get_users_by_id_parameters() {
         return new external_function_parameters(
@@ -658,6 +660,8 @@ class core_user_external extends external_api {
      * @param array $userids  array of user ids
      * @return array An array of arrays describing users
      * @since Moodle 2.2
      * @param array $userids  array of user ids
      * @return array An array of arrays describing users
      * @since Moodle 2.2
+     * @deprecated Moodle 2.5 MDL-38030 - Please do not call this function any more.
+     * @see core_user_external::get_users_by_field()
      */
     public static function get_users_by_id($userids) {
         global $CFG, $USER, $DB;
      */
     public static function get_users_by_id($userids) {
         global $CFG, $USER, $DB;
@@ -708,6 +712,8 @@ class core_user_external extends external_api {
      *
      * @return external_description
      * @since Moodle 2.2
      *
      * @return external_description
      * @since Moodle 2.2
+     * @deprecated Moodle 2.5 MDL-38030 - Please do not call this function any more.
+     * @see core_user_external::get_users_by_field_returns()
      */
     public static function get_users_by_id_returns() {
         $additionalfields = array (
      */
     public static function get_users_by_id_returns() {
         $additionalfields = array (