blindsidenetworks / moodle-mod_bigbluebuttonbn

lib.php

Doc Comments +6 added lines, -6 removed lines

@@ -98,7 +98,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) {
@@ -183,7 +183,7 @@ 
  *
  * @param int $id Id of the module instance
  *
- * @return bool Success/Failure
+ * @return boolean|null Success/Failure
  */
 function bigbluebuttonbn_delete_instance($id) {
     global $DB;
@@ -210,7 +210,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;
@@ -231,7 +231,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, $mod, $bigbluebuttonbn)) {
@@ -251,7 +251,7 @@ 
  * @param object $mod
  * @param object $bigbluebuttonbn
  *
- * @return bool
+ * @return integer
  */
 function bigbluebuttonbn_user_complete($courseorid, $userorid, $mod, $bigbluebuttonbn) {
     global $DB;
@@ -624,7 +624,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 +5 added lines, -5 removed lines

@@ -61,7 +61,7 @@ 
  * Remove this block when restored
  */
 
- /** @var BIGBLUEBUTTONBN_DEFAULT_SERVER_URL string of default bigbluebutton server url */
+    /** @var BIGBLUEBUTTONBN_DEFAULT_SERVER_URL string of default bigbluebutton server url */
 const BIGBLUEBUTTONBN_DEFAULT_SERVER_URL = 'http://test-install.blindsidenetworks.com/bigbluebutton/';
 /** @var BIGBLUEBUTTONBN_DEFAULT_SHARED_SECRET string of default bigbluebutton server shared secret */
 const BIGBLUEBUTTONBN_DEFAULT_SHARED_SECRET = '8cd8ef52e8e101574e400365b55e11a6';
@@ -268,7 +268,7 @@ 
     $sql = "SELECT count(*) FROM {bigbluebuttonbn_logs} ";
     $sql .= "WHERE courseid = ? AND bigbluebuttonbnid = ? AND userid = ? AND (log = ? OR log = ?)";
     $result = $DB->get_record_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 (int)$result->count;
 }
 
@@ -356,12 +356,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;
 }
@@ -559,7 +559,7 @@ 
             $bigbluebuttonbn->coursemodule,
             'bigbluebuttonbn',
             $bigbluebuttonbn->id, $bigbluebuttonbn->completionexpected
-          );
+            );
     }
 }
 /**

Spacing +40 added lines, -40 removed lines

@@ -28,29 +28,29 @@ 
 
 global $CFG;
 
-require_once($CFG->dirroot.'/calendar/lib.php');
-require_once($CFG->dirroot.'/message/lib.php');
-require_once($CFG->dirroot.'/mod/lti/OAuth.php');
-require_once($CFG->dirroot.'/tag/lib.php');
-require_once($CFG->libdir.'/accesslib.php');
-require_once($CFG->libdir.'/completionlib.php');
-require_once($CFG->libdir.'/datalib.php');
-require_once($CFG->libdir.'/enrollib.php');
-require_once($CFG->libdir.'/filelib.php');
-require_once($CFG->libdir.'/formslib.php');
+require_once($CFG->dirroot . '/calendar/lib.php');
+require_once($CFG->dirroot . '/message/lib.php');
+require_once($CFG->dirroot . '/mod/lti/OAuth.php');
+require_once($CFG->dirroot . '/tag/lib.php');
+require_once($CFG->libdir . '/accesslib.php');
+require_once($CFG->libdir . '/completionlib.php');
+require_once($CFG->libdir . '/datalib.php');
+require_once($CFG->libdir . '/enrollib.php');
+require_once($CFG->libdir . '/filelib.php');
+require_once($CFG->libdir . '/formslib.php');
 
 
 if (!class_exists('\Firebase\JWT\JWT') &&
-    file_exists(dirname(__FILE__).'/vendor/firebase/php-jwt/src/JWT.php')) {
-    require_once(dirname(__FILE__).'/vendor/firebase/php-jwt/src/JWT.php');
+    file_exists(dirname(__FILE__) . '/vendor/firebase/php-jwt/src/JWT.php')) {
+    require_once(dirname(__FILE__) . '/vendor/firebase/php-jwt/src/JWT.php');
 }
 
 if (!isset($CFG->bigbluebuttonbn)) {
     $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');
 }
 
 /*
@@ -105,18 +105,18 @@ 
         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_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_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;
@@ -215,7 +215,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);
@@ -235,8 +235,8 @@ 
  */
 function bigbluebuttonbn_user_outline($course, $user, $mod, $bigbluebuttonbn) {
     if ($completed = bigbluebuttonbn_user_complete($course, $user, $mod, $bigbluebuttonbn)) {
-        return fullname($user).' '.get_string('view_message_has_joined', 'bigbluebuttonbn').' '.
-            get_string('view_message_session_for', 'bigbluebuttonbn').' '.(string) $completed.' '.
+        return fullname($user) . ' ' . get_string('view_message_has_joined', 'bigbluebuttonbn') . ' ' .
+            get_string('view_message_session_for', 'bigbluebuttonbn') . ' ' . (string)$completed . ' ' .
             get_string('view_message_times', 'bigbluebuttonbn');
     }
     return '';
@@ -353,16 +353,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;
 }
 
@@ -587,7 +587,7 @@ 
     if (count($files) == 1) {
         // Get the first (and only) file.
         $file = reset($files);
-        $filesrc = '/'.$file->get_filename();
+        $filesrc = '/' . $file->get_filename();
     }
     return $filesrc;
 }
@@ -656,7 +656,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()) {

bbb_view.php

Spacing +22 added lines, -22 removed lines

@@ -23,8 +23,8 @@ 
  * @author    Jesus Federico  (jesus [at] blindsidenetworks [dt] com)
  */
 
-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');
 
 global $SESSION;
 
@@ -70,23 +70,23 @@ 
     if (is_null($serverversion)) {
         if ($bbbsession['administrator']) {
             print_error('view_error_unable_join', 'bigbluebuttonbn',
-                $CFG->wwwroot.'/admin/settings.php?section=modsettingbigbluebuttonbn');
+                $CFG->wwwroot . '/admin/settings.php?section=modsettingbigbluebuttonbn');
             exit;
         }
         if ($bbbsession['moderator']) {
             print_error('view_error_unable_join_teacher', 'bigbluebuttonbn',
-                $CFG->wwwroot.'/course/view.php?id='.$bigbluebuttonbn->course);
+                $CFG->wwwroot . '/course/view.php?id=' . $bigbluebuttonbn->course);
             exit;
         }
         print_error('view_error_unable_join_student', 'bigbluebuttonbn',
-            $CFG->wwwroot.'/course/view.php?id='.$bigbluebuttonbn->course);
+            $CFG->wwwroot . '/course/view.php?id=' . $bigbluebuttonbn->course);
         exit;
     }
-    $bbbsession['serverversion'] = (string) $serverversion;
+    $bbbsession['serverversion'] = (string)$serverversion;
 
     // Operation URLs.
     $bbbsession['bigbluebuttonbnURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/view.php?id=' . $bbbsession['cm']->id;
-    $bbbsession['logoutURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_view.php?action=logout&id='.$id .
+    $bbbsession['logoutURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_view.php?action=logout&id=' . $id .
         '&bn=' . $bbbsession['bigbluebuttonbn']->id;
     $bbbsession['recordingReadyURL'] = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_broker.php?action=recording_' .
         'ready&bigbluebuttonbn=' . $bbbsession['bigbluebuttonbn']->id;
@@ -114,8 +114,8 @@ 
         }
 
         // Assign group default values.
-        $bbbsession['meetingid'] .= '['.$bbbsession['group'].']';
-        $bbbsession['meetingname'] .= ' ('.$groupname.')';
+        $bbbsession['meetingid'] .= '[' . $bbbsession['group'] . ']';
+        $bbbsession['meetingname'] .= ' (' . $groupname . ')';
     }
 
     // Initialize session variable used across views.
@@ -178,7 +178,7 @@ 
         }
         // If user is not administrator nor moderator (user is steudent) and waiting is required.
         if (!$bbbsession['administrator'] && !$bbbsession['moderator'] && $bbbsession['wait']) {
-            header('Location: '.$bbbsession['logoutURL']);
+            header('Location: ' . $bbbsession['logoutURL']);
             break;
         }
         // As the meeting doesn't exist, try to create it.
@@ -192,16 +192,16 @@ 
             // The server is unreachable.
             if ($bbbsession['administrator']) {
                 print_error('view_error_unable_join', 'bigbluebuttonbn',
-                    $CFG->wwwroot.'/admin/settings.php?section=modsettingbigbluebuttonbn');
+                    $CFG->wwwroot . '/admin/settings.php?section=modsettingbigbluebuttonbn');
                 break;
             }
             if ($bbbsession['moderator']) {
                 print_error('view_error_unable_join_teacher', 'bigbluebuttonbn',
-                    $CFG->wwwroot.'/admin/settings.php?section=modsettingbigbluebuttonbn');
+                    $CFG->wwwroot . '/admin/settings.php?section=modsettingbigbluebuttonbn');
                 break;
             }
             print_error('view_error_unable_join_student', 'bigbluebuttonbn',
-                $CFG->wwwroot.'/admin/settings.php?section=modsettingbigbluebuttonbn');
+                $CFG->wwwroot . '/admin/settings.php?section=modsettingbigbluebuttonbn');
             break;
         }
         if ($response['returncode'] == 'FAILED') {
@@ -222,7 +222,7 @@ 
         bigbluebuttonbn_event_log(\mod_bigbluebuttonbn\event\events::$events['meeting_create'], $bigbluebuttonbn);
         // Internal logger: Insert a record with the meeting created.
         $overrides = array('meetingid' => $bbbsession['meetingid']);
-        $meta = '{"record":'.($bbbsession['record'] ? 'true' : 'false').'}';
+        $meta = '{"record":' . ($bbbsession['record'] ? 'true' : 'false') . '}';
         bigbluebuttonbn_log($bbbsession['bigbluebuttonbn'], BIGBLUEBUTTONBN_LOG_EVENT_CREATE, $overrides, $meta);
         // Since the meeting is already running, we just join the session.
         bigbluebutton_bbb_view_join_meeting($bbbsession, $bigbluebuttonbn, $origin);
@@ -236,7 +236,7 @@ 
         $overrides = array('meetingid' => $bbbsession['meetingid']);
         bigbluebuttonbn_log($bbbsession['bigbluebuttonbn'], BIGBLUEBUTTONBN_LOG_EVENT_PLAYED, $overrides);
         // Execute the redirect.
-        header('Location: '.urldecode($href));
+        header('Location: ' . urldecode($href));
         break;
     default:
         bigbluebutton_bbb_view_close_window();
@@ -330,7 +330,7 @@ 
         $data['welcome'] .= '<br><br>';
         $data['welcome'] .= str_replace(
             '%duration%',
-            (string) $durationtime,
+            (string)$durationtime,
             get_string('bbbdurationwarning', 'bigbluebuttonbn')
           );
     }
@@ -420,7 +420,7 @@ 
     $meetinginfo = bigbluebuttonbn_get_meeting_info($bbbsession['meetingid'], BIGBLUEBUTTONBN_UPDATE_CACHE);
     if ($bbbsession['userlimit'] > 0 && intval($meetinginfo['participantCount']) >= $bbbsession['userlimit']) {
         // No more users allowed to join.
-        header('Location: '.$bbbsession['logoutURL']);
+        header('Location: ' . $bbbsession['logoutURL']);
         return;
     }
     // Build the URL.
@@ -434,13 +434,13 @@ 
     bigbluebuttonbn_event_log(\mod_bigbluebuttonbn\event\events::$events['meeting_join'], $bigbluebuttonbn);
     // Internal logger: Instert a record with the meeting created.
     $overrides = array('meetingid' => $bbbsession['meetingid']);
-    $meta = '{"origin":'.$origin.'}';
+    $meta = '{"origin":' . $origin . '}';
     bigbluebuttonbn_log($bbbsession['bigbluebuttonbn'], BIGBLUEBUTTONBN_LOG_EVENT_JOIN, $overrides, $meta);
     // Before executing the redirect, increment the number of participants.
     bigbluebuttonbn_participant_joined($bbbsession['meetingid'],
         ($bbbsession['administrator'] || $bbbsession['moderator']));
     // Execute the redirect.
-    header('Location: '.$joinurl);
+    header('Location: ' . $joinurl);
 }
 
 /**
@@ -452,13 +452,13 @@ 
  */
 function bigbluebutton_bbb_view_errors($serrors, $id) {
     global $CFG, $OUTPUT;
-    $errors = (array) json_decode(urldecode($serrors));
+    $errors = (array)json_decode(urldecode($serrors));
     $msgerrors = '';
     foreach ($errors as $error) {
-        $msgerrors .= html_writer::tag('p', $error->{'message'}, array('class' => 'alert alert-danger'))."\n";
+        $msgerrors .= html_writer::tag('p', $error->{'message'}, array('class' => 'alert alert-danger')) . "\n";
     }
     echo $OUTPUT->header();
     print_error('view_error_bigbluebutton', 'bigbluebuttonbn',
-        $CFG->wwwroot.'/mod/bigbluebuttonbn/view.php?id='.$id, $msgerrors, $serrors);
+        $CFG->wwwroot . '/mod/bigbluebuttonbn/view.php?id=' . $id, $msgerrors, $serrors);
     echo $OUTPUT->footer();
 }