blindsidenetworks / moodle-mod_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) {
@@ -272,7 +272,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;
@@ -293,7 +293,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)) {
@@ -869,7 +869,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) {
 

Indentation +4 added lines, -4 removed lines

@@ -356,7 +356,7 @@ 
     $sql = "SELECT COUNT(*) FROM {bigbluebuttonbn_logs} ";
     $sql .= "WHERE courseid = ? AND bigbluebuttonbnid = ? AND userid = ? AND (log = ? OR log = ?)";
     $result = $DB->count_records_sql($sql, array($course->id, $bigbluebuttonbn->id, $user->id,
-                                              BIGBLUEBUTTONBN_LOG_EVENT_JOIN, BIGBLUEBUTTONBN_LOG_EVENT_PLAYED));
+                                                BIGBLUEBUTTONBN_LOG_EVENT_JOIN, BIGBLUEBUTTONBN_LOG_EVENT_PLAYED));
     return $result;
 }
 
@@ -589,12 +589,12 @@ 
     $str  = '<div class="bigbluebuttonbn overview">'."\n";
     $str .= '  <div class="name">'.get_string('modulename', 'bigbluebuttonbn').':&nbsp;'."\n";
     $str .= '    <a '.$classes.'href="'.$CFG->wwwroot.'/mod/bigbluebuttonbn/view.php?id='.$bigbluebuttonbn->coursemodule.
-      '">'.$bigbluebuttonbn->name.'</a>'."\n";
+        '">'.$bigbluebuttonbn->name.'</a>'."\n";
     $str .= '  </div>'."\n";
     $str .= '  <div class="info">'.get_string($start, 'bigbluebuttonbn').': '.userdate($bigbluebuttonbn->openingtime).
         '</div>'."\n";
     $str .= '  <div class="info">'.get_string('ends_at', 'bigbluebuttonbn').': '.userdate($bigbluebuttonbn->closingtime)
-      .'</div>'."\n";
+        .'</div>'."\n";
     $str .= '</div>'."\n";
     return $str;
 }
@@ -836,7 +836,7 @@ 
             'bigbluebuttonbn',
             $bigbluebuttonbn->id,
             $bigbluebuttonbn->completionexpected
-          );
+            );
     }
 }
 

Spacing +33 added lines, -33 removed lines

@@ -30,10 +30,10 @@ 
 
 // JWT is included in Moodle 3.7 core, but a local package is still needed for backward compatibility.
 if (!class_exists('\Firebase\JWT\JWT')) {
-    if (file_exists($CFG->libdir.'/php-jwt/src/JWT.php')) {
-        require_once($CFG->libdir.'/php-jwt/src/JWT.php');
+    if (file_exists($CFG->libdir . '/php-jwt/src/JWT.php')) {
+        require_once($CFG->libdir . '/php-jwt/src/JWT.php');
     } else {
-        require_once($CFG->dirroot.'/mod/bigbluebuttonbn/vendor/firebase/php-jwt/src/JWT.php');
+        require_once($CFG->dirroot . '/mod/bigbluebuttonbn/vendor/firebase/php-jwt/src/JWT.php');
     }
 }
 
@@ -41,8 +41,8 @@ 
     $CFG->bigbluebuttonbn = array();
 }
 
-if (file_exists(dirname(__FILE__).'/config.php')) {
-    require_once(dirname(__FILE__).'/config.php');
+if (file_exists(dirname(__FILE__) . '/config.php')) {
+    require_once(dirname(__FILE__) . '/config.php');
 }
 
 /*
@@ -99,19 +99,19 @@ 
         return null;
     }
     $features = array(
-        (string) FEATURE_IDNUMBER => true,
-        (string) FEATURE_GROUPS => true,
-        (string) FEATURE_GROUPINGS => true,
-        (string) FEATURE_GROUPMEMBERSONLY => true,
-        (string) FEATURE_MOD_INTRO => true,
-        (string) FEATURE_BACKUP_MOODLE2 => true,
-        (string) FEATURE_COMPLETION_TRACKS_VIEWS => true,
-        (string) FEATURE_COMPLETION_HAS_RULES => true,
-        (string) FEATURE_GRADE_HAS_GRADE => false,
-        (string) FEATURE_GRADE_OUTCOMES => false,
-        (string) FEATURE_SHOW_DESCRIPTION => true,
+        (string)FEATURE_IDNUMBER => true,
+        (string)FEATURE_GROUPS => true,
+        (string)FEATURE_GROUPINGS => true,
+        (string)FEATURE_GROUPMEMBERSONLY => true,
+        (string)FEATURE_MOD_INTRO => true,
+        (string)FEATURE_BACKUP_MOODLE2 => true,
+        (string)FEATURE_COMPLETION_TRACKS_VIEWS => true,
+        (string)FEATURE_COMPLETION_HAS_RULES => true,
+        (string)FEATURE_GRADE_HAS_GRADE => false,
+        (string)FEATURE_GRADE_OUTCOMES => false,
+        (string)FEATURE_SHOW_DESCRIPTION => true,
     );
-    if (isset($features[(string) $feature])) {
+    if (isset($features[(string)$feature])) {
         return $features[$feature];
     }
     return null;
@@ -304,7 +304,7 @@ 
 function bigbluebuttonbn_delete_instance_log($bigbluebuttonbn) {
     global $DB;
     $sql  = "SELECT * FROM {bigbluebuttonbn_logs} ";
-    $sql .= "WHERE bigbluebuttonbnid = ? AND log = ? AND ". $DB->sql_compare_text('meta') . " = ?";
+    $sql .= "WHERE bigbluebuttonbnid = ? AND log = ? AND " . $DB->sql_compare_text('meta') . " = ?";
     $logs = $DB->get_records_sql($sql, array($bigbluebuttonbn->id, BIGBLUEBUTTONBN_LOG_EVENT_CREATE, "{\"record\":true}"));
     $meta = "{\"has_recordings\":" . empty($logs) ? "true" : "false" . "}";
     bigbluebuttonbn_log($bigbluebuttonbn, BIGBLUEBUTTONBN_LOG_EVENT_DELETE, [], $meta);
@@ -325,7 +325,7 @@ 
 function bigbluebuttonbn_user_outline($course, $user, $mod, $bigbluebuttonbn) {
     if ($completed = bigbluebuttonbn_user_complete($course, $user, $bigbluebuttonbn)) {
         return fullname($user) . ' ' . get_string('view_message_has_joined', 'bigbluebuttonbn') . ' ' .
-            get_string('view_message_session_for', 'bigbluebuttonbn') . ' ' . (string) $completed . ' ' .
+            get_string('view_message_session_for', 'bigbluebuttonbn') . ' ' . (string)$completed . ' ' .
             get_string('view_message_times', 'bigbluebuttonbn');
     }
     return '';
@@ -517,7 +517,7 @@ 
  * @return array status array
  */
 function bigbluebuttonbn_reset_recordings($courseid) {
-    require_once(__DIR__.'/locallib.php');
+    require_once(__DIR__ . '/locallib.php');
     // Criteria for search [courseid | bigbluebuttonbn=null | subset=false | includedeleted=true].
     $recordings = bigbluebuttonbn_get_recordings($courseid, null, false, true);
     // Remove all the recordings.
@@ -586,16 +586,16 @@ 
     if ($bigbluebuttonbn->visible) {
         $classes = 'class="dimmed" ';
     }
-    $str  = '<div class="bigbluebuttonbn overview">'."\n";
-    $str .= '  <div class="name">'.get_string('modulename', 'bigbluebuttonbn').':&nbsp;'."\n";
-    $str .= '    <a '.$classes.'href="'.$CFG->wwwroot.'/mod/bigbluebuttonbn/view.php?id='.$bigbluebuttonbn->coursemodule.
-      '">'.$bigbluebuttonbn->name.'</a>'."\n";
-    $str .= '  </div>'."\n";
-    $str .= '  <div class="info">'.get_string($start, 'bigbluebuttonbn').': '.userdate($bigbluebuttonbn->openingtime).
-        '</div>'."\n";
-    $str .= '  <div class="info">'.get_string('ends_at', 'bigbluebuttonbn').': '.userdate($bigbluebuttonbn->closingtime)
-      .'</div>'."\n";
-    $str .= '</div>'."\n";
+    $str  = '<div class="bigbluebuttonbn overview">' . "\n";
+    $str .= '  <div class="name">' . get_string('modulename', 'bigbluebuttonbn') . ':&nbsp;' . "\n";
+    $str .= '    <a ' . $classes . 'href="' . $CFG->wwwroot . '/mod/bigbluebuttonbn/view.php?id=' . $bigbluebuttonbn->coursemodule .
+      '">' . $bigbluebuttonbn->name . '</a>' . "\n";
+    $str .= '  </div>' . "\n";
+    $str .= '  <div class="info">' . get_string($start, 'bigbluebuttonbn') . ': ' . userdate($bigbluebuttonbn->openingtime) .
+        '</div>' . "\n";
+    $str .= '  <div class="info">' . get_string('ends_at', 'bigbluebuttonbn') . ': ' . userdate($bigbluebuttonbn->closingtime)
+      .'</div>' . "\n";
+    $str .= '</div>' . "\n";
     return $str;
 }
 
@@ -683,7 +683,7 @@ 
  * @return void
  **/
 function bigbluebuttonbn_process_pre_save_instance(&$bigbluebuttonbn) {
-    require_once(__DIR__.'/locallib.php');
+    require_once(__DIR__ . '/locallib.php');
     $bigbluebuttonbn->timemodified = time();
     if ((integer)$bigbluebuttonbn->instance == 0) {
         $bigbluebuttonbn->meetingid = 0;
@@ -871,7 +871,7 @@ 
     if (count($files) == 1) {
         // Get the first (and only) file.
         $file = reset($files);
-        $filesrc = '/'.$file->get_filename();
+        $filesrc = '/' . $file->get_filename();
     }
     return $filesrc;
 }
@@ -940,7 +940,7 @@ 
     if (!$filename) {
         return false;
     }
-    $fullpath = "/$context->id/mod_bigbluebuttonbn/$filearea/0/".$filename;
+    $fullpath = "/$context->id/mod_bigbluebuttonbn/$filearea/0/" . $filename;
     $fs = get_file_storage();
     $file = $fs->get_file_by_hash(sha1($fullpath));
     if (!$file || $file->is_directory()) {

brokerlib.php

Spacing +8 added lines, -8 removed lines

@@ -208,7 +208,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;
     }
@@ -559,8 +559,8 @@ 
             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.
@@ -590,8 +590,8 @@ 
         bigbluebuttonbn_log($bigbluebuttonbn, BIGBLUEBUTTON_LOG_EVENT_CALLBACK, $overrides, json_encode($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);
     }
 }
 
@@ -612,13 +612,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'])) {
@@ -712,7 +712,7 @@ 
     $action = strtolower($params['action']);
     $requiredparams = bigbluebuttonbn_broker_required_parameters();
     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]);
 }

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').

Spacing +28 added lines, -28 removed lines

@@ -44,29 +44,29 @@ 
      * @return string
      */
     public static function htmlmsg_instance_updated($msg) {
-        $messagetext = '<p>'.$msg->activity_type.' "'.$msg->activity_title.'" '.
-            get_string('email_body_notification_meeting_has_been', 'bigbluebuttonbn').' '.$msg->action.'.</p>'."\n";
-        $messagetext .= '<p><b>'.$msg->activity_title.'</b> '.
-            get_string('email_body_notification_meeting_details', 'bigbluebuttonbn').':'."\n";
-        $messagetext .= '<table border="0" style="margin: 5px 0 0 20px"><tbody>'."\n";
-        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
-            get_string('email_body_notification_meeting_title', 'bigbluebuttonbn').': </td><td>'."\n";
-        $messagetext .= $msg->activity_title.'</td></tr>'."\n";
-        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
-            get_string('email_body_notification_meeting_description', 'bigbluebuttonbn').': </td><td>'."\n";
-        $messagetext .= $msg->activity_description.'</td></tr>'."\n";
-        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
-            get_string('email_body_notification_meeting_start_date', 'bigbluebuttonbn').': </td><td>'."\n";
-        $messagetext .= $msg->activity_openingtime.'</td></tr>'."\n";
-        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
-            get_string('email_body_notification_meeting_end_date', 'bigbluebuttonbn').': </td><td>'."\n";
-        $messagetext .= $msg->activity_closingtime.'</td></tr>'."\n";
-        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.$msg->action.' '.
-            get_string('email_body_notification_meeting_by', 'bigbluebuttonbn').': </td><td>'."\n";
-        $messagetext .= $msg->activity_owner.'</td></tr></tbody></table></p>'."\n";
-        $messagetext .= '<p><hr/><br/>'.get_string('email_footer_sent_by', 'bigbluebuttonbn').' '.
-            $msg->user_name.'('.$msg->user_email.') ';
-        $messagetext .= get_string('email_footer_sent_from', 'bigbluebuttonbn').' '.$msg->course_name.'.</p>';
+        $messagetext = '<p>' . $msg->activity_type . ' "' . $msg->activity_title . '" ' .
+            get_string('email_body_notification_meeting_has_been', 'bigbluebuttonbn') . ' ' . $msg->action . '.</p>' . "\n";
+        $messagetext .= '<p><b>' . $msg->activity_title . '</b> ' .
+            get_string('email_body_notification_meeting_details', 'bigbluebuttonbn') . ':' . "\n";
+        $messagetext .= '<table border="0" style="margin: 5px 0 0 20px"><tbody>' . "\n";
+        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">' .
+            get_string('email_body_notification_meeting_title', 'bigbluebuttonbn') . ': </td><td>' . "\n";
+        $messagetext .= $msg->activity_title . '</td></tr>' . "\n";
+        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">' .
+            get_string('email_body_notification_meeting_description', 'bigbluebuttonbn') . ': </td><td>' . "\n";
+        $messagetext .= $msg->activity_description . '</td></tr>' . "\n";
+        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">' .
+            get_string('email_body_notification_meeting_start_date', 'bigbluebuttonbn') . ': </td><td>' . "\n";
+        $messagetext .= $msg->activity_openingtime . '</td></tr>' . "\n";
+        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">' .
+            get_string('email_body_notification_meeting_end_date', 'bigbluebuttonbn') . ': </td><td>' . "\n";
+        $messagetext .= $msg->activity_closingtime . '</td></tr>' . "\n";
+        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">' . $msg->action . ' ' .
+            get_string('email_body_notification_meeting_by', 'bigbluebuttonbn') . ': </td><td>' . "\n";
+        $messagetext .= $msg->activity_owner . '</td></tr></tbody></table></p>' . "\n";
+        $messagetext .= '<p><hr/><br/>' . get_string('email_footer_sent_by', 'bigbluebuttonbn') . ' ' .
+            $msg->user_name . '(' . $msg->user_email . ') ';
+        $messagetext .= get_string('email_footer_sent_from', 'bigbluebuttonbn') . ' ' . $msg->course_name . '.</p>';
         return $messagetext;
     }
 
@@ -83,7 +83,7 @@ 
         $course = $coursemodinfo->get_course($bigbluebuttonbn->course);
         $sender = $USER;
         // Prepare message.
-        $msg = (object) array();
+        $msg = (object)array();
         // Build the message_body.
         $msg->action = $action;
         $msg->activity_type = '';
@@ -114,9 +114,9 @@ 
      * @return void
      */
     public static function htmlmsg_recording_ready($bigbluebuttonbn) {
-        return '<p>'.get_string('email_body_recording_ready_for', 'bigbluebuttonbn').
-            ' &quot;' . $bigbluebuttonbn->name . '&quot; '.
-            get_string('email_body_recording_ready_is_ready', 'bigbluebuttonbn').'.</p>';
+        return '<p>' . get_string('email_body_recording_ready_for', 'bigbluebuttonbn') .
+            ' &quot;' . $bigbluebuttonbn->name . '&quot; ' .
+            get_string('email_body_recording_ready_is_ready', 'bigbluebuttonbn') . '.</p>';
     }
 
     /**
@@ -158,7 +158,7 @@ 
                     // Enqueue it.
                     \core\task\manager::queue_adhoc_task($task);
                 } catch (Exception $e) {
-                    mtrace("Error while enqueuing completion_uopdate_state task. " . (string) $e);
+                    mtrace("Error while enqueuing completion_uopdate_state task. " . (string)$e);
                 }
             }
         }

locallib.php

Doc Comments +14 added lines, -14 removed lines

@@ -306,7 +306,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
  *
@@ -334,7 +334,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(
@@ -416,7 +416,7 @@ 
  * @param object $a
  * @param object $b
  *
- * @return array
+ * @return integer
  */
 function bigbluebuttonbn_recording_build_sorter($a, $b) {
     global $CFG;
@@ -530,7 +530,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')) {
@@ -571,7 +571,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();
@@ -944,7 +944,7 @@ 
  * @param integer $instance
  * @param integer $voicebridge
  *
- * @return string
+ * @return boolean
  */
 function bigbluebuttonbn_voicebridge_unique($instance, $voicebridge) {
     global $DB;
@@ -1292,7 +1292,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?';
@@ -1346,7 +1346,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)) {
@@ -1981,7 +1981,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recording
- * @param object $rowdata
+ * @param stdClass $rowdata
  *
  * @return object
  */
@@ -2176,7 +2176,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recordings
- * @param array $tools
+ * @param string[] $tools
  *
  * @return array
  */
@@ -2257,7 +2257,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
  *
@@ -2281,7 +2281,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
  *
@@ -2304,7 +2304,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
@@ -2322,7 +2322,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

Spacing +54 added lines, -54 removed lines

@@ -189,7 +189,7 @@ 
     }
     if ($xml) {
         // Either failure or success without meeting info.
-        return (array) $xml;
+        return (array)$xml;
     }
     // If the server is unreachable, then prompts the user of the necessary action.
     return array('returncode' => 'FAILED', 'message' => 'unreachable', 'messageKey' => 'Server is unreachable');
@@ -268,7 +268,7 @@ 
                 foreach ($recordingxml->breakoutRooms->breakoutRoom as $breakoutroom) {
                     $url = \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url(
                         'getRecordings',
-                        ['recordID' => implode(',', (array) $breakoutroom)]
+                        ['recordID' => implode(',', (array)$breakoutroom)]
                     );
                     $xml = bigbluebuttonbn_wrap_xml_load_file($url);
                     if ($xml && $xml->returncode == 'SUCCESS' && isset($xml->recordings)) {
@@ -324,7 +324,7 @@ 
         // Override imported flag with actual ID.
         $recording['imported'] = $recordimported->id;
         if (isset($recordimported->protected)) {
-            $recording['protected'] = (string) $recordimported->protected;
+            $recording['protected'] = (string)$recordimported->protected;
         }
         $recordsimportedarray[$recording['recordID']] = $recording;
     }
@@ -354,21 +354,21 @@ 
     // Add formats.
     $playbackarray = array();
     foreach ($recording->playback->format as $format) {
-        $playbackarray[(string) $format->type] = array('type' => (string) $format->type,
-            'url' => trim((string) $format->url), 'length' => (string) $format->length);
+        $playbackarray[(string)$format->type] = array('type' => (string)$format->type,
+            'url' => trim((string)$format->url), 'length' => (string)$format->length);
         // Add preview per format when existing.
         if ($format->preview) {
-            $playbackarray[(string) $format->type]['preview'] = bigbluebuttonbn_get_recording_preview_images($format->preview);
+            $playbackarray[(string)$format->type]['preview'] = bigbluebuttonbn_get_recording_preview_images($format->preview);
         }
     }
     // Add the metadata to the recordings array.
     $metadataarray = bigbluebuttonbn_get_recording_array_meta(get_object_vars($recording->metadata));
-    $recordingarray = array('recordID' => (string) $recording->recordID,
-        'meetingID' => (string) $recording->meetingID, 'meetingName' => (string) $recording->name,
-        'published' => (string) $recording->published, 'startTime' => (string) $recording->startTime,
-        'endTime' => (string) $recording->endTime, 'playbacks' => $playbackarray);
+    $recordingarray = array('recordID' => (string)$recording->recordID,
+        'meetingID' => (string)$recording->meetingID, 'meetingName' => (string)$recording->name,
+        'published' => (string)$recording->published, 'startTime' => (string)$recording->startTime,
+        'endTime' => (string)$recording->endTime, 'playbacks' => $playbackarray);
     if (isset($recording->protected)) {
-        $recordingarray['protected'] = (string) $recording->protected;
+        $recordingarray['protected'] = (string)$recording->protected;
     }
     return $recordingarray + $metadataarray;
 }
@@ -383,9 +383,9 @@ 
 function bigbluebuttonbn_get_recording_preview_images($preview) {
     $imagesarray = array();
     foreach ($preview->images->image as $image) {
-        $imagearray = array('url' => trim((string) $image));
+        $imagearray = array('url' => trim((string)$image));
         foreach ($image->attributes() as $attkey => $attvalue) {
-            $imagearray[$attkey] = (string) $attvalue;
+            $imagearray[$attkey] = (string)$attvalue;
         }
         array_push($imagesarray, $imagearray);
     }
@@ -480,7 +480,7 @@ 
     $ids = explode(',', $recordids);
     foreach ($ids as $id) {
         $xml = bigbluebuttonbn_wrap_xml_load_file(
-            \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('updateRecordings', ['recordID' => $id] + (array) $params)
+            \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('updateRecordings', ['recordID' => $id] + (array)$params)
         );
         if ($xml && $xml->returncode != 'SUCCESS') {
             return false;
@@ -649,7 +649,7 @@ 
  * @return array $users
  */
 function bigbluebuttonbn_get_users(context $context = null) {
-    $users = (array) get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
+    $users = (array)get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
     foreach ($users as $key => $value) {
         $users[$key] = fullname($value);
     }
@@ -664,7 +664,7 @@ 
  * @return array $users
  */
 function bigbluebuttonbn_get_users_select(context $context = null) {
-    $users = (array) get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
+    $users = (array)get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
     foreach ($users as $key => $value) {
         $users[$key] = array('id' => $value->id, 'name' => fullname($value));
     }
@@ -679,7 +679,7 @@ 
  * @return array $roles
  */
 function bigbluebuttonbn_get_roles(context $context = null) {
-    $roles = (array) role_get_names($context);
+    $roles = (array)role_get_names($context);
     foreach ($roles as $key => $value) {
         $roles[$key] = $value->localname;
     }
@@ -694,7 +694,7 @@ 
  * @return array $users
  */
 function bigbluebuttonbn_get_roles_select(context $context = null) {
-    $roles = (array) role_get_names($context);
+    $roles = (array)role_get_names($context);
     foreach ($roles as $key => $value) {
         $roles[$key] = array('id' => $value->id, 'name' => $value->localname);
     }
@@ -709,9 +709,9 @@ 
  * @return object $role
  */
 function bigbluebuttonbn_get_role($id) {
-    $roles = (array) role_get_names();
+    $roles = (array)role_get_names();
     if (is_numeric($id) && isset($roles[$id])) {
-        return (object) $roles[$id];
+        return (object)$roles[$id];
     }
     foreach ($roles as $role) {
         if ($role->shortname == $id) {
@@ -791,7 +791,7 @@ 
             if (!empty($ownerid) && is_enrolled($context, $ownerid)) {
                 $participantlist[] = array(
                     'selectiontype' => 'user',
-                    'selectionid' => (string) $ownerid,
+                    'selectionid' => (string)$ownerid,
                     'role' => BIGBLUEBUTTONBN_ROLE_MODERATOR);
             }
             continue;
@@ -973,7 +973,7 @@ 
     $now = time();
     if ($closingtime > 0 && $now < $closingtime) {
         $duration = ceil(($closingtime - $now) / 60);
-        $compensationtime = intval((int) \mod_bigbluebuttonbn\locallib\config::get('scheduled_duration_compensation'));
+        $compensationtime = intval((int)\mod_bigbluebuttonbn\locallib\config::get('scheduled_duration_compensation'));
         $duration = intval($duration) + $compensationtime;
     }
     return $duration;
@@ -1175,16 +1175,16 @@ 
  * @return array
  */
 function bigbluebuttonbn_get_meeting_info($meetingid, $updatecache = false) {
-    $cachettl = (int) \mod_bigbluebuttonbn\locallib\config::get('waitformoderator_cache_ttl');
+    $cachettl = (int)\mod_bigbluebuttonbn\locallib\config::get('waitformoderator_cache_ttl');
     $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'mod_bigbluebuttonbn', 'meetings_cache');
     $result = $cache->get($meetingid);
     $now = time();
     if (!$updatecache && isset($result) && $now < ($result['creation_time'] + $cachettl)) {
         // Use the value in the cache.
-        return (array) json_decode($result['meeting_info']);
+        return (array)json_decode($result['meeting_info']);
     }
     // Ping again and refresh the cache.
-    $meetinginfo = (array) bigbluebuttonbn_wrap_xml_load_file(
+    $meetinginfo = (array)bigbluebuttonbn_wrap_xml_load_file(
         \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('getMeetingInfo', ['meetingID' => $meetingid])
     );
     $cache->set($meetingid, array('creation_time' => time(), 'meeting_info' => json_encode($meetinginfo)));
@@ -1331,7 +1331,7 @@ 
  */
 function bigbluebuttonbn_set_config_xml_array($meetingid, $configxml) {
     $configxml = bigbluebuttonbn_setConfigXML($meetingid, $configxml);
-    $configxmlarray = (array) $configxml;
+    $configxmlarray = (array)$configxml;
     if ($configxmlarray['returncode'] != 'SUCCESS') {
         debugging('BigBlueButton was not able to set the custom config.xml file', DEBUG_DEVELOPER);
         return '';
@@ -1386,7 +1386,7 @@ 
  * @return boolean
  */
 function bigbluebuttonbn_get_recording_data_row_editable($bbbsession) {
-    return ($bbbsession['managerecordings'] && ((double) $bbbsession['serverversion'] >= 1.0 || $bbbsession['bnserver']));
+    return ($bbbsession['managerecordings'] && ((double)$bbbsession['serverversion'] >= 1.0 || $bbbsession['bnserver']));
 }
 
 /**
@@ -1397,7 +1397,7 @@ 
  * @return boolean
  */
 function bigbluebuttonbn_get_recording_data_preview_enabled($bbbsession) {
-    return ((double) $bbbsession['serverversion'] >= 1.0 && $bbbsession['bigbluebuttonbn']->recordings_preview == '1');
+    return ((double)$bbbsession['serverversion'] >= 1.0 && $bbbsession['bigbluebuttonbn']->recordings_preview == '1');
 }
 
 /**
@@ -1804,7 +1804,7 @@ 
     }
     $id = 'recording-' . $target . '-' . $recording['recordID'];
     $onclick = 'M.mod_bigbluebuttonbn.recordings.recording' . ucfirst($data['action']) . '(this);';
-    if ((boolean) \mod_bigbluebuttonbn\locallib\config::get('recording_icons_enabled')) {
+    if ((boolean)\mod_bigbluebuttonbn\locallib\config::get('recording_icons_enabled')) {
         // With icon for $manageaction.
         $iconattributes = array('id' => $id, 'class' => 'iconsmall');
         $linkattributes = array(
@@ -1948,7 +1948,7 @@ 
         $groupmode = $DB->get_record_sql($sql, $params, IGNORE_MULTIPLE);
 
         $displayrow = true;
-        if ((isset($groupmode->groupmode) && (int) $groupmode->groupmode != VISIBLEGROUPS)
+        if ((isset($groupmode->groupmode) && (int)$groupmode->groupmode != VISIBLEGROUPS)
             && !$bbbsession['administrator'] && !$bbbsession['moderator']) {
             $groupid = explode('[', $recording['meetingID']);
             if (isset($groupid[1])) {
@@ -2098,7 +2098,7 @@ 
         // Enqueue it.
         \core\task\manager::queue_adhoc_task($task);
     } catch (Exception $e) {
-        mtrace("Error while enqueuing completion_update_state task. " . (string) $e);
+        mtrace("Error while enqueuing completion_update_state task. " . (string)$e);
     }
 }
 
@@ -2635,7 +2635,7 @@ 
  */
 function bigbluebuttonbn_settings_general(&$renderer) {
     // Configuration for BigBlueButton.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_general_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_general_shown()) {
         $renderer->render_group_header('general');
         $renderer->render_group_element(
             'server_url',
@@ -2657,7 +2657,7 @@ 
  */
 function bigbluebuttonbn_settings_record(&$renderer) {
     // Configuration for 'recording' feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_record_meeting_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_record_meeting_shown()) {
         $renderer->render_group_header('recording');
         $renderer->render_group_element(
             'recording_default',
@@ -2701,7 +2701,7 @@ 
  */
 function bigbluebuttonbn_settings_importrecordings(&$renderer) {
     // Configuration for 'import recordings' feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_import_recordings_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_import_recordings_shown()) {
         $renderer->render_group_header('importrecordings');
         $renderer->render_group_element(
             'importrecordings_enabled',
@@ -2723,7 +2723,7 @@ 
  */
 function bigbluebuttonbn_settings_showrecordings(&$renderer) {
     // Configuration for 'show recordings' feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_show_recordings_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_show_recordings_shown()) {
         $renderer->render_group_header('recordings');
         $renderer->render_group_element(
             'recordings_html_default',
@@ -2773,7 +2773,7 @@ 
  */
 function bigbluebuttonbn_settings_waitmoderator(&$renderer) {
     // Configuration for wait for moderator feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_wait_moderator_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_wait_moderator_shown()) {
         $renderer->render_group_header('waitformoderator');
         $renderer->render_group_element(
             'waitformoderator_default',
@@ -2803,7 +2803,7 @@ 
  */
 function bigbluebuttonbn_settings_voicebridge(&$renderer) {
     // Configuration for "static voice bridge" feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_static_voice_bridge_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_static_voice_bridge_shown()) {
         $renderer->render_group_header('voicebridge');
         $renderer->render_group_element(
             'voicebridge_editable',
@@ -2821,7 +2821,7 @@ 
  */
 function bigbluebuttonbn_settings_preupload(&$renderer) {
     // Configuration for "preupload presentation" feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_preupload_presentation_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_preupload_presentation_shown()) {
         // This feature only works if curl is installed.
         $preuploaddescripion = get_string('config_preuploadpresentation_description', 'bigbluebuttonbn');
         if (!extension_loaded('curl')) {
@@ -2849,7 +2849,7 @@ 
  */
 function bigbluebuttonbn_settings_preupload_manage_default_file(&$renderer) {
     // Configuration for "preupload presentation" feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_preupload_presentation_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_preupload_presentation_shown()) {
         if (extension_loaded('curl')) {
             // This feature only works if curl is installed.
             $renderer->render_filemanager_default_file_presentation("presentation_default");
@@ -2866,7 +2866,7 @@ 
  */
 function bigbluebuttonbn_settings_userlimit(&$renderer) {
     // Configuration for "user limit" feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_user_limit_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_user_limit_shown()) {
         $renderer->render_group_header('userlimit');
         $renderer->render_group_element(
             'userlimit_default',
@@ -2888,7 +2888,7 @@ 
  */
 function bigbluebuttonbn_settings_duration(&$renderer) {
     // Configuration for "scheduled duration" feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_scheduled_duration_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_scheduled_duration_shown()) {
         $renderer->render_group_header('scheduled');
         $renderer->render_group_element(
             'scheduled_duration_enabled',
@@ -2914,7 +2914,7 @@ 
  */
 function bigbluebuttonbn_settings_participants(&$renderer) {
     // Configuration for defining the default role/user that will be moderator on new activities.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_moderator_default_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_moderator_default_shown()) {
         $renderer->render_group_header('participant');
         // UI for 'participants' feature.
         $roles = bigbluebuttonbn_get_roles();
@@ -2939,7 +2939,7 @@ 
  */
 function bigbluebuttonbn_settings_notifications(&$renderer) {
     // Configuration for "send notifications" feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_send_notifications_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_send_notifications_shown()) {
         $renderer->render_group_header('sendnotifications');
         $renderer->render_group_element(
             'sendnotifications_enabled',
@@ -2957,14 +2957,14 @@ 
  */
 function bigbluebuttonbn_settings_clienttype(&$renderer) {
     // Configuration for "clienttype" feature.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_clienttype_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_clienttype_shown()) {
         $renderer->render_group_header('clienttype');
         $renderer->render_group_element(
             'clienttype_editable',
             $renderer->render_group_element_checkbox('clienttype_editable', 0)
         );
         // Web Client default.
-        $default = intval((int) \mod_bigbluebuttonbn\locallib\config::get('clienttype_default'));
+        $default = intval((int)\mod_bigbluebuttonbn\locallib\config::get('clienttype_default'));
         $choices = array(BIGBLUEBUTTON_CLIENTTYPE_FLASH => get_string('mod_form_block_clienttype_flash', 'bigbluebuttonbn'),
             BIGBLUEBUTTON_CLIENTTYPE_HTML5 => get_string('mod_form_block_clienttype_html5', 'bigbluebuttonbn'));
         $renderer->render_group_element(
@@ -2987,7 +2987,7 @@ 
  */
 function bigbluebuttonbn_settings_muteonstart(&$renderer) {
     // Configuration for BigBlueButton.
-    if ((boolean) \mod_bigbluebuttonbn\settings\validator::section_muteonstart_shown()) {
+    if ((boolean)\mod_bigbluebuttonbn\settings\validator::section_muteonstart_shown()) {
         $renderer->render_group_header('muteonstart');
         $renderer->render_group_element(
             'muteonstart_default',
@@ -3009,7 +3009,7 @@ 
  */
 function bigbluebuttonbn_settings_extended(&$renderer) {
     // Configuration for 'notify users when recording ready' feature.
-    if (!(boolean) \mod_bigbluebuttonbn\settings\validator::section_settings_extended_shown()) {
+    if (!(boolean)\mod_bigbluebuttonbn\settings\validator::section_settings_extended_shown()) {
         return;
     }
     $renderer->render_group_header('extended_capabilities');
@@ -3037,7 +3037,7 @@ 
     global $DB;
     do {
         $encodedseed = sha1(bigbluebuttonbn_random_password(12));
-        $meetingid = (string) $DB->get_field('bigbluebuttonbn', 'meetingid', array('meetingid' => $encodedseed));
+        $meetingid = (string)$DB->get_field('bigbluebuttonbn', 'meetingid', array('meetingid' => $encodedseed));
     } while ($meetingid == $encodedseed);
     return $encodedseed;
 }
@@ -3250,7 +3250,7 @@ 
 function bigbluebuttonbn_instance_ownerid($bigbluebuttonbn) {
     global $DB;
     $filters = array('bigbluebuttonbnid' => $bigbluebuttonbn->id, 'log' => 'Add');
-    $ownerid = (integer) $DB->get_field('bigbluebuttonbn_logs', 'userid', $filters);
+    $ownerid = (integer)$DB->get_field('bigbluebuttonbn_logs', 'userid', $filters);
     return $ownerid;
 }
 
@@ -3293,8 +3293,8 @@ 
     $bbbsession['meetingname'] = $bbbsession['bigbluebuttonbn']->name;
     $bbbsession['meetingdescription'] = $bbbsession['bigbluebuttonbn']->intro;
     // Extra data for setting up the Meeting.
-    $bbbsession['userlimit'] = intval((int) \mod_bigbluebuttonbn\locallib\config::get('userlimit_default'));
-    if ((boolean) \mod_bigbluebuttonbn\locallib\config::get('userlimit_editable')) {
+    $bbbsession['userlimit'] = intval((int)\mod_bigbluebuttonbn\locallib\config::get('userlimit_default'));
+    if ((boolean)\mod_bigbluebuttonbn\locallib\config::get('userlimit_editable')) {
         $bbbsession['userlimit'] = intval($bbbsession['bigbluebuttonbn']->userlimit);
     }
     $bbbsession['voicebridge'] = $bbbsession['bigbluebuttonbn']->voicebridge;
@@ -3444,7 +3444,7 @@ 
         'bbb-recording-tags' => bigbluebuttonbn_get_tags($bbbsession['cm']->id), // Same as $id.
     ];
     // Special metadata for recording processing.
-    if ((boolean) \mod_bigbluebuttonbn\locallib\config::get('recordingstatus_enabled')) {
+    if ((boolean)\mod_bigbluebuttonbn\locallib\config::get('recordingstatus_enabled')) {
         $metadata["bn-recording-status"] = json_encode(
             array(
                 'email' => array('"' . fullname($USER) . '" <' . $USER->email . '>'),
@@ -3452,10 +3452,10 @@ 
             )
         );
     }
-    if ((boolean) \mod_bigbluebuttonbn\locallib\config::get('recordingready_enabled')) {
+    if ((boolean)\mod_bigbluebuttonbn\locallib\config::get('recordingready_enabled')) {
         $metadata['bn-recording-ready-url'] = $bbbsession['recordingReadyURL'];
     }
-    if ((boolean) \mod_bigbluebuttonbn\locallib\config::get('meetingevents_enabled')) {
+    if ((boolean)\mod_bigbluebuttonbn\locallib\config::get('meetingevents_enabled')) {
         $metadata['analytics-callback-url'] = $bbbsession['meetingEventsURL'];
     }
     return $metadata;

bbb_ajax.php

Spacing +7 added lines, -7 removed lines

@@ -23,9 +23,9 @@ 
  * @author    Jesus Federico  (jesus [at] blindsidenetworks [dt] com)
  */
 
-require(__DIR__.'/../../config.php');
-require_once(__DIR__.'/locallib.php');
-require_once(__DIR__.'/brokerlib.php');
+require(__DIR__ . '/../../config.php');
+require_once(__DIR__ . '/locallib.php');
+require_once(__DIR__ . '/brokerlib.php');
 
 global $PAGE, $USER, $CFG, $SESSION, $DB;
 
@@ -42,13 +42,13 @@ 
 require_sesskey();
 
 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;
 }
 
@@ -127,7 +127,7 @@ 
         echo $completionvalidate;
         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');
 } catch (Exception $e) {
-    header('HTTP/1.0 500 Internal Server Error. '.$e->getMessage());
+    header('HTTP/1.0 500 Internal Server Error. ' . $e->getMessage());
 }