blindsidenetworks / moodle-mod_bigbluebuttonbn

locallib.php

Doc Comments +16 added lines, -16 removed lines

@@ -173,9 +173,9 @@ 
  * Helper function to retrieve recordings from a BigBlueButton server.
  *
  * @param string|array $meetingids   list of meetingIDs "mid1,mid2,mid3" or array("mid1","mid2","mid3")
- * @param string|array $recordingids list of $recordingids "rid1,rid2,rid3" or array("rid1","rid2","rid3") for filtering
+ * @param string $recordingids list of $recordingids "rid1,rid2,rid3" or array("rid1","rid2","rid3") for filtering
  *
- * @return associative array with recordings indexed by recordID, each recording is a non sequential associative array
+ * @return string array with recordings indexed by recordID, each recording is a non sequential associative array
  */
 function bigbluebuttonbn_get_recordings_array($meetingids, $recordingids = []) {
     $meetingidsarray = $meetingids;
@@ -262,7 +262,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
  *
@@ -290,7 +290,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(
@@ -372,7 +372,7 @@ 
  * @param object $a
  * @param object $b
  *
- * @return array
+ * @return integer
  */
 function bigbluebuttonbn_recording_build_sorter($a, $b) {
     if ($a['startTime'] < $b['startTime']) {
@@ -483,7 +483,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')) {
@@ -524,7 +524,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();
@@ -894,7 +894,7 @@ 
  * @param integer $instance
  * @param integer $voicebridge
  *
- * @return string
+ * @return boolean
  */
 function bigbluebuttonbn_voicebridge_unique($instance, $voicebridge) {
     global $DB;
@@ -997,7 +997,7 @@ 
 /**
  * Helper returns an array with all possible bigbluebuttonbn events.
  *
- * @return array
+ * @return string[]
  */
 function bigbluebuttonbn_events() {
     return array(
@@ -1223,7 +1223,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?';
@@ -1272,7 +1272,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)) {
@@ -1836,7 +1836,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recording
- * @param object $rowdata
+ * @param stdClass $rowdata
  *
  * @return object
  */
@@ -2031,7 +2031,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
  *
@@ -2055,7 +2055,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
  *
@@ -2078,7 +2078,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
@@ -2096,7 +2096,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

bbb_broker.php

Indentation +28 added lines, -28 removed lines

@@ -440,26 +440,26 @@ 
             return array(
                 'status' => false,
                 'message' => get_string('view_recording_publish_link_deleted', 'bigbluebuttonbn')
-              );
+                );
         }
         if ($realrecordings[$params['id']]['published'] !== 'true') {
             return array(
                 'status' => false,
                 'message' => get_string('view_recording_publish_link_not_published', 'bigbluebuttonbn')
-              );
+                );
         }
         return array(
             'status' => bigbluebuttonbn_publish_recording_imported(
                 $recordings[$params['id']]['imported'], true
             )
-          );
+            );
     }
     // As the recordingid was not identified as imported recording link, execute actual publish.
     return array(
         'status' => bigbluebuttonbn_publish_recordings(
             $params['id'], 'true'
         )
-      );
+        );
 }
 
 /**
@@ -480,26 +480,26 @@ 
             return array(
                 'status' => false,
                 'message' => get_string('view_recording_unprotect_link_deleted', 'bigbluebuttonbn')
-              );
+                );
         }
         if ($realrecordings[$params['id']]['protected'] === 'true') {
             return array(
                 'status' => false,
                 'message' => get_string('view_recording_unprotect_link_not_unprotected', 'bigbluebuttonbn')
-              );
+                );
         }
         return array(
             'status' => bigbluebuttonbn_protect_recording_imported(
                 $recordings[$params['id']]['imported'], false
             )
-          );
+            );
     }
     // As the recordingid was not identified as imported recording link, execute actual uprotect.
     return array(
         'status' => bigbluebuttonbn_update_recordings(
             $params['id'], array('protect' => 'false')
         )
-      );
+        );
 }
 
 /**
@@ -518,7 +518,7 @@ 
             'status' => bigbluebuttonbn_publish_recording_imported(
                 $recordings[$params['id']]['imported'], false
             )
-          );
+            );
     }
     // As the recordingid was not identified as imported recording link, execute unpublish on a real recording.
     // First: Unpublish imported links associated to the recording.
@@ -536,7 +536,7 @@ 
         'status' => bigbluebuttonbn_publish_recordings(
             $params['id'], 'false'
         )
-      );
+        );
 }
 
 /**
@@ -555,7 +555,7 @@ 
             'status' => bigbluebuttonbn_protect_recording_imported(
                 $recordings[$params['id']]['imported'], true
             )
-          );
+            );
     }
     // As the recordingid was not identified as imported recording link, execute protect on a real recording.
     // First: Protect imported links associated to the recording.
@@ -573,7 +573,7 @@ 
         'status' => bigbluebuttonbn_update_recordings(
             $params['id'], array('protect' => 'true')
         )
-      );
+        );
 }
 
 /**
@@ -592,7 +592,7 @@ 
             'status' => bigbluebuttonbn_delete_recording_imported(
                 $recordings[$params['id']]['imported']
             )
-          );
+            );
     }
     // As the recordingid was not identified as imported recording link, execute delete on a real recording.
     // First: Delete imported links associated to the recording.
@@ -606,7 +606,7 @@ 
     // Second: Execute the actual delete.
     return array(
         'status' => bigbluebuttonbn_delete_recordings($params['id'])
-      );
+        );
 }
 
 /**
@@ -624,7 +624,7 @@ 
             'status' => bigbluebuttonbn_update_recording_imported(
                 $recordings[$params['id']]['imported'], json_decode($params['meta'], true)
             )
-          );
+            );
     }
 
     // As the recordingid was not identified as imported recording link, execute update on a real recording.
@@ -634,7 +634,7 @@ 
         'status' => bigbluebuttonbn_update_recordings(
             $params['id'], json_decode($params['meta'])
         )
-      );
+        );
 }
 
 /**
@@ -666,14 +666,14 @@ 
     }
     // Sends the messages.
     try {
-      //That if was for trying to workaround the several emails sent for one record ready
-      if(bigbluebuttonbn_get_count_callback_event_log($decodedparameters->record_id) == 0)){
+        //That if was for trying to workaround the several emails sent for one record ready
+        if(bigbluebuttonbn_get_count_callback_event_log($decodedparameters->record_id) == 0)){
         bigbluebuttonbn_send_notification_recording_ready($bigbluebuttonbn);
-      }
-      $overrides = array('meetingid' => $bigbluebuttonbn->meetingid);
-      $meta = '{"recordID":'.$decodedparameters->record_id.'}';
-      bigbluebuttonbn_log($bigbluebuttonbn, BIGBLUEBUTTON_LOG_EVENT_CALLBACK, $overrides, $meta);
-      header('HTTP/1.0 202 Accepted');
+        }
+        $overrides = array('meetingid' => $bigbluebuttonbn->meetingid);
+        $meta = '{"recordID":'.$decodedparameters->record_id.'}';
+        bigbluebuttonbn_log($bigbluebuttonbn, BIGBLUEBUTTON_LOG_EVENT_CALLBACK, $overrides, $meta);
+        header('HTTP/1.0 202 Accepted');
     } catch (Exception $e) {
         $error = 'Caught exception: '.$e->getMessage();
         header('HTTP/1.0 503 Service Unavailable. '.$error);
@@ -807,11 +807,11 @@ 
     $params['recording_ready'] = [
             'bigbluebuttonbn' => 'An id for the bigbluebuttonbn instance should be included.',
             'signed_parameters' => 'A JWT encoded string must be included as [signed_parameters].'
-          ];
+            ];
     $params['live_session_events'] = [
             'bigbluebuttonbn' => 'An id for the bigbluebuttonbn instance should be included.',
             'signed_parameters' => 'A JWT encoded string must be included as [signed_parameters].'
-          ];
+            ];
     return $params;
 }
 
@@ -822,9 +822,9 @@ 
  */
 function bigbluebuttonbn_broker_required_parameters_default($id) {
     return [
-              'id' => "The {$id} must be specified.",
-              'callback' => 'This call must include a javascript callback.'
-           ];
+                'id' => "The {$id} must be specified.",
+                'callback' => 'This call must include a javascript callback.'
+            ];
 }
 
 /**

Spacing +18 added lines, -18 removed lines

@@ -24,8 +24,8 @@ 
  */
 
 
-require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
-require_once(dirname(__FILE__).'/locallib.php');
+require_once(dirname(dirname(dirname(__FILE__))) . '/config.php');
+require_once(dirname(__FILE__) . '/locallib.php');
 
 use \Firebase\JWT\JWT;
 
@@ -41,13 +41,13 @@ 
 $params['meta'] = optional_param('meta', '', PARAM_TEXT);
 
 if (empty($params['action'])) {
-    header('HTTP/1.0 400 Bad Request. Parameter ['.$params['action'].'] was not included');
+    header('HTTP/1.0 400 Bad Request. Parameter [' . $params['action'] . '] was not included');
     return;
 }
 
 $error = bigbluebuttonbn_broker_validate_parameters($params);
 if (!empty($error)) {
-    header('HTTP/1.0 400 Bad Request. '.$error);
+    header('HTTP/1.0 400 Bad Request. ' . $error);
     return;
 }
 
@@ -132,11 +132,11 @@ 
         bigbluebuttonbn_broker_live_session_events($params, $bigbluebuttonbn, $cm);
         return;
     }
-    header('HTTP/1.0 400 Bad request. The action '. $a . ' doesn\'t exist');
+    header('HTTP/1.0 400 Bad request. The action ' . $a . ' doesn\'t exist');
     return;
 
 } catch (Exception $e) {
-    header('HTTP/1.0 500 Internal Server Error. '.$e->getMessage());
+    header('HTTP/1.0 500 Internal Server Error. ' . $e->getMessage());
     return;
 }
 
@@ -322,7 +322,7 @@ 
 function bigbluebuttonbn_broker_recording_info_current($recording, $params) {
     $callbackresponse['status'] = true;
     $callbackresponse['found'] = true;
-    $callbackresponse['published'] = (string) $recording['published'];
+    $callbackresponse['published'] = (string)$recording['published'];
     if (!isset($params['meta']) || empty($params['meta'])) {
         return $callbackresponse;
     }
@@ -651,8 +651,8 @@ 
         $decodedparameters = JWT::decode($params['signed_parameters'],
             \mod_bigbluebuttonbn\locallib\config::get('shared_secret'), array('HS256'));
     } catch (Exception $e) {
-        $error = 'Caught exception: '.$e->getMessage();
-        header('HTTP/1.0 400 Bad Request. '.$error);
+        $error = 'Caught exception: ' . $e->getMessage();
+        header('HTTP/1.0 400 Bad Request. ' . $error);
         return;
     }
 
@@ -667,16 +667,16 @@ 
     // Sends the messages.
     try {
       //That if was for trying to workaround the several emails sent for one record ready
-      if(bigbluebuttonbn_get_count_callback_event_log($decodedparameters->record_id) == 0)){
+      if (bigbluebuttonbn_get_count_callback_event_log($decodedparameters->record_id) == 0)){
         bigbluebuttonbn_send_notification_recording_ready($bigbluebuttonbn);
       }
       $overrides = array('meetingid' => $bigbluebuttonbn->meetingid);
-      $meta = '{"recordID":'.$decodedparameters->record_id.'}';
+      $meta = '{"recordID":' . $decodedparameters->record_id . '}';
       bigbluebuttonbn_log($bigbluebuttonbn, BIGBLUEBUTTON_LOG_EVENT_CALLBACK, $overrides, $meta);
       header('HTTP/1.0 202 Accepted');
     } catch (Exception $e) {
-        $error = 'Caught exception: '.$e->getMessage();
-        header('HTTP/1.0 503 Service Unavailable. '.$error);
+        $error = 'Caught exception: ' . $e->getMessage();
+        header('HTTP/1.0 503 Service Unavailable. ' . $error);
     }
 }
 
@@ -697,13 +697,13 @@ 
     $importrecordings = $SESSION->bigbluebuttonbn_importrecordings;
     if (!isset($importrecordings[$params['id']])) {
         $error = "Recording {$params['id']} could not be found. It can not be imported";
-        header('HTTP/1.0 404 Not found. '.$error);
+        header('HTTP/1.0 404 Not found. ' . $error);
         return;
     }
     $callbackresponse = array('status' => true);
     $importrecordings[$params['id']]['imported'] = true;
     $overrides = array('meetingid' => $importrecordings[$params['id']]['meetingID']);
-    $meta = '{"recording":'.json_encode($importrecordings[$params['id']]).'}';
+    $meta = '{"recording":' . json_encode($importrecordings[$params['id']]) . '}';
     bigbluebuttonbn_log($bbbsession['bigbluebuttonbn'], BIGBLUEBUTTONBN_LOG_EVENT_IMPORT, $overrides, $meta);
     // Moodle event logger: Create an event for recording imported.
     if (isset($bbbsession['bigbluebutton']) && isset($bbbsession['cm'])) {
@@ -729,8 +729,8 @@ 
         $decodedparameters = JWT::decode($params['signed_parameters'],
             \mod_bigbluebuttonbn\locallib\config::get('shared_secret'), array('HS256'));
     } catch (Exception $e) {
-        $error = 'Caught exception: '.$e->getMessage();
-        header('HTTP/1.0 400 Bad Request. '.$error);
+        $error = 'Caught exception: ' . $e->getMessage();
+        header('HTTP/1.0 400 Bad Request. ' . $error);
         return;
     }
     // Validate that the bigbluebuttonbn activity corresponds to the meeting_id received.
@@ -765,7 +765,7 @@ 
     $requiredparams = bigbluebuttonbn_broker_required_parameters();
     $action = strtolower($params['action']);
     if (!array_key_exists($action, $requiredparams)) {
-        return 'Action '.$params['action'].' can not be performed.';
+        return 'Action ' . $params['action'] . ' can not be performed.';
     }
     return bigbluebuttonbn_broker_validate_parameters_message($params, $requiredparams[$action]);
 }

Braces +3 added lines, -1 removed lines

@@ -667,9 +667,11 @@
     // Sends the messages.
     try {
       //That if was for trying to workaround the several emails sent for one record ready
-      if(bigbluebuttonbn_get_count_callback_event_log($decodedparameters->record_id) == 0)){
+      if(bigbluebuttonbn_get_count_callback_event_log($decodedparameters->record_id) == 0) {
+          ){
         bigbluebuttonbn_send_notification_recording_ready($bigbluebuttonbn);
       }
+      }
       $overrides = array('meetingid' => $bigbluebuttonbn->meetingid);
       $meta = '{"recordID":'.$decodedparameters->record_id.'}';
       bigbluebuttonbn_log($bigbluebuttonbn, BIGBLUEBUTTON_LOG_EVENT_CALLBACK, $overrides, $meta);