blindsidenetworks / moodle-mod_bigbluebuttonbn

locallib.php

Doc Comments +15 added lines, -15 removed lines

@@ -276,7 +276,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
  *
@@ -304,7 +304,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(
@@ -386,7 +386,7 @@ 
  * @param object $a
  * @param object $b
  *
- * @return array
+ * @return integer
  */
 function bigbluebuttonbn_recording_build_sorter($a, $b) {
     if ($a['startTime'] < $b['startTime']) {
@@ -497,7 +497,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')) {
@@ -538,7 +538,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();
@@ -911,7 +911,7 @@ 
  * @param integer $instance
  * @param integer $voicebridge
  *
- * @return string
+ * @return boolean
  */
 function bigbluebuttonbn_voicebridge_unique($instance, $voicebridge) {
     global $DB;
@@ -1014,7 +1014,7 @@ 
 /**
  * Helper returns an array with all possible bigbluebuttonbn events.
  *
- * @return array
+ * @return string[]
  */
 function bigbluebuttonbn_events() {
     return array(
@@ -1120,7 +1120,7 @@ 
  * @param string $meetingid
  * @param boolean $updatecache
  *
- * @return array
+ * @return string
  */
 function bigbluebuttonbn_get_meeting_info($meetingid, $updatecache = false) {
     $cachettl = (int)\mod_bigbluebuttonbn\locallib\config::get('waitformoderator_cache_ttl');
@@ -1240,7 +1240,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?';
@@ -1289,7 +1289,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)) {
@@ -1853,7 +1853,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recording
- * @param object $rowdata
+ * @param stdClass $rowdata
  *
  * @return object
  */
@@ -2048,7 +2048,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
  *
@@ -2072,7 +2072,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
  *
@@ -2095,7 +2095,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
@@ -2113,7 +2113,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

Indentation +51 added lines, -51 removed lines

@@ -95,9 +95,9 @@ 
 function bigbluebuttonbn_get_join_url($meetingid, $username, $pw, $logouturl, $configtoken = null,
             $userid = null, $clienttype = BIGBLUEBUTTON_CLIENTTYPE_FLASH, $createtime = null) {
     $data = ['meetingID' => $meetingid,
-              'fullName' => $username,
-              'password' => $pw,
-              'logoutURL' => $logouturl,
+                'fullName' => $username,
+                'password' => $pw,
+                'logoutURL' => $logouturl,
             ];
     // Choose between Adobe Flash or HTML5 Client.
     if ( $clienttype == BIGBLUEBUTTON_CLIENTTYPE_HTML5 ) {
@@ -157,23 +157,23 @@ 
 function bigbluebuttonbn_get_meeting_info_array($meetingid) {
     $xml = bigbluebuttonbn_wrap_xml_load_file(
         \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('getMeetingInfo', ['meetingID' => $meetingid])
-      );
+        );
     if ($xml && $xml->returncode == 'SUCCESS' && empty($xml->messageKey)) {
         // Meeting info was returned.
         return array('returncode' => $xml->returncode,
-                     'meetingID' => $xml->meetingID,
-                     'moderatorPW' => $xml->moderatorPW,
-                     'attendeePW' => $xml->attendeePW,
-                     'hasBeenForciblyEnded' => $xml->hasBeenForciblyEnded,
-                     'running' => $xml->running,
-                     'recording' => $xml->recording,
-                     'startTime' => $xml->startTime,
-                     'endTime' => $xml->endTime,
-                     'participantCount' => $xml->participantCount,
-                     'moderatorCount' => $xml->moderatorCount,
-                     'attendees' => $xml->attendees,
-                     'metadata' => $xml->metadata,
-                   );
+                        'meetingID' => $xml->meetingID,
+                        'moderatorPW' => $xml->moderatorPW,
+                        'attendeePW' => $xml->attendeePW,
+                        'hasBeenForciblyEnded' => $xml->hasBeenForciblyEnded,
+                        'running' => $xml->running,
+                        'recording' => $xml->recording,
+                        'startTime' => $xml->startTime,
+                        'endTime' => $xml->endTime,
+                        'participantCount' => $xml->participantCount,
+                        'moderatorCount' => $xml->moderatorCount,
+                        'attendees' => $xml->attendees,
+                        'metadata' => $xml->metadata,
+                    );
     }
     if ($xml) {
         // Either failure or success without meeting info.
@@ -309,7 +309,7 @@ 
 function bigbluebuttonbn_get_default_config_xml() {
     $xml = bigbluebuttonbn_wrap_xml_load_file(
         \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('getDefaultConfigXML')
-      );
+        );
     return $xml;
 }
 
@@ -410,7 +410,7 @@ 
     foreach ($ids as $id) {
         $xml = bigbluebuttonbn_wrap_xml_load_file(
             \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('deleteRecordings', ['recordID' => $id])
-          );
+            );
         if ($xml && $xml->returncode != 'SUCCESS') {
             return false;
         }
@@ -429,7 +429,7 @@ 
     foreach ($ids as $id) {
         $xml = bigbluebuttonbn_wrap_xml_load_file(
             \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('publishRecordings', ['recordID' => $id, 'publish' => $publish])
-          );
+            );
         if ($xml && $xml->returncode != 'SUCCESS') {
             return false;
         }
@@ -448,7 +448,7 @@ 
     foreach ($ids as $id) {
         $xml = bigbluebuttonbn_wrap_xml_load_file(
             \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('updateRecordings', ['recordID' => $id] + (array) $params)
-          );
+            );
         if ($xml && $xml->returncode != 'SUCCESS') {
             return false;
         }
@@ -465,7 +465,7 @@ 
 function bigbluebuttonbn_end_meeting($meetingid, $modpw) {
     $xml = bigbluebuttonbn_wrap_xml_load_file(
         \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('end', ['meetingID' => $meetingid, 'password' => $modpw])
-      );
+        );
     if ($xml) {
         // If the xml packet returned failure it displays the message to the user.
         return array('returncode' => $xml->returncode, 'message' => $xml->message, 'messageKey' => $xml->messageKey);
@@ -482,7 +482,7 @@ 
 function bigbluebuttonbn_get_server_version() {
     $xml = bigbluebuttonbn_wrap_xml_load_file(
         \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url()
-      );
+        );
     if ($xml && $xml->returncode == 'SUCCESS') {
         return $xml->version;
     }
@@ -549,10 +549,10 @@ 
         }
         $options = array();
         $options['CURLOPT_HTTPHEADER'] = array(
-                 'Content-Type: '.$contenttype,
-                 'Content-Length: '.strlen($data),
-                 'Content-Language: en-US',
-               );
+                    'Content-Type: '.$contenttype,
+                    'Content-Length: '.strlen($data),
+                    'Content-Language: en-US',
+                );
 
         return $c->post($url, $data, $options);
     }
@@ -699,16 +699,16 @@ 
         'all' => array(
             'name' => get_string('mod_form_field_participant_list_type_all', 'bigbluebuttonbn'),
             'children' => []
-          )
-      );
+            )
+        );
     $data['role'] = array(
         'name' => get_string('mod_form_field_participant_list_type_role', 'bigbluebuttonbn'),
         'children' => bigbluebuttonbn_get_roles_select($context)
-      );
+        );
     $data['user'] = array(
         'name' => get_string('mod_form_field_participant_list_type_user', 'bigbluebuttonbn'),
         'children' => bigbluebuttonbn_get_users_select($context)
-      );
+        );
     return $data;
 }
 
@@ -751,7 +751,7 @@ 
         'selectiontype' => 'all',
         'selectionid' => 'all',
         'role' => BIGBLUEBUTTONBN_ROLE_VIEWER
-      );
+        );
     $defaultrules = explode(',', \mod_bigbluebuttonbn\locallib\config::get('participant_moderator_default'));
     foreach ($defaultrules as $defaultrule) {
         if ($defaultrule == '0') {
@@ -764,9 +764,9 @@ 
             continue;
         }
         $participantlist[] = array(
-              'selectiontype' => 'role',
-              'selectionid' => $defaultrule,
-              'role' => BIGBLUEBUTTONBN_ROLE_MODERATOR);
+                'selectiontype' => 'role',
+                'selectionid' => $defaultrule,
+                'role' => BIGBLUEBUTTONBN_ROLE_MODERATOR);
     }
     return $participantlist;
 }
@@ -805,11 +805,11 @@ 
             'all' => get_string('mod_form_field_participant_list_type_all', 'bigbluebuttonbn'),
             'role' => get_string('mod_form_field_participant_list_type_role', 'bigbluebuttonbn'),
             'user' => get_string('mod_form_field_participant_list_type_user', 'bigbluebuttonbn'),
-          ],
+            ],
         'type_selected' => 'all',
         'options' => ['all' => '---------------'],
         'selected' => 'all',
-      ];
+        ];
 }
 
 /**
@@ -1090,7 +1090,7 @@ 
         $eventproperties['other'] = $options['other'];
     }
     $event = call_user_func_array('\mod_bigbluebuttonbn\event\bigbluebuttonbn_'.$eventtype.'::create',
-      array($eventproperties));
+        array($eventproperties));
     $event->trigger();
 }
 
@@ -1134,7 +1134,7 @@ 
     // Ping again and refresh the cache.
     $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)));
     return $meetinginfo;
 }
@@ -1546,8 +1546,8 @@ 
     }
     $id = 'playbacks-'.$recording['recordID'];
     $recordingtypes = html_writer::start_tag('div', array('id' => $id, 'data-imported' => $dataimported,
-          'data-meetingid' => $recording['meetingID'], 'data-recordingid' => $recording['recordID'],
-          'title' => $title, $visibility => $visibility));
+            'data-meetingid' => $recording['meetingID'], 'data-recordingid' => $recording['recordID'],
+            'title' => $title, $visibility => $visibility));
     foreach ($recording['playbacks'] as $playback) {
         $recordingtypes .= bigbluebuttonbn_get_recording_data_row_type($recording, $bbbsession, $playback);
     }
@@ -1571,7 +1571,7 @@ 
     }
     $text = get_string('view_recording_format_'.$playback['type'], 'bigbluebuttonbn');
     $href = $CFG->wwwroot . '/mod/bigbluebuttonbn/bbb_view.php?action=play&bn=' . $bbbsession['bigbluebuttonbn']->id .
-      '&mid='.$recording['meetingID'] . '&rid=' . $recording['recordID'] . '&rtype=' . $playback['type'];
+        '&mid='.$recording['meetingID'] . '&rid=' . $recording['recordID'] . '&rtype=' . $playback['type'];
     if (!isset($recording['imported']) || !isset($recording['protected']) || $recording['protected'] === 'false') {
         $href .= '&href='.urlencode(trim($playback['url']));
     }
@@ -1582,7 +1582,7 @@ 
         'data-action' => 'play',
         'data-target' => $playback['type'],
         'data-href' => $href,
-      );
+        );
     if (!bigbluebuttonbn_is_bn_server() && !bigbluebuttonbn_is_valid_resource(trim($playback['url']))) {
         $linkattributes['class'] = 'btn btn-sm btn-warning';
         $linkattributes['title'] = get_string('view_recording_format_errror_unreachable', 'bigbluebuttonbn');
@@ -1732,10 +1732,10 @@ 
             'id' => $id,
             'onclick' => $onclick,
             'data-action' => $data['action']
-          );
+            );
         if (!isset($recording['imported'])) {
             $linkattributes['data-links'] = bigbluebuttonbn_count_recording_imported_instances(
-              $recording['recordID']);
+                $recording['recordID']);
         }
         if (isset($data['disabled'])) {
             $iconattributes['class'] .= ' fa-' . $data['disabled'];
@@ -2294,8 +2294,8 @@ 
     $activitytime = '';
     if ($time) {
         $activitytime = calendar_day_representation($time).' '.
-          get_string('mod_form_field_notification_msg_at', 'bigbluebuttonbn').' '.
-          calendar_time_representation($time);
+            get_string('mod_form_field_notification_msg_at', 'bigbluebuttonbn').' '.
+            calendar_time_representation($time);
     }
     return $activitytime;
 }
@@ -2391,7 +2391,7 @@ 
     global $BIGBLUEBUTTONBN_CFG;
     if (isset($BIGBLUEBUTTONBN_CFG)) {
         $renderer->render_warning_message('general_warning',
-             get_string('config_warning_bigbluebuttonbn_cfg_deprecated', 'bigbluebuttonbn'));
+                get_string('config_warning_bigbluebuttonbn_cfg_deprecated', 'bigbluebuttonbn'));
     }
 }
 
@@ -2599,7 +2599,7 @@ 
         $renderer->render_group_element('participant_moderator_default',
             $renderer->render_group_element_configmultiselect('participant_moderator_default',
                 array_keys($owner), array_merge($owner, $roles))
-          );
+            );
     }
 }
 
@@ -2637,7 +2637,7 @@ 
         $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'));
+                            BIGBLUEBUTTON_CLIENTTYPE_HTML5 => get_string('mod_form_block_clienttype_html5', 'bigbluebuttonbn'));
         $renderer->render_group_element('clienttype_default',
             $renderer->render_group_element_configselect('clienttype_default',
                 $default, $choices));
@@ -2730,7 +2730,7 @@ 
         return $output;
     }
     $output .= $OUTPUT->box_start('box boxalignleft adminerror alert alert-' . $type . ' alert-block fade in',
-      'bigbluebuttonbn_view_general_warning') . "\n";
+        'bigbluebuttonbn_view_general_warning') . "\n";
     $output .= '    ' . $message . "\n";
     $output .= '  <div class="singlebutton pull-right">' . "\n";
     if (!empty($href)) {