jfederico / moodle-mod_bigbluebuttonbn

classes/locallib/notifier.php

Doc Comments +1 added lines, -1 removed lines

@@ -111,7 +111,7 @@
      *
      * @param object $bigbluebuttonbn
      *
-     * @return void
+     * @return string
      */
     public static function htmlmsg_recording_ready($bigbluebuttonbn) {
         return '<p>'.get_string('email_body_recording_ready_for', 'bigbluebuttonbn').

lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -103,7 +103,7 @@ 
  * @uses FEATURE_GRADE_OUTCOMES
  * @uses FEATURE_SHOW_DESCRIPTION
  * @param string $feature
- * @return mixed True if yes (some features may use other values)
+ * @return null|boolean True if yes (some features may use other values)
  */
 function bigbluebuttonbn_supports($feature) {
     if (!$feature) {
@@ -310,7 +310,7 @@ 
  *
  * @param object $bigbluebuttonbn Id of the module instance
  *
- * @return bool Success/Failure
+ * @return boolean|null Success/Failure
  */
 function bigbluebuttonbn_delete_instance_log($bigbluebuttonbn) {
     global $DB;
@@ -331,7 +331,7 @@ 
  * @param object $mod
  * @param object $bigbluebuttonbn
  *
- * @return bool
+ * @return string
  */
 function bigbluebuttonbn_user_outline($course, $user, $mod, $bigbluebuttonbn) {
     if ($completed = bigbluebuttonbn_user_complete($course, $user, $bigbluebuttonbn)) {
@@ -917,7 +917,7 @@ 
  * @param stdClass $context       context object
  * @param string   $filearea      file area
  *
- * @return false|null false if file not valid
+ * @return boolean false if file not valid
  */
 function bigbluebuttonbn_pluginfile_valid($context, $filearea) {
 

locallib.php

Doc Comments +14 added lines, -14 removed lines

@@ -307,7 +307,7 @@ 
  * Helper function to retrieve imported recordings from the Moodle database.
  * The references are stored as events in bigbluebuttonbn_logs.
  *
- * @param string $courseid
+ * @param integer $courseid
  * @param string $bigbluebuttonbnid
  * @param bool   $subset
  *
@@ -335,7 +335,7 @@ 
 /**
  * Helper function to retrive the default config.xml file.
  *
- * @return string
+ * @return null|SimpleXMLElement
  */
 function bigbluebuttonbn_get_default_config_xml() {
     $xml = bigbluebuttonbn_wrap_xml_load_file(
@@ -417,7 +417,7 @@ 
  * @param object $a
  * @param object $b
  *
- * @return array
+ * @return integer
  */
 function bigbluebuttonbn_recording_build_sorter($a, $b) {
     global $CFG;
@@ -531,7 +531,7 @@ 
  * @param string $data
  * @param string $contenttype
  *
- * @return object
+ * @return null|SimpleXMLElement
  */
 function bigbluebuttonbn_wrap_xml_load_file($url, $method = 'GET', $data = null, $contenttype = 'text/xml') {
     if (extension_loaded('curl')) {
@@ -572,7 +572,7 @@ 
  * @param string $data
  * @param string $contenttype
  *
- * @return object
+ * @return string
  */
 function bigbluebuttonbn_wrap_xml_load_file_curl_request($url, $method = 'GET', $data = null, $contenttype = 'text/xml') {
     $c = new curl();
@@ -945,7 +945,7 @@ 
  * @param integer $instance
  * @param integer $voicebridge
  *
- * @return string
+ * @return boolean
  */
 function bigbluebuttonbn_voicebridge_unique($instance, $voicebridge) {
     global $DB;
@@ -1293,7 +1293,7 @@ 
  * @param string $meetingid
  * @param string $configxml
  *
- * @return object
+ * @return null|SimpleXMLElement
  */
 function bigbluebuttonbn_set_config_xml($meetingid, $configxml) {
     $urldefaultconfig = \mod_bigbluebuttonbn\locallib\config::get('server_url') . 'api/setConfigXML?';
@@ -1347,7 +1347,7 @@ 
  * @param array $recording
  * @param array $tools
  *
- * @return array
+ * @return null|stdClass
  */
 function bigbluebuttonbn_get_recording_data_row($bbbsession, $recording, $tools = ['protect', 'publish', 'delete']) {
     if (!bigbluebuttonbn_include_recording_table_row($bbbsession, $recording)) {
@@ -1982,7 +1982,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recording
- * @param object $rowdata
+ * @param stdClass $rowdata
  *
  * @return object
  */
@@ -2177,7 +2177,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recordings
- * @param array $tools
+ * @param string[] $tools
  *
  * @return array
  */
@@ -2258,7 +2258,7 @@ 
  * Helper function to define the sql used for gattering the bigbluebuttonbnids whose meetingids should be included
  * in the getRecordings request considering only those that belong to deleted activities.
  *
- * @param string $courseid
+ * @param integer $courseid
  * @param string $bigbluebuttonbnid
  * @param bool   $subset
  *
@@ -2282,7 +2282,7 @@ 
  * Helper function to define the sql used for gattering the bigbluebuttonbnids whose meetingids should be included
  * in the getRecordings request considering only those that belong to imported recordings.
  *
- * @param string $courseid
+ * @param integer $courseid
  * @param string $bigbluebuttonbnid
  * @param bool   $subset
  *
@@ -2305,7 +2305,7 @@ 
 /**
  * Helper function to get recordings and imported recordings together.
  *
- * @param string $courseid
+ * @param integer $courseid
  * @param string $bigbluebuttonbnid
  * @param bool   $subset
  * @param bool   $includedeleted
@@ -2323,7 +2323,7 @@ 
  * Helper function to retrieve recordings from the BigBlueButton. The references are stored as events
  * in bigbluebuttonbn_logs.
  *
- * @param string $courseid
+ * @param integer $courseid
  * @param string $bigbluebuttonbnid
  * @param bool   $subset
  * @param bool   $includedeleted