Merge branch 'MDL-66118-master-byebyemoodlenet' of git://github.com/mudrd8mz/moodle
[moodle.git] / lib / classes / hub / api.php
index 7c0ed37..7f8979d 100644 (file)
@@ -33,7 +33,7 @@ use coding_exception;
 use moodle_url;
 
 /**
- * Methods to communicate with moodle.net web services
+ * Provides methods to communicate with the hub (sites directory) web services.
  *
  * @package    core
  * @copyright  2017 Marina Glancy
@@ -51,11 +51,11 @@ class api {
     const HUB_BACKUP_FILE_TYPE = 'backup';
 
     /**
-     * Calls moodle.net WS
+     * Calls a remote function exposed via web services on the hub.
      *
      * @param string $function name of WS function
      * @param array $data parameters of WS function
-     * @param bool $allowpublic allow request without moodle.net registration
+     * @param bool $allowpublic allow request without registration on the hub
      * @return mixed depends on the function
      * @throws moodle_exception
      */
@@ -71,7 +71,7 @@ class api {
     }
 
     /**
-     * Performs REST request to moodle.net (using GET method)
+     * Performs a REST request to the hub site (using the GET method).
      *
      * @param string $token
      * @param string $function
@@ -95,7 +95,7 @@ class api {
             // Connection error.
             throw new moodle_exception('errorconnect', 'hub', '', $curl->error);
         } else if (isset($curloutput['exception'])) {
-            // Exception occurred on moodle.net .
+            // Exception occurred on the remote side.
             self::process_curl_exception($token, $curloutput);
         } else if ($info['http_code'] != 200) {
             throw new moodle_exception('errorconnect', 'hub', '', $info['http_code']);
@@ -105,7 +105,7 @@ class api {
     }
 
     /**
-     * Analyses exception received from moodle.net
+     * Analyses exception received from the hub server.
      *
      * @param string $token token used for CURL request
      * @param array $curloutput output from CURL request
@@ -128,7 +128,7 @@ class api {
     }
 
     /**
-     * Update site registration on moodle.net
+     * Update site registration on the hub.
      *
      * @param array $siteinfo
      * @throws moodle_exception
@@ -139,20 +139,20 @@ class api {
     }
 
     /**
-     * Returns information about moodle.net
+     * Returns information about the hub.
      *
      * Example of the return array:
      * {
      *     "courses": 384,
-     *     "description": "Moodle.net connects you with free content and courses shared by Moodle ...",
-     *     "downloadablecourses": 190,
-     *     "enrollablecourses": 194,
+     *     "description": "Official Moodle sites directory.",
+     *     "downloadablecourses": 0,
+     *     "enrollablecourses": 0,
      *     "hublogo": 1,
      *     "language": "en",
-     *     "name": "Moodle.net",
+     *     "name": "moodle",
      *     "sites": 274175,
-     *     "url": "https://moodle.net",
-     *     "imgurl": "https://moodle.net/local/hub/webservice/download.php?filetype=hubscreenshot"
+     *     "url": "https://stats.moodle.org",
+     *     "imgurl": "https://stats.moodle.org/local/hub/webservice/download.php?filetype=hubscreenshot"
      * }
      *
      * @return array
@@ -327,7 +327,7 @@ class api {
      *
      * @param array|\stdClass $courseinfo
      * @return int id of the published course on the hub
-     * @throws moodle_exception if communication to moodle.net failed or course could not be published
+     * @throws moodle_exception if the communication with the hub failed or the course could not be published
      */
     public static function register_course($courseinfo) {
         debugging("This function has been deprecated as part of the Moodle.net sunsetting process.");
@@ -339,7 +339,7 @@ class api {
      *
      * @deprecated since Moodle 3.8. Moodle.net has been sunsetted making this function useless.
      *
-     * @param int $hubcourseid id of the published course on moodle.net, it must be published from this site
+     * @param int $hubcourseid id of the published course on the hub, it must be published from this site
      * @param \stored_file $file
      * @param int $screenshotnumber ordinal number of the screenshot
      */
@@ -352,7 +352,7 @@ class api {
      *
      * @deprecated since Moodle 3.8. Moodle.net has been sunsetted making this function useless.
      *
-     * @param int $hubcourseid id of the course on moodle.net
+     * @param int $hubcourseid id of the course on the hub
      * @param string $path local path (in tempdir) to save the downloaded backup to.
      */
     public static function download_course_backup($hubcourseid, $path) {
@@ -364,7 +364,7 @@ class api {
      *
      * @deprecated since Moodle 3.8. Moodle.net has been sunsetted making this function useless.
      *
-     * @param int $hubcourseid id of the published course on moodle.net, it must be published from this site
+     * @param int $hubcourseid id of the published course on the hub, it must be published from this site
      * @param \stored_file $backupfile
      */
     public static function upload_course_backup($hubcourseid, \stored_file $backupfile) {