blindsidenetworks / moodle-mod_bigbluebuttonbn

locallib.php

Doc Comments +14 added lines, -16 removed lines

@@ -326,7 +326,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
  *
@@ -354,7 +354,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(
@@ -436,7 +436,7 @@ 
  * @param object $a
  * @param object $b
  *
- * @return array
+ * @return integer
  */
 function bigbluebuttonbn_recording_build_sorter($a, $b) {
     global $CFG;
@@ -550,7 +550,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')) {
@@ -591,7 +591,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') {
     global $CFG;
@@ -1008,7 +1008,7 @@ 
  * @param integer $instance
  * @param integer $voicebridge
  *
- * @return string
+ * @return boolean
  */
 function bigbluebuttonbn_voicebridge_unique($instance, $voicebridge) {
     global $DB;
@@ -1355,9 +1355,8 @@ 
  *
  * @param string $meetingid
  * @param string $configxml
- * @param string $server
  *
- * @return object
+ * @return null|SimpleXMLElement
  */
 function bigbluebuttonbn_set_config_xml($meetingid, $configxml) {
     $urldefaultconfig = \mod_bigbluebuttonbn\locallib\config::get('server_url') . 'api/setConfigXML?';
@@ -1376,7 +1375,6 @@ 
  *
  * @param string $meetingid
  * @param string $configxml
- * @param string $server
  *
  * @return string
  */
@@ -1412,7 +1410,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)) {
@@ -1996,7 +1994,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recording
- * @param object $rowdata
+ * @param stdClass $rowdata
  *
  * @return object
  */
@@ -2226,7 +2224,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recordings
- * @param array $tools
+ * @param string[] $tools
  *
  * @return array
  */
@@ -2307,7 +2305,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
  *
@@ -2331,7 +2329,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
  *
@@ -2354,7 +2352,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
@@ -2372,7 +2370,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

settings.php

Spacing +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
 
 global $CFG, $PAGE;
 
-require_once(__DIR__.'/locallib.php');
+require_once(__DIR__ . '/locallib.php');
 
 if ($hassiteconfig) {
     // Configuration for BigBlueButton.

mod_form.php

Spacing +22 added lines, -22 removed lines

@@ -26,8 +26,8 @@ 
 
 defined('MOODLE_INTERNAL') || die();
 
-require_once(dirname(__FILE__).'/locallib.php');
-require_once($CFG->dirroot.'/course/moodleform_mod.php');
+require_once(dirname(__FILE__) . '/locallib.php');
+require_once($CFG->dirroot . '/course/moodleform_mod.php');
 
 /**
  * Moodle class for mod_form.
@@ -51,7 +51,7 @@ 
         $serverversion = bigbluebuttonbn_get_server_version();
         if (is_null($serverversion)) {
             print_error('general_error_unable_connect', 'bigbluebuttonbn',
-                $CFG->wwwroot.'/admin/settings.php?section=modsettingbigbluebuttonbn');
+                $CFG->wwwroot . '/admin/settings.php?section=modsettingbigbluebuttonbn');
             return;
         }
         $bigbluebuttonbn = null;
@@ -81,7 +81,7 @@ 
             // If still none is allowed, fail and return.
             if (empty($jsvars['instanceTypeProfiles'])) {
                 print_error('general_error_not_allowed_to_create_instances)', 'bigbluebuttonbn',
-                    $CFG->wwwroot.'/admin/settings.php?section=modsettingbigbluebuttonbn');
+                    $CFG->wwwroot . '/admin/settings.php?section=modsettingbigbluebuttonbn');
                 return;
             }
         }
@@ -144,7 +144,7 @@ 
                 );
                 $defaultvalues['presentation'] = $draftitemid;
             } catch (Exception $e) {
-                debugging('Presentation could not be loaded: '.$e->getMessage(), DEBUG_DEVELOPER);
+                debugging('Presentation could not be loaded: ' . $e->getMessage(), DEBUG_DEVELOPER);
                 return;
             }
             // Completion: tick if completion attendance settings is set to 1 or more.
@@ -295,22 +295,22 @@ 
             }
         }
 
-        $connectedUsersBlock = '<div id="fitem_id_total_connected_users" class="form-group row fitem">'.
-            '<div class="col-md-3">'.
-            '<span class="float-sm-right text-nowrap">'.
-            '</span>'.
-            '<label class="col-form-label d-inline " for="id_total_connected_users">'.
-            'Connected Users'.
-            '</label>'.
-            '</div>'.
-            '<div class="col-md-9 form-inline felement" data-fieldtype="text">'.
-            '<input type="text" class="form-control text-center" name="total_connected_users" id="totalUsers" value="?" size="6" readonly="readonly">'.
-            '<div class="form-control-feedback invalid-feedback" id="id_error_total_connected_users">'.
-            '</div>'.
-            '<input type="checkbox" name="show_total_connected_users" class="form-check-input ml-2" id="chkShowTotalUsers" value="1" size="">'.
-
-            '</label>'.
-            '</div>'.
+        $connectedUsersBlock = '<div id="fitem_id_total_connected_users" class="form-group row fitem">' .
+            '<div class="col-md-3">' .
+            '<span class="float-sm-right text-nowrap">' .
+            '</span>' .
+            '<label class="col-form-label d-inline " for="id_total_connected_users">' .
+            'Connected Users' .
+            '</label>' .
+            '</div>' .
+            '<div class="col-md-9 form-inline felement" data-fieldtype="text">' .
+            '<input type="text" class="form-control text-center" name="total_connected_users" id="totalUsers" value="?" size="6" readonly="readonly">' .
+            '<div class="form-control-feedback invalid-feedback" id="id_error_total_connected_users">' .
+            '</div>' .
+            '<input type="checkbox" name="show_total_connected_users" class="form-check-input ml-2" id="chkShowTotalUsers" value="1" size="">' .
+
+            '</label>' .
+            '</div>' .
             '</div>';
         $mform->addElement('html', $connectedUsersBlock);
 
@@ -730,7 +730,7 @@ 
             return;
         }
         $mform->addElement($type, $name, get_string($descriptionkey, 'bigbluebuttonbn'), $options);
-        if (get_string_manager()->string_exists($descriptionkey.'_help', 'bigbluebuttonbn')) {
+        if (get_string_manager()->string_exists($descriptionkey . '_help', 'bigbluebuttonbn')) {
             $mform->addHelpButton($name, $descriptionkey, 'bigbluebuttonbn');
         }
         if (!empty($rule)) {