blindsidenetworks / moodle-mod_bigbluebuttonbn

locallib.php

Doc Comments +14 added lines, -14 removed lines

@@ -292,7 +292,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
  *
@@ -320,7 +320,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(
@@ -402,7 +402,7 @@ 
  * @param object $a
  * @param object $b
  *
- * @return array
+ * @return integer
  */
 function bigbluebuttonbn_recording_build_sorter($a, $b) {
     if ($a['startTime'] < $b['startTime']) {
@@ -528,7 +528,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')) {
@@ -569,7 +569,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;
@@ -1037,7 +1037,7 @@ 
 /**
  * Helper returns an array with all possible bigbluebuttonbn events.
  *
- * @return array
+ * @return string[]
  */
 function bigbluebuttonbn_events() {
     return array(
@@ -1246,7 +1246,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?';
@@ -1295,7 +1295,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)) {
@@ -1799,7 +1799,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recording
- * @param object $rowdata
+ * @param stdClass $rowdata
  *
  * @return object
  */
@@ -1998,7 +1998,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
  *
@@ -2022,7 +2022,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
  *
@@ -2045,7 +2045,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
@@ -2063,7 +2063,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

index.php

Spacing +16 added lines, -16 removed lines

@@ -24,8 +24,8 @@ 
  * @author    Fred Dixon  (ffdixon [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');
 
 $id = required_param('id', PARAM_INT);
 $a = optional_param('a', 0, PARAM_INT);
@@ -89,13 +89,13 @@ 
     if ($moderator || $administrator) {
         bigbluebuttonbn_event_log(BIGBLUEBUTTON_EVENT_MEETING_ENDED, $bigbluebuttonbn, $cm);
         echo get_string('index_ending', 'bigbluebuttonbn');
-        $meetingid = $bigbluebuttonbn->meetingid.'-'.$course->id.'-'.$bigbluebuttonbn->id;
+        $meetingid = $bigbluebuttonbn->meetingid . '-' . $course->id . '-' . $bigbluebuttonbn->id;
         if ($g != '0') {
-            $meetingid .= '['.$g.']';
+            $meetingid .= '[' . $g . ']';
         }
 
         bigbluebuttonbn_end_meeting($meetingid, $bigbluebuttonbn->moderatorpass);
-        redirect('index.php?id='.$id);
+        redirect('index.php?id=' . $id);
     }
 }
 
@@ -110,7 +110,7 @@ 
         // Add a the data for the bigbluebuttonbn instance.
         $groupobj = null;
         if (groups_get_activity_groupmode($cm) > 0) {
-            $groupobj = (object) array('id' => 0, 'name' => get_string('allparticipants'));
+            $groupobj = (object)array('id' => 0, 'name' => get_string('allparticipants'));
         }
         $table->data[] = bigbluebuttonbn_index_display_room($canmoderate, $course, $bigbluebuttonbn, $groupobj);
         // Add a the data for the groups belonging to the bigbluebuttonbn instance, if any.
@@ -136,12 +136,12 @@ 
  * @return array
  */
 function bigbluebuttonbn_index_display_room($moderator, $course, $bigbluebuttonbn, $groupobj = null) {
-    $meetingid = $bigbluebuttonbn->meetingid.'-'.$course->id.'-'.$bigbluebuttonbn->id;
+    $meetingid = $bigbluebuttonbn->meetingid . '-' . $course->id . '-' . $bigbluebuttonbn->id;
     $paramgroup = '';
     $groupname = '';
     if ($groupobj) {
-        $meetingid .= '['.$groupobj->id.']';
-        $paramgroup = '&group='.$groupobj->id;
+        $meetingid .= '[' . $groupobj->id . ']';
+        $paramgroup = '&group=' . $groupobj->id;
         $groupname = $groupobj->name;
     }
     $meetinginfo = bigbluebuttonbn_get_meeting_info_array($meetingid);
@@ -156,7 +156,7 @@ 
         return;
     }
     // Output Users in the meeting.
-    $joinurl = '<a href="view.php?id='.$bigbluebuttonbn->coursemodule.$paramgroup.'">'.format_string($bigbluebuttonbn->name).'</a>';
+    $joinurl = '<a href="view.php?id=' . $bigbluebuttonbn->coursemodule . $paramgroup . '">' . format_string($bigbluebuttonbn->name) . '</a>';
     $group = $groupname;
     $users = '';
     $viewerlist = '';
@@ -201,7 +201,7 @@ 
         $attendeecount = 0;
         foreach ($meetinginfo['attendees']->attendee as $attendee) {
             if ($attendee->role == $role) {
-                $attendeelist .= ($attendeecount++ > 0 ? ', ' : '').$attendee->fullName;
+                $attendeelist .= ($attendeecount++ > 0 ? ', ' : '') . $attendee->fullName;
             }
         }
     }
@@ -235,17 +235,17 @@ 
 function bigbluebuttonbn_index_display_room_actions($moderator, $course, $bigbluebuttonbn, $groupobj = null) {
     $actions = '';
     if ($moderator) {
-        $actions .= '<form name="form1" method="post" action="">'."\n";
-        $actions .= '  <INPUT type="hidden" name="id" value="'.$course->id.'">'."\n";
-        $actions .= '  <INPUT type="hidden" name="a" value="'.$bigbluebuttonbn->id.'">'."\n";
+        $actions .= '<form name="form1" method="post" action="">' . "\n";
+        $actions .= '  <INPUT type="hidden" name="id" value="' . $course->id . '">' . "\n";
+        $actions .= '  <INPUT type="hidden" name="a" value="' . $bigbluebuttonbn->id . '">' . "\n";
         if ($groupobj != null) {
-            $actions .= '  <INPUT type="hidden" name="g" value="'.$groupobj->id.'">'."\n";
+            $actions .= '  <INPUT type="hidden" name="g" value="' . $groupobj->id . '">' . "\n";
         }
         $actions .= '  <INPUT type="submit" name="submit" value="' .
             get_string('view_conference_action_end', 'bigbluebuttonbn') .
             '" class="btn btn-primary btn-sm" onclick="return confirm(\'' .
             get_string('index_confirm_end', 'bigbluebuttonbn') . '\')">' . "\n";
-        $actions .= '</form>'."\n";
+        $actions .= '</form>' . "\n";
     }
     return $actions;
 }

classes/locallib/bigbluebutton.php

Spacing +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
             $params .= '&' . $key . '=' . urlencode($value);
         }
         foreach ($metadata as $key => $value) {
-            $params .= '&' . 'meta_' . $key.'=' . urlencode($value);
+            $params .= '&' . 'meta_' . $key . '=' . urlencode($value);
         }
         return $baseurl . $params . '&checksum=' . sha1($action . $params . self::sanitized_secret());
     }