blindsidenetworks / moodle-mod_bigbluebuttonbn

locallib.php

Doc Comments +14 added lines, -14 removed lines

@@ -296,7 +296,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
  *
@@ -324,7 +324,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(
@@ -406,7 +406,7 @@ 
  * @param object $a
  * @param object $b
  *
- * @return array
+ * @return integer
  */
 function bigbluebuttonbn_recording_build_sorter($a, $b) {
     global $CFG;
@@ -520,7 +520,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')) {
@@ -561,7 +561,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();
@@ -934,7 +934,7 @@ 
  * @param integer $instance
  * @param integer $voicebridge
  *
- * @return string
+ * @return boolean
  */
 function bigbluebuttonbn_voicebridge_unique($instance, $voicebridge) {
     global $DB;
@@ -1257,7 +1257,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?';
@@ -1306,7 +1306,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)) {
@@ -1933,7 +1933,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recording
- * @param object $rowdata
+ * @param stdClass $rowdata
  *
  * @return object
  */
@@ -2051,7 +2051,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recordings
- * @param array $tools
+ * @param string[] $tools
  *
  * @return array
  */
@@ -2129,7 +2129,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
  *
@@ -2153,7 +2153,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
  *
@@ -2176,7 +2176,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
@@ -2194,7 +2194,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

lib.php

Spacing +42 added lines, -42 removed lines

@@ -28,23 +28,23 @@ 
 
 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');
 
 // 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');
     } 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');
     }
 }
 
@@ -52,8 +52,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');
 }
 
 /*
@@ -106,18 +106,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;
@@ -216,7 +216,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);
@@ -239,10 +239,10 @@ 
 function bigbluebuttonbn_user_outline($course, $user, $mod, $bigbluebuttonbn) {
     global $DB;
     $completed = $DB->count_records('bigbluebuttonbn_logs', array('courseid' => $course->id,
-        'bigbluebuttonbnid' => $bigbluebuttonbn->id, 'userid' => $user->id, 'log' => 'Join', ), '*');
+        'bigbluebuttonbnid' => $bigbluebuttonbn->id, 'userid' => $user->id, 'log' => 'Join',), '*');
     if ($completed > 0) {
-        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 '';
@@ -262,7 +262,7 @@ 
 function bigbluebuttonbn_user_complete($course, $user, $mod, $bigbluebuttonbn) {
     global $DB;
     $completed = $DB->count_records('bigbluebuttonbn_logs', array('courseid' => $course->id,
-        'bigbluebuttonbnid' => $bigbluebuttonbn->id, 'userid' => $user->id, 'log' => 'Join', ),
+        'bigbluebuttonbnid' => $bigbluebuttonbn->id, 'userid' => $user->id, 'log' => 'Join',),
         '*', IGNORE_MULTIPLE);
     return $completed > 0;
 }
@@ -423,7 +423,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.
@@ -491,16 +491,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;
 }
 
@@ -732,7 +732,7 @@ 
     if (count($files) == 1) {
         // Get the first (and only) file.
         $file = reset($files);
-        $filesrc = '/'.$file->get_filename();
+        $filesrc = '/' . $file->get_filename();
     }
     return $filesrc;
 }
@@ -801,7 +801,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()) {