blindsidenetworks / moodle-mod_bigbluebuttonbn

locallib.php

Doc Comments +14 added lines, -14 removed lines

@@ -312,7 +312,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
  *
@@ -341,7 +341,7 @@ 
 /**
  * Helper function to retrive the default config.xml file.
  *
- * @return string
+ * @return null|SimpleXMLElement
  */
 function bigbluebuttonbn_get_default_config_xml()
 {
@@ -427,7 +427,7 @@ 
  * @param object $a
  * @param object $b
  *
- * @return array
+ * @return integer
  */
 function bigbluebuttonbn_recording_build_sorter($a, $b)
 {
@@ -547,7 +547,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')
 {
@@ -589,7 +589,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')
 {
@@ -980,7 +980,7 @@ 
  * @param integer $instance
  * @param integer $voicebridge
  *
- * @return string
+ * @return boolean
  */
 function bigbluebuttonbn_voicebridge_unique($instance, $voicebridge)
 {
@@ -1342,7 +1342,7 @@ 
  * @param string $meetingid
  * @param string $configxml
  *
- * @return object
+ * @return null|SimpleXMLElement
  */
 function bigbluebuttonbn_set_config_xml($meetingid, $configxml)
 {
@@ -1398,7 +1398,7 @@ 
  * @param array $recording
  * @param array $tools
  *
- * @return array
+ * @return null|stdClass
  */
 function bigbluebuttonbn_get_recording_data_row($bbbsession, $recording, $tools = ['protect', 'publish', 'delete'])
 {
@@ -2045,7 +2045,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recording
- * @param object $rowdata
+ * @param stdClass $rowdata
  *
  * @return object
  */
@@ -2240,7 +2240,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recordings
- * @param array $tools
+ * @param string[] $tools
  *
  * @return array
  */
@@ -2321,7 +2321,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
  *
@@ -2345,7 +2345,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
  *
@@ -2368,7 +2368,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
@@ -2386,7 +2386,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 +58 added lines, -58 removed lines

@@ -111,9 +111,9 @@ 
     $clienttype = BIGBLUEBUTTON_CLIENTTYPE_FLASH
 ) {
     $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) {
@@ -171,23 +171,23 @@ 
 {
     $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.
@@ -347,7 +347,7 @@ 
 {
     $xml = bigbluebuttonbn_wrap_xml_load_file(
         \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('getDefaultConfigXML')
-      );
+        );
     return $xml;
 }
 
@@ -456,7 +456,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;
         }
@@ -476,7 +476,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;
         }
@@ -496,7 +496,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;
         }
@@ -514,7 +514,7 @@ 
 {
     $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);
@@ -532,7 +532,7 @@ 
 {
     $xml = bigbluebuttonbn_wrap_xml_load_file(
         \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url()
-      );
+        );
     if ($xml && $xml->returncode == 'SUCCESS') {
         return $xml->version;
     }
@@ -601,10 +601,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);
     }
@@ -760,16 +760,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;
 }
 
@@ -814,7 +814,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') {
@@ -827,9 +827,9 @@ 
             continue;
         }
         $participantlist[] = array(
-              'selectiontype' => 'role',
-              'selectionid' => $defaultrule,
-              'role' => BIGBLUEBUTTONBN_ROLE_MODERATOR);
+                'selectiontype' => 'role',
+                'selectionid' => $defaultrule,
+                'role' => BIGBLUEBUTTONBN_ROLE_MODERATOR);
     }
     return $participantlist;
 }
@@ -870,11 +870,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',
-      ];
+        ];
 }
 
 /**
@@ -1231,7 +1231,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;
 }
@@ -1674,8 +1674,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);
     }
@@ -1699,7 +1699,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']));
     }
@@ -1710,7 +1710,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');
@@ -1875,7 +1875,7 @@ 
             'id' => $id,
             'onclick' => $onclick,
             'data-action' => $data['action']
-          );
+            );
         if (!isset($recording['imported'])) {
             $linkattributes['data-links'] = bigbluebuttonbn_count_recording_imported_instances(
                 $recording['recordID']
@@ -2509,17 +2509,17 @@ 
 function bigbluebuttonbn_get_instance_type_profiles() {
     $instanceprofiles = array(
         BIGBLUEBUTTONBN_TYPE_ALL => array('id' => BIGBLUEBUTTONBN_TYPE_ALL,
-                  'name' => get_string('instance_type_default', 'bigbluebuttonbn'),
-                  'features' => array('all')),
+                    'name' => get_string('instance_type_default', 'bigbluebuttonbn'),
+                    'features' => array('all')),
         BIGBLUEBUTTONBN_TYPE_ROOM_ONLY => array('id' => BIGBLUEBUTTONBN_TYPE_ROOM_ONLY,
-                  'name' => get_string('instance_type_room_only', 'bigbluebuttonbn'),
-                  'features' => array('showroom', 'welcomemessage', 'voicebridge', 'waitformoderator', 'userlimit',
-                      'recording', 'sendnotifications', 'preuploadpresentation', 'permissions', 'schedule', 'groups',
-                      'modstandardelshdr', 'availabilityconditionsheader', 'tagshdr', 'competenciessection',
-                      'clienttype', 'completionattendance', 'completionengagement')),
+                    'name' => get_string('instance_type_room_only', 'bigbluebuttonbn'),
+                    'features' => array('showroom', 'welcomemessage', 'voicebridge', 'waitformoderator', 'userlimit',
+                        'recording', 'sendnotifications', 'preuploadpresentation', 'permissions', 'schedule', 'groups',
+                        'modstandardelshdr', 'availabilityconditionsheader', 'tagshdr', 'competenciessection',
+                        'clienttype', 'completionattendance', 'completionengagement')),
         BIGBLUEBUTTONBN_TYPE_RECORDING_ONLY => array('id' => BIGBLUEBUTTONBN_TYPE_RECORDING_ONLY,
-                  'name' => get_string('instance_type_recording_only', 'bigbluebuttonbn'),
-                  'features' => array('showrecordings', 'importrecordings'))
+                    'name' => get_string('instance_type_recording_only', 'bigbluebuttonbn'),
+                    'features' => array('showrecordings', 'importrecordings'))
     );
     return $instanceprofiles;
 }
@@ -2606,8 +2606,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;
 }
@@ -2992,7 +2992,7 @@ 
                 array_keys($owner),
                 array_merge($owner, $roles)
             )
-          );
+            );
     }
 }
 
@@ -3032,7 +3032,7 @@ 
         // Web Client default.
         $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(
@@ -3519,8 +3519,8 @@ 
             array(
                 'email' => array('"' . fullname($USER) . '" <' . $USER->email . '>'),
                 'context' => $bbbsession['bigbluebuttonbnURL']
-              )
-          );
+                )
+            );
     }
     if ((boolean)\mod_bigbluebuttonbn\locallib\config::get('recordingready_enabled')) {
         $metadata['bn-recording-ready-url'] = $bbbsession['recordingReadyURL'];

Spacing +58 added lines, -58 removed lines

@@ -31,7 +31,7 @@ 
 
 global $CFG;
 
-require_once(__DIR__.'/lib.php');
+require_once(__DIR__ . '/lib.php');
 
 /** @var BIGBLUEBUTTONBN_UPDATE_CACHE boolean set to true indicates that cache has to be updated */
 const BIGBLUEBUTTONBN_UPDATE_CACHE = true;
@@ -145,8 +145,8 @@ 
     $data = null;
     if (!is_null($pname) && !is_null($purl)) {
         $method = 'POST';
-        $data = "<?xml version='1.0' encoding='UTF-8'?><modules><module name='presentation'><document url='".
-            $purl."' /></module></modules>";
+        $data = "<?xml version='1.0' encoding='UTF-8'?><modules><module name='presentation'><document url='" .
+            $purl . "' /></module></modules>";
     }
     $xml = bigbluebuttonbn_wrap_xml_load_file($createmeetingurl, $method, $data);
     if ($xml) {
@@ -273,7 +273,7 @@ 
                 foreach ($recordingxml->breakoutRooms->breakoutRoom as $breakoutroom) {
                     $url = \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url(
                         'getRecordings',
-                        ['recordID' => implode(',', (array) $breakoutroom)]
+                        ['recordID' => implode(',', (array)$breakoutroom)]
                     );
                     $xml = bigbluebuttonbn_wrap_xml_load_file($url);
                     if ($xml && $xml->returncode == 'SUCCESS' && isset($xml->recordings)) {
@@ -331,7 +331,7 @@ 
         // Override imported flag with actual ID.
         $recording['imported'] = $recordimported->id;
         if (isset($recordimported->protected)) {
-            $recording['protected'] = (string) $recordimported->protected;
+            $recording['protected'] = (string)$recordimported->protected;
         }
         $recordsimportedarray[$recording['recordID']] = $recording;
     }
@@ -363,21 +363,21 @@ 
     // Add formats.
     $playbackarray = array();
     foreach ($recording->playback->format as $format) {
-        $playbackarray[(string) $format->type] = array('type' => (string) $format->type,
-            'url' => trim((string) $format->url), 'length' => (string) $format->length);
+        $playbackarray[(string)$format->type] = array('type' => (string)$format->type,
+            'url' => trim((string)$format->url), 'length' => (string)$format->length);
         // Add preview per format when existing.
         if ($format->preview) {
-            $playbackarray[(string) $format->type]['preview'] = bigbluebuttonbn_get_recording_preview_images($format->preview);
+            $playbackarray[(string)$format->type]['preview'] = bigbluebuttonbn_get_recording_preview_images($format->preview);
         }
     }
     // Add the metadata to the recordings array.
     $metadataarray = bigbluebuttonbn_get_recording_array_meta(get_object_vars($recording->metadata));
-    $recordingarray = array('recordID' => (string) $recording->recordID,
-        'meetingID' => (string) $recording->meetingID, 'meetingName' => (string) $recording->name,
-        'published' => (string) $recording->published, 'startTime' => (string) $recording->startTime,
-        'endTime' => (string) $recording->endTime, 'playbacks' => $playbackarray);
+    $recordingarray = array('recordID' => (string)$recording->recordID,
+        'meetingID' => (string)$recording->meetingID, 'meetingName' => (string)$recording->name,
+        'published' => (string)$recording->published, 'startTime' => (string)$recording->startTime,
+        'endTime' => (string)$recording->endTime, 'playbacks' => $playbackarray);
     if (isset($recording->protected)) {
-        $recordingarray['protected'] = (string) $recording->protected;
+        $recordingarray['protected'] = (string)$recording->protected;
     }
     return $recordingarray + $metadataarray;
 }
@@ -393,9 +393,9 @@ 
 {
     $imagesarray = array();
     foreach ($preview->images->image as $image) {
-        $imagearray = array('url' => trim((string) $image));
+        $imagearray = array('url' => trim((string)$image));
         foreach ($image->attributes() as $attkey => $attvalue) {
-            $imagearray[$attkey] = (string) $attvalue;
+            $imagearray[$attkey] = (string)$attvalue;
         }
         array_push($imagesarray, $imagearray);
     }
@@ -416,7 +416,7 @@ 
         if (is_object($value)) {
             $value = '';
         }
-        $metadataarray['meta_'.$key] = $value;
+        $metadataarray['meta_' . $key] = $value;
     }
     return $metadataarray;
 }
@@ -495,7 +495,7 @@ 
     $ids = explode(',', $recordids);
     foreach ($ids as $id) {
         $xml = bigbluebuttonbn_wrap_xml_load_file(
-            \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('updateRecordings', ['recordID' => $id] + (array) $params)
+            \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('updateRecordings', ['recordID' => $id] + (array)$params)
           );
         if ($xml && $xml->returncode != 'SUCCESS') {
             return false;
@@ -563,7 +563,7 @@ 
             return $xml;
         } catch (Exception $e) {
             libxml_use_internal_errors($previous);
-            $error = 'Caught exception: '.$e->getMessage();
+            $error = 'Caught exception: ' . $e->getMessage();
             debugging($error, DEBUG_DEVELOPER);
             return null;
         }
@@ -574,7 +574,7 @@ 
         $response = simplexml_load_file($url, 'SimpleXMLElement', LIBXML_NOCDATA | LIBXML_NOBLANKS);
         return $response;
     } catch (Exception $e) {
-        $error = 'Caught exception: '.$e->getMessage();
+        $error = 'Caught exception: ' . $e->getMessage();
         debugging($error, DEBUG_DEVELOPER);
         libxml_use_internal_errors($previous);
         return null;
@@ -601,8 +601,8 @@ 
         }
         $options = array();
         $options['CURLOPT_HTTPHEADER'] = array(
-                 'Content-Type: '.$contenttype,
-                 'Content-Length: '.strlen($data),
+                 'Content-Type: ' . $contenttype,
+                 'Content-Length: ' . strlen($data),
                  'Content-Language: en-US',
                );
 
@@ -624,7 +624,7 @@ 
  */
 function bigbluebuttonbn_end_meeting_if_running($bigbluebuttonbn)
 {
-    $meetingid = $bigbluebuttonbn->meetingid.'-'.$bigbluebuttonbn->course.'-'.$bigbluebuttonbn->id;
+    $meetingid = $bigbluebuttonbn->meetingid . '-' . $bigbluebuttonbn->course . '-' . $bigbluebuttonbn->id;
     if (bigbluebuttonbn_is_meeting_running($meetingid)) {
         bigbluebuttonbn_end_meeting($meetingid, $bigbluebuttonbn->moderatorpass);
     }
@@ -645,9 +645,9 @@ 
     if ($userroles) {
         $where = '';
         foreach ($userroles as $userrole) {
-            $where .= (empty($where) ? ' WHERE' : ' OR').' id=' . $userrole->roleid;
+            $where .= (empty($where) ? ' WHERE' : ' OR') . ' id=' . $userrole->roleid;
         }
-        $userroles = $DB->get_records_sql('SELECT * FROM {role}'.$where);
+        $userroles = $DB->get_records_sql('SELECT * FROM {role}' . $where);
     }
     return $userroles;
 }
@@ -672,7 +672,7 @@ 
  */
 function bigbluebuttonbn_get_users(context $context = null)
 {
-    $users = (array) get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
+    $users = (array)get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
     foreach ($users as $key => $value) {
         $users[$key] = fullname($value);
     }
@@ -688,7 +688,7 @@ 
  */
 function bigbluebuttonbn_get_users_select(context $context = null)
 {
-    $users = (array) get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
+    $users = (array)get_enrolled_users($context, '', 0, 'u.*', null, 0, 0, true);
     foreach ($users as $key => $value) {
         $users[$key] = array('id' => $value->id, 'name' => fullname($value));
     }
@@ -704,7 +704,7 @@ 
  */
 function bigbluebuttonbn_get_roles(context $context = null)
 {
-    $roles = (array) role_get_names($context);
+    $roles = (array)role_get_names($context);
     foreach ($roles as $key => $value) {
         $roles[$key] = $value->localname;
     }
@@ -720,7 +720,7 @@ 
  */
 function bigbluebuttonbn_get_roles_select(context $context = null)
 {
-    $roles = (array) role_get_names($context);
+    $roles = (array)role_get_names($context);
     foreach ($roles as $key => $value) {
         $roles[$key] = array('id' => $value->id, 'name' => $value->localname);
     }
@@ -736,7 +736,7 @@ 
  */
 function bigbluebuttonbn_get_role($id)
 {
-    $roles = (array) role_get_names();
+    $roles = (array)role_get_names();
     if (is_numeric($id) && isset($roles[$id])) {
         return (object)$roles[$id];
     }
@@ -1130,7 +1130,7 @@ 
 {
     $mt = microtime();
     $rand = mt_rand();
-    return md5($mt.$rand);
+    return md5($mt . $rand);
 }
 
 /**
@@ -1226,10 +1226,10 @@ 
     $now = time();
     if (!$updatecache && isset($result) && $now < ($result['creation_time'] + $cachettl)) {
         // Use the value in the cache.
-        return (array) json_decode($result['meeting_info']);
+        return (array)json_decode($result['meeting_info']);
     }
     // Ping again and refresh the cache.
-    $meetinginfo = (array) bigbluebuttonbn_wrap_xml_load_file(
+    $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)));
@@ -1346,7 +1346,7 @@ 
  */
 function bigbluebuttonbn_set_config_xml($meetingid, $configxml)
 {
-    $urldefaultconfig = \mod_bigbluebuttonbn\locallib\config::get('server_url').'api/setConfigXML?';
+    $urldefaultconfig = \mod_bigbluebuttonbn\locallib\config::get('server_url') . 'api/setConfigXML?';
     $configxmlparams = bigbluebuttonbn_set_config_xml_params($meetingid, $configxml);
     $xml = bigbluebuttonbn_wrap_xml_load_file(
         $urldefaultconfig,
@@ -1367,8 +1367,8 @@ 
  */
 function bigbluebuttonbn_set_config_xml_params($meetingid, $configxml)
 {
-    $params = 'configXML='.urlencode($configxml).'&meetingID='.urlencode($meetingid);
-    $configxmlparams = $params.'&checksum='.sha1('setConfigXML'.$params.\mod_bigbluebuttonbn\locallib\config::get('shared_secret'));
+    $params = 'configXML=' . urlencode($configxml) . '&meetingID=' . urlencode($meetingid);
+    $configxmlparams = $params . '&checksum=' . sha1('setConfigXML' . $params . \mod_bigbluebuttonbn\locallib\config::get('shared_secret'));
     return $configxmlparams;
 }
 
@@ -1383,7 +1383,7 @@ 
 function bigbluebuttonbn_set_config_xml_array($meetingid, $configxml)
 {
     $configxml = bigbluebuttonbn_setConfigXML($meetingid, $configxml);
-    $configxmlarray = (array) $configxml;
+    $configxmlarray = (array)$configxml;
     if ($configxmlarray['returncode'] != 'SUCCESS') {
         debugging('BigBlueButton was not able to set the custom config.xml file', DEBUG_DEVELOPER);
         return '';
@@ -1482,7 +1482,7 @@ 
     global $USER;
     $starttime = $starttime - ($starttime % 1000);
     // Set formatted date.
-    $dateformat = get_string('strftimerecentfull', 'langconfig').' %Z';
+    $dateformat = get_string('strftimerecentfull', 'langconfig') . ' %Z';
     return userdate($starttime / 1000, $dateformat, usertimezone($USER->timezone));
 }
 
@@ -1604,7 +1604,7 @@ 
  */
 function bigbluebuttonbn_get_recording_data_row_preview($recording)
 {
-    $options = array('id' => 'preview-'.$recording['recordID']);
+    $options = array('id' => 'preview-' . $recording['recordID']);
     if ($recording['published'] === 'false') {
         $options['hidden'] = 'hidden';
     }
@@ -1672,7 +1672,7 @@ 
     if ($recording['published'] === 'false') {
         $visibility = 'hidden ';
     }
-    $id = 'playbacks-'.$recording['recordID'];
+    $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));
@@ -1697,11 +1697,11 @@ 
     if (!bigbluebuttonbn_include_recording_data_row_type($recording, $bbbsession, $playback)) {
         return '';
     }
-    $text = get_string('view_recording_format_'.$playback['type'], 'bigbluebuttonbn');
+    $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']));
+        $href .= '&href=' . urlencode(trim($playback['url']));
     }
     $linkattributes = array(
         'id' => 'recording-play-' . $playback['type'] . '-' . $recording['recordID'],
@@ -1887,7 +1887,7 @@ 
             unset($linkattributes['onclick']);
         }
         $icon = new pix_icon(
-            'i/'.$data['tag'],
+            'i/' . $data['tag'],
             get_string('view_recording_list_actionbar_' . $data['action'], 'bigbluebuttonbn'),
             'moodle',
             $iconattributes
@@ -2051,7 +2051,7 @@ 
  */
 function bigbluebuttonbn_get_recording_table_row($bbbsession, $recording, $rowdata) {
     $row = new html_table_row();
-    $row->id = 'recording-tr-'.$recording['recordID'];
+    $row->id = 'recording-tr-' . $recording['recordID'];
     $row->attributes['data-imported'] = 'false';
     $texthead = '';
     $texttail = '';
@@ -2421,7 +2421,7 @@ 
     }
     // Prepare select for loading records based on existent bigbluebuttonbns.
     $sql = 'SELECT DISTINCT meetingid, bigbluebuttonbnid FROM {bigbluebuttonbn_logs} WHERE ';
-    $sql .= '(bigbluebuttonbnid='.implode(' OR bigbluebuttonbnid=', array_keys($bigbluebuttonbns)).')';
+    $sql .= '(bigbluebuttonbnid=' . implode(' OR bigbluebuttonbnid=', array_keys($bigbluebuttonbns)) . ')';
     // Include only Create events and exclude those with record not true.
     $sql .= ' AND log = ? AND meta LIKE ? AND meta LIKE ?';
     // Execute select for loading records based on existent bigbluebuttonbns.
@@ -2605,8 +2605,8 @@ 
 function bigbluebuttonbn_format_activity_time($time) {
     $activitytime = '';
     if ($time) {
-        $activitytime = calendar_day_representation($time).' '.
-          get_string('mod_form_field_notification_msg_at', 'bigbluebuttonbn').' '.
+        $activitytime = calendar_day_representation($time) . ' ' .
+          get_string('mod_form_field_notification_msg_at', 'bigbluebuttonbn') . ' ' .
           calendar_time_representation($time);
     }
     return $activitytime;
@@ -3148,7 +3148,7 @@ 
  *
  * @return string
  */
-function bigbluebuttonbn_render_warning($message, $type='info', $href='', $text='', $class='') {
+function bigbluebuttonbn_render_warning($message, $type = 'info', $href = '', $text = '', $class = '') {
     global $OUTPUT;
     $output = "\n";
     // Evaluates if config_warning is enabled.
@@ -3189,11 +3189,11 @@ 
     if ($class == '') {
         $class = 'btn btn-secondary';
     }
-    $output  = '  <form method="post" action="' . $href . '" class="form-inline">'."\n";
-    $output .= '      <button type="submit" class="' . $class . '"'."\n";
-    $output .= '          title="' . $title . '"'."\n";
-    $output .= '          >' . $text . '</button>'."\n";
-    $output .= '  </form>'."\n";
+    $output  = '  <form method="post" action="' . $href . '" class="form-inline">' . "\n";
+    $output .= '      <button type="submit" class="' . $class . '"' . "\n";
+    $output .= '          title="' . $title . '"' . "\n";
+    $output .= '          >' . $text . '</button>' . "\n";
+    $output .= '  </form>' . "\n";
     return $output;
 }
 
@@ -3358,7 +3358,7 @@ 
     $bbbsession['modPW'] = $bbbsession['bigbluebuttonbn']->moderatorpass;
     $bbbsession['viewerPW'] = $bbbsession['bigbluebuttonbn']->viewerpass;
     // Database info related to the activity.
-    $bbbsession['meetingid'] = $bbbsession['bigbluebuttonbn']->meetingid.'-'.$bbbsession['course']->id.'-'.
+    $bbbsession['meetingid'] = $bbbsession['bigbluebuttonbn']->meetingid . '-' . $bbbsession['course']->id . '-' .
         $bbbsession['bigbluebuttonbn']->id;
     $bbbsession['meetingname'] = $bbbsession['bigbluebuttonbn']->name;
     $bbbsession['meetingdescription'] = $bbbsession['bigbluebuttonbn']->intro;
@@ -3390,12 +3390,12 @@ 
     if ($bbbsession['bigbluebuttonbn']->record) {
         // Check if is enable record all from start.
         if ($bbbsession['recordallfromstart']) {
-            $bbbsession['welcome'] .= '<br><br>'.get_string(
+            $bbbsession['welcome'] .= '<br><br>' . get_string(
                 'bbbrecordallfromstartwarning',
                 'bigbluebuttonbn'
             );
         } else {
-            $bbbsession['welcome'] .= '<br><br>'.get_string('bbbrecordwarning', 'bigbluebuttonbn');
+            $bbbsession['welcome'] .= '<br><br>' . get_string('bbbrecordwarning', 'bigbluebuttonbn');
         }
     }
     $bbbsession['openingtime'] = $bbbsession['bigbluebuttonbn']->openingtime;
@@ -3410,7 +3410,7 @@ 
     $bbbsession['originServerName'] = $parsedurl['host'];
     $bbbsession['originServerUrl'] = $CFG->wwwroot;
     $bbbsession['originServerCommonName'] = '';
-    $bbbsession['originTag'] = 'moodle-mod_bigbluebuttonbn ('.get_config('mod_bigbluebuttonbn', 'version').')';
+    $bbbsession['originTag'] = 'moodle-mod_bigbluebuttonbn (' . get_config('mod_bigbluebuttonbn', 'version') . ')';
     $bbbsession['bnserver'] = bigbluebuttonbn_is_bn_server();
     // Setting for clienttype, assign flash if not enabled, or default if not editable.
     $bbbsession['clienttype'] = BIGBLUEBUTTON_CLIENTTYPE_FLASH;
@@ -3473,7 +3473,7 @@ 
     );
 
     // Check status and set extra values.
-    $activitystatus = bigbluebuttonbn_view_get_activity_status($bbbsession);  // In locallib.
+    $activitystatus = bigbluebuttonbn_view_get_activity_status($bbbsession); // In locallib.
     if ($activitystatus == 'ended') {
         $bbbsession['presentation'] = bigbluebuttonbn_get_presentation_array(
             $bbbsession['context'],

lib.php

Indentation +5 added lines, -5 removed lines

@@ -64,7 +64,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';
@@ -375,7 +375,7 @@ 
     $sql = "SELECT COUNT(*) FROM {bigbluebuttonbn_logs} ";
     $sql .= "WHERE courseid = ? AND bigbluebuttonbnid = ? AND userid = ? AND (log = ? OR log = ?)";
     $result = $DB->count_records_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 $result;
 }
 
@@ -620,12 +620,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;
 }
@@ -877,7 +877,7 @@ 
             'bigbluebuttonbn',
             $bigbluebuttonbn->id,
             $bigbluebuttonbn->completionexpected
-          );
+            );
     }
 }
 

brokerlib.php

Spacing +8 added lines, -8 removed lines

@@ -208,7 +208,7 @@ 
 function bigbluebuttonbn_broker_recording_info_current($recording, $params) {
     $callbackresponse['status'] = true;
     $callbackresponse['found'] = true;
-    $callbackresponse['published'] = (string) $recording['published'];
+    $callbackresponse['published'] = (string)$recording['published'];
     if (!isset($params['meta']) || empty($params['meta'])) {
         return $callbackresponse;
     }
@@ -559,8 +559,8 @@ 
             array('HS256')
         );
     } catch (Exception $e) {
-        $error = 'Caught exception: '.$e->getMessage();
-        header('HTTP/1.0 400 Bad Request. '.$error);
+        $error = 'Caught exception: ' . $e->getMessage();
+        header('HTTP/1.0 400 Bad Request. ' . $error);
         return;
     }
     // Validate that the bigbluebuttonbn activity corresponds to the meeting_id received.
@@ -590,8 +590,8 @@ 
         bigbluebuttonbn_log($bigbluebuttonbn, BIGBLUEBUTTON_LOG_EVENT_CALLBACK, $overrides, json_encode($meta));
         header('HTTP/1.0 202 Accepted');
     } catch (Exception $e) {
-        $error = 'Caught exception: '.$e->getMessage();
-        header('HTTP/1.0 503 Service Unavailable. '.$error);
+        $error = 'Caught exception: ' . $e->getMessage();
+        header('HTTP/1.0 503 Service Unavailable. ' . $error);
     }
 }
 
@@ -612,13 +612,13 @@ 
     $importrecordings = $SESSION->bigbluebuttonbn_importrecordings;
     if (!isset($importrecordings[$params['id']])) {
         $error = "Recording {$params['id']} could not be found. It can not be imported";
-        header('HTTP/1.0 404 Not found. '.$error);
+        header('HTTP/1.0 404 Not found. ' . $error);
         return;
     }
     $callbackresponse = array('status' => true);
     $importrecordings[$params['id']]['imported'] = true;
     $overrides = array('meetingid' => $importrecordings[$params['id']]['meetingID']);
-    $meta = '{"recording":'.json_encode($importrecordings[$params['id']]).'}';
+    $meta = '{"recording":' . json_encode($importrecordings[$params['id']]) . '}';
     bigbluebuttonbn_log($bbbsession['bigbluebuttonbn'], BIGBLUEBUTTONBN_LOG_EVENT_IMPORT, $overrides, $meta);
     // Moodle event logger: Create an event for recording imported.
     if (isset($bbbsession['bigbluebutton']) && isset($bbbsession['cm'])) {
@@ -712,7 +712,7 @@ 
     $action = strtolower($params['action']);
     $requiredparams = bigbluebuttonbn_broker_required_parameters();
     if (!array_key_exists($action, $requiredparams)) {
-        return 'Action '.$params['action'].' can not be performed.';
+        return 'Action ' . $params['action'] . ' can not be performed.';
     }
     return bigbluebuttonbn_broker_validate_parameters_message($params, $requiredparams[$action]);
 }

classes/locallib/notifier.php

Doc Comments +1 added lines, -1 removed lines

@@ -111,7 +111,7 @@
      *
      * @param object $bigbluebuttonbn
      *
-     * @return void
+     * @return string
      */
     public static function htmlmsg_recording_ready($bigbluebuttonbn) {
         return '<p>'.get_string('email_body_recording_ready_for', 'bigbluebuttonbn').

Spacing +27 added lines, -27 removed lines

@@ -44,29 +44,29 @@ 
      * @return string
      */
     public static function htmlmsg_instance_updated($msg) {
-        $messagetext = '<p>'.$msg->activity_type.' "'.$msg->activity_title.'" '.
-            get_string('email_body_notification_meeting_has_been', 'bigbluebuttonbn').' '.$msg->action.'.</p>'."\n";
-        $messagetext .= '<p><b>'.$msg->activity_title.'</b> '.
-            get_string('email_body_notification_meeting_details', 'bigbluebuttonbn').':'."\n";
-        $messagetext .= '<table border="0" style="margin: 5px 0 0 20px"><tbody>'."\n";
-        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
-            get_string('email_body_notification_meeting_title', 'bigbluebuttonbn').': </td><td>'."\n";
-        $messagetext .= $msg->activity_title.'</td></tr>'."\n";
-        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
-            get_string('email_body_notification_meeting_description', 'bigbluebuttonbn').': </td><td>'."\n";
-        $messagetext .= $msg->activity_description.'</td></tr>'."\n";
-        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
-            get_string('email_body_notification_meeting_start_date', 'bigbluebuttonbn').': </td><td>'."\n";
-        $messagetext .= $msg->activity_openingtime.'</td></tr>'."\n";
-        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
-            get_string('email_body_notification_meeting_end_date', 'bigbluebuttonbn').': </td><td>'."\n";
-        $messagetext .= $msg->activity_closingtime.'</td></tr>'."\n";
-        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.$msg->action.' '.
-            get_string('email_body_notification_meeting_by', 'bigbluebuttonbn').': </td><td>'."\n";
-        $messagetext .= $msg->activity_owner.'</td></tr></tbody></table></p>'."\n";
-        $messagetext .= '<p><hr/><br/>'.get_string('email_footer_sent_by', 'bigbluebuttonbn').' '.
-            $msg->user_name.'('.$msg->user_email.') ';
-        $messagetext .= get_string('email_footer_sent_from', 'bigbluebuttonbn').' '.$msg->course_name.'.</p>';
+        $messagetext = '<p>' . $msg->activity_type . ' "' . $msg->activity_title . '" ' .
+            get_string('email_body_notification_meeting_has_been', 'bigbluebuttonbn') . ' ' . $msg->action . '.</p>' . "\n";
+        $messagetext .= '<p><b>' . $msg->activity_title . '</b> ' .
+            get_string('email_body_notification_meeting_details', 'bigbluebuttonbn') . ':' . "\n";
+        $messagetext .= '<table border="0" style="margin: 5px 0 0 20px"><tbody>' . "\n";
+        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">' .
+            get_string('email_body_notification_meeting_title', 'bigbluebuttonbn') . ': </td><td>' . "\n";
+        $messagetext .= $msg->activity_title . '</td></tr>' . "\n";
+        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">' .
+            get_string('email_body_notification_meeting_description', 'bigbluebuttonbn') . ': </td><td>' . "\n";
+        $messagetext .= $msg->activity_description . '</td></tr>' . "\n";
+        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">' .
+            get_string('email_body_notification_meeting_start_date', 'bigbluebuttonbn') . ': </td><td>' . "\n";
+        $messagetext .= $msg->activity_openingtime . '</td></tr>' . "\n";
+        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">' .
+            get_string('email_body_notification_meeting_end_date', 'bigbluebuttonbn') . ': </td><td>' . "\n";
+        $messagetext .= $msg->activity_closingtime . '</td></tr>' . "\n";
+        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">' . $msg->action . ' ' .
+            get_string('email_body_notification_meeting_by', 'bigbluebuttonbn') . ': </td><td>' . "\n";
+        $messagetext .= $msg->activity_owner . '</td></tr></tbody></table></p>' . "\n";
+        $messagetext .= '<p><hr/><br/>' . get_string('email_footer_sent_by', 'bigbluebuttonbn') . ' ' .
+            $msg->user_name . '(' . $msg->user_email . ') ';
+        $messagetext .= get_string('email_footer_sent_from', 'bigbluebuttonbn') . ' ' . $msg->course_name . '.</p>';
         return $messagetext;
     }
 
@@ -83,7 +83,7 @@ 
         $course = $coursemodinfo->get_course($bigbluebuttonbn->course);
         $sender = $USER;
         // Prepare message.
-        $msg = (object) array();
+        $msg = (object)array();
         // Build the message_body.
         $msg->action = $action;
         $msg->activity_type = '';
@@ -114,9 +114,9 @@ 
      * @return void
      */
     public static function htmlmsg_recording_ready($bigbluebuttonbn) {
-        return '<p>'.get_string('email_body_recording_ready_for', 'bigbluebuttonbn').
-            ' &quot;' . $bigbluebuttonbn->name . '&quot; '.
-            get_string('email_body_recording_ready_is_ready', 'bigbluebuttonbn').'.</p>';
+        return '<p>' . get_string('email_body_recording_ready_for', 'bigbluebuttonbn') .
+            ' &quot;' . $bigbluebuttonbn->name . '&quot; ' .
+            get_string('email_body_recording_ready_is_ready', 'bigbluebuttonbn') . '.</p>';
     }
 
     /**