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(
@@ -391,7 +391,7 @@ 
  * @param object $a
  * @param object $b
  *
- * @return array
+ * @return integer
  */
 function bigbluebuttonbn_recording_build_sorter($a, $b) {
     if ($a['startTime'] < $b['startTime']) {
@@ -517,7 +517,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')) {
@@ -558,7 +558,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();
@@ -922,7 +922,7 @@ 
  *
  * @param integer $voicebridge
  *
- * @return string
+ * @return boolean
  */
 function bigbluebuttonbn_voicebridge_unique($voicebridge) {
     global $DB;
@@ -1021,7 +1021,7 @@ 
 /**
  * Helper returns an array with all possible bigbluebuttonbn events.
  *
- * @return array
+ * @return string[]
  */
 function bigbluebuttonbn_events() {
     return array(
@@ -1230,7 +1230,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?';
@@ -1279,7 +1279,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)) {
@@ -1781,7 +1781,7 @@ 
  *
  * @param array $bbbsession
  * @param array $recording
- * @param object $rowdata
+ * @param stdClass $rowdata
  *
  * @return object
  */
@@ -1969,7 +1969,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
  *
@@ -1993,7 +1993,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
  *
@@ -2016,7 +2016,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
@@ -2034,7 +2034,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 +48 added lines, -48 removed lines

@@ -119,9 +119,9 @@ 
  */
 function bigbluebuttonbn_get_join_url($meetingid, $username, $pw, $logouturl, $configtoken = null, $userid = null) {
     $data = ['meetingID' => $meetingid,
-              'fullName' => $username,
-              'password' => $pw,
-              'logoutURL' => $logouturl,
+                'fullName' => $username,
+                'password' => $pw,
+                'logoutURL' => $logouturl,
             ];
     if (!is_null($configtoken)) {
         $data['configToken'] = $configtoken;
@@ -173,23 +173,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.
@@ -325,7 +325,7 @@ 
 function bigbluebuttonbn_get_default_config_xml() {
     $xml = bigbluebuttonbn_wrap_xml_load_file(
         \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('getDefaultConfigXML')
-      );
+        );
     return $xml;
 }
 
@@ -426,7 +426,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;
         }
@@ -445,7 +445,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;
         }
@@ -464,7 +464,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;
         }
@@ -481,7 +481,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);
@@ -501,7 +501,7 @@ 
      */
     $xml = bigbluebuttonbn_wrap_xml_load_file(
         \mod_bigbluebuttonbn\locallib\bigbluebutton::action_url('getMeetingInfo', ['meetingID' => $meetingid])
-      );
+        );
     return ($xml && $xml->returncode == 'SUCCESS');
 }
 
@@ -513,7 +513,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;
     }
@@ -581,10 +581,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);
     }
@@ -727,16 +727,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;
 }
 
@@ -781,9 +781,9 @@ 
             continue;
         }
         $participantlistarray[] = array(
-              'selectiontype' => 'role',
-              'selectionid' => $moderatordefault,
-              'role' => BIGBLUEBUTTONBN_ROLE_MODERATOR);
+                'selectiontype' => 'role',
+                'selectionid' => $moderatordefault,
+                'role' => BIGBLUEBUTTONBN_ROLE_MODERATOR);
     }
     return $participantlistarray;
 }
@@ -826,11 +826,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',
-      ];
+        ];
 }
 
 /**
@@ -1107,7 +1107,7 @@ 
         $eventproperties['other'] = $options['other'];
     }
     $event = call_user_func_array('\mod_bigbluebuttonbn\event\bigbluebuttonbn_'.$eventtype.'::create',
-      array($eventproperties));
+        array($eventproperties));
     $event->trigger();
 }
 
@@ -1151,7 +1151,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;
 }
@@ -1521,8 +1521,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) {
         if ($playback['type'] == 'statistics' && (isset($recording['imported']) || (!$bbbsession['administrator'] && !$bbbsession['moderator']))) {
             continue;
@@ -1547,7 +1547,7 @@ 
     $title = get_string('view_recording_format_'.$playback['type'], 'bigbluebuttonbn');
     $onclick = 'M.mod_bigbluebuttonbn.recordings.recordingPlay(this);';
     $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']));
     }
@@ -1559,7 +1559,7 @@ 
         'data-target' => $playback['type'],
         'data-href' => $href,
         'class' => 'btn btn-sm btn-default'
-      );
+        );
     return $OUTPUT->action_link('#', $title, null, $linkattributes);
 }
 
@@ -1673,10 +1673,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'];
@@ -2214,8 +2214,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;
 }
@@ -2500,7 +2500,7 @@ 
         $renderer->render_group_element('participant_moderator_default',
             $renderer->render_group_element_configmultiselect('participant_moderator_default',
                 array_keys($owner), array_merge($owner, $roles))
-          );
+            );
     }
 }
 

Spacing +83 added lines, -83 removed lines

@@ -28,7 +28,7 @@ 
 
 global $CFG;
 
-require_once(dirname(__FILE__).'/lib.php');
+require_once(dirname(__FILE__) . '/lib.php');
 
 /** @var BIGBLUEBUTTONBN_UPDATE_CACHE boolean set to true indicates that cache has to be updated */
 const BIGBLUEBUTTONBN_UPDATE_CACHE = true;
@@ -100,7 +100,7 @@ 
     if (isset($meta)) {
         $log->meta = $meta;
     } else if ($event == BIGBLUEBUTTONBN_LOG_EVENT_CREATE) {
-        $log->meta = '{"record":'.($bbbsession['record'] ? 'true' : 'false').'}';
+        $log->meta = '{"record":' . ($bbbsession['record'] ? 'true' : 'false') . '}';
     }
     $DB->insert_record('bigbluebuttonbn_logs', $log);
 }
@@ -148,8 +148,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) {
@@ -310,7 +310,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;
     }
@@ -340,21 +340,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;
 }
@@ -369,9 +369,9 @@ 
 function bigbluebuttonbn_get_recording_preview_images($preview) {
     $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);
     }
@@ -391,7 +391,7 @@ 
         if (is_object($value)) {
             $value = '';
         }
-        $metadataarray['meta_'.$key] = $value;
+        $metadataarray['meta_' . $key] = $value;
     }
     return $metadataarray;
 }
@@ -463,7 +463,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;
@@ -543,7 +543,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;
         }
@@ -554,7 +554,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;
@@ -581,8 +581,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',
                );
 
@@ -599,7 +599,7 @@ 
  * @return void
  */
 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);
     }
@@ -619,9 +619,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;
 }
@@ -644,7 +644,7 @@ 
  * @return array $users
  */
 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);
     }
@@ -659,7 +659,7 @@ 
  * @return array $users
  */
 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));
     }
@@ -674,7 +674,7 @@ 
  * @return array $roles
  */
 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;
     }
@@ -689,7 +689,7 @@ 
  * @return array $users
  */
 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);
     }
@@ -704,7 +704,7 @@ 
  * @return object $role
  */
 function bigbluebuttonbn_get_role($id) {
-    $roles = (array) role_get_names();
+    $roles = (array)role_get_names();
     if (is_numeric($id)) {
         return (object)$roles[$id];
     }
@@ -859,7 +859,7 @@ 
     if (empty($userroles)) {
         $userroles = get_user_roles($context, $userid, true);
     }
-    return bigbluebuttonbn_is_moderator_validator($participantlist, $userid , $userroles);
+    return bigbluebuttonbn_is_moderator_validator($participantlist, $userid, $userroles);
 }
 
 /**
@@ -1010,7 +1010,7 @@ 
 function bigbluebuttonbn_generate_nonce() {
     $mt = microtime();
     $rand = mt_rand();
-    return md5($mt.$rand);
+    return md5($mt . $rand);
 }
 
 /**
@@ -1036,21 +1036,21 @@ 
  */
 function bigbluebuttonbn_events() {
     return array(
-        (string) BIGBLUEBUTTON_EVENT_ACTIVITY_VIEWED,
-        (string) BIGBLUEBUTTON_EVENT_ACTIVITY_MANAGEMENT_VIEWED,
-        (string) BIGBLUEBUTTON_EVENT_LIVE_SESSION,
-        (string) BIGBLUEBUTTON_EVENT_MEETING_CREATED,
-        (string) BIGBLUEBUTTON_EVENT_MEETING_ENDED,
-        (string) BIGBLUEBUTTON_EVENT_MEETING_JOINED,
-        (string) BIGBLUEBUTTON_EVENT_MEETING_LEFT,
-        (string) BIGBLUEBUTTON_EVENT_RECORDING_DELETED,
-        (string) BIGBLUEBUTTON_EVENT_RECORDING_IMPORTED,
-        (string) BIGBLUEBUTTON_EVENT_RECORDING_PROTECTED,
-        (string) BIGBLUEBUTTON_EVENT_RECORDING_PUBLISHED,
-        (string) BIGBLUEBUTTON_EVENT_RECORDING_UNPROTECTED,
-        (string) BIGBLUEBUTTON_EVENT_RECORDING_UNPUBLISHED,
-        (string) BIGBLUEBUTTON_EVENT_RECORDING_EDITED,
-        (string) BIGBLUEBUTTON_EVENT_RECORDING_VIEWED
+        (string)BIGBLUEBUTTON_EVENT_ACTIVITY_VIEWED,
+        (string)BIGBLUEBUTTON_EVENT_ACTIVITY_MANAGEMENT_VIEWED,
+        (string)BIGBLUEBUTTON_EVENT_LIVE_SESSION,
+        (string)BIGBLUEBUTTON_EVENT_MEETING_CREATED,
+        (string)BIGBLUEBUTTON_EVENT_MEETING_ENDED,
+        (string)BIGBLUEBUTTON_EVENT_MEETING_JOINED,
+        (string)BIGBLUEBUTTON_EVENT_MEETING_LEFT,
+        (string)BIGBLUEBUTTON_EVENT_RECORDING_DELETED,
+        (string)BIGBLUEBUTTON_EVENT_RECORDING_IMPORTED,
+        (string)BIGBLUEBUTTON_EVENT_RECORDING_PROTECTED,
+        (string)BIGBLUEBUTTON_EVENT_RECORDING_PUBLISHED,
+        (string)BIGBLUEBUTTON_EVENT_RECORDING_UNPROTECTED,
+        (string)BIGBLUEBUTTON_EVENT_RECORDING_UNPUBLISHED,
+        (string)BIGBLUEBUTTON_EVENT_RECORDING_EDITED,
+        (string)BIGBLUEBUTTON_EVENT_RECORDING_VIEWED
     );
 }
 
@@ -1061,21 +1061,21 @@ 
  */
 function bigbluebuttonbn_events_action() {
     return array(
-        'view' => (string) BIGBLUEBUTTON_EVENT_ACTIVITY_VIEWED,
-        'view_management' => (string) BIGBLUEBUTTON_EVENT_ACTIVITY_MANAGEMENT_VIEWED,
-        'live_action' => (string) BIGBLUEBUTTON_EVENT_LIVE_SESSION,
-        'meeting_create' => (string) BIGBLUEBUTTON_EVENT_MEETING_CREATED,
-        'meeting_end' => (string) BIGBLUEBUTTON_EVENT_MEETING_ENDED,
-        'meeting_join' => (string) BIGBLUEBUTTON_EVENT_MEETING_JOINED,
-        'meeting_left' => (string) BIGBLUEBUTTON_EVENT_MEETING_LEFT,
-        'recording_delete' => (string) BIGBLUEBUTTON_EVENT_RECORDING_DELETED,
-        'recording_import' => (string) BIGBLUEBUTTON_EVENT_RECORDING_IMPORTED,
-        'recording_protect' => (string) BIGBLUEBUTTON_EVENT_RECORDING_PROTECTED,
-        'recording_publish' => (string) BIGBLUEBUTTON_EVENT_RECORDING_PUBLISHED,
-        'recording_unprotect' => (string) BIGBLUEBUTTON_EVENT_RECORDING_UNPROTECTED,
-        'recording_unpublish' => (string) BIGBLUEBUTTON_EVENT_RECORDING_UNPUBLISHED,
-        'recording_edit' => (string) BIGBLUEBUTTON_EVENT_RECORDING_EDITED,
-        'recording_play' => (string) BIGBLUEBUTTON_EVENT_RECORDING_VIEWED
+        'view' => (string)BIGBLUEBUTTON_EVENT_ACTIVITY_VIEWED,
+        'view_management' => (string)BIGBLUEBUTTON_EVENT_ACTIVITY_MANAGEMENT_VIEWED,
+        'live_action' => (string)BIGBLUEBUTTON_EVENT_LIVE_SESSION,
+        'meeting_create' => (string)BIGBLUEBUTTON_EVENT_MEETING_CREATED,
+        'meeting_end' => (string)BIGBLUEBUTTON_EVENT_MEETING_ENDED,
+        'meeting_join' => (string)BIGBLUEBUTTON_EVENT_MEETING_JOINED,
+        'meeting_left' => (string)BIGBLUEBUTTON_EVENT_MEETING_LEFT,
+        'recording_delete' => (string)BIGBLUEBUTTON_EVENT_RECORDING_DELETED,
+        'recording_import' => (string)BIGBLUEBUTTON_EVENT_RECORDING_IMPORTED,
+        'recording_protect' => (string)BIGBLUEBUTTON_EVENT_RECORDING_PROTECTED,
+        'recording_publish' => (string)BIGBLUEBUTTON_EVENT_RECORDING_PUBLISHED,
+        'recording_unprotect' => (string)BIGBLUEBUTTON_EVENT_RECORDING_UNPROTECTED,
+        'recording_unpublish' => (string)BIGBLUEBUTTON_EVENT_RECORDING_UNPUBLISHED,
+        'recording_edit' => (string)BIGBLUEBUTTON_EVENT_RECORDING_EDITED,
+        'recording_play' => (string)BIGBLUEBUTTON_EVENT_RECORDING_VIEWED
     );
 }
 
@@ -1106,7 +1106,7 @@ 
     if (array_key_exists('other', $options)) {
         $eventproperties['other'] = $options['other'];
     }
-    $event = call_user_func_array('\mod_bigbluebuttonbn\event\bigbluebuttonbn_'.$eventtype.'::create',
+    $event = call_user_func_array('\mod_bigbluebuttonbn\event\bigbluebuttonbn_' . $eventtype . '::create',
       array($eventproperties));
     $event->trigger();
 }
@@ -1146,10 +1146,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)));
@@ -1244,7 +1244,7 @@ 
  * @return object
  */
 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, 'POST',
         $configxmlparams, 'application/x-www-form-urlencoded');
@@ -1260,8 +1260,8 @@ 
  * @return string
  */
 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;
 }
 
@@ -1275,7 +1275,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 '';
@@ -1367,7 +1367,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));
 }
 
@@ -1483,7 +1483,7 @@ 
         $visibility = 'hidden ';
     }
     $recordingpreview = html_writer::start_tag('div',
-        array('id' => 'preview-'.$recording['recordID'], $visibility => $visibility));
+        array('id' => 'preview-' . $recording['recordID'], $visibility => $visibility));
     foreach ($recording['playbacks'] as $playback) {
         if (isset($playback['preview'])) {
             foreach ($playback['preview'] as $image) {
@@ -1519,7 +1519,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));
@@ -1527,7 +1527,7 @@ 
         if ($playback['type'] == 'statistics' && (isset($recording['imported']) || (!$bbbsession['administrator'] && !$bbbsession['moderator']))) {
             continue;
         }
-        $recordingtypes .= bigbluebuttonbn_get_recording_data_row_type($recording, $bbbsession, $playback).'&#32;';
+        $recordingtypes .= bigbluebuttonbn_get_recording_data_row_type($recording, $bbbsession, $playback) . '&#32;';
     }
     $recordingtypes .= html_writer::end_tag('div');
     return $recordingtypes;
@@ -1544,12 +1544,12 @@ 
  */
 function bigbluebuttonbn_get_recording_data_row_type($recording, $bbbsession, $playback) {
     global $CFG, $OUTPUT;
-    $title = get_string('view_recording_format_'.$playback['type'], 'bigbluebuttonbn');
+    $title = get_string('view_recording_format_' . $playback['type'], 'bigbluebuttonbn');
     $onclick = 'M.mod_bigbluebuttonbn.recordings.recordingPlay(this);';
     $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']));
     }
     $id = 'recording-play-' . $playback['type'] . '-' . $recording['recordID'];
     $linkattributes = array(
@@ -1683,7 +1683,7 @@ 
             $linkattributes['class'] = 'disabled';
             unset($linkattributes['onclick']);
         }
-        $icon = new pix_icon('i/'.$data['tag'],
+        $icon = new pix_icon('i/' . $data['tag'],
             get_string('view_recording_list_actionbar_' . $data['action'], 'bigbluebuttonbn'),
             'moodle', $iconattributes);
         return $OUTPUT->action_icon('#', $icon, null, $linkattributes, false);
@@ -1800,7 +1800,7 @@ 
  */
 function bigbluebuttonbn_get_recording_table_row($bbbsession, $recording, $rowdata) {
     $row = new html_table_row();
-    $row->id = 'recording-td-'.$recording['recordID'];
+    $row->id = 'recording-td-' . $recording['recordID'];
     $row->attributes['data-imported'] = 'false';
     $texthead = '';
     $texttail = '';
@@ -1859,9 +1859,9 @@ 
 function bigbluebuttonbn_send_notification_recording_ready($bigbluebuttonbn) {
     $sender = get_admin();
     // Prepare message.
-    $messagetext = '<p>'.get_string('email_body_recording_ready_for', 'bigbluebuttonbn').
-        ' &quot;' . $bigbluebuttonbn->name . '&quot; '.
-        get_string('email_body_recording_ready_is_ready', 'bigbluebuttonbn').'.</p>';
+    $messagetext = '<p>' . get_string('email_body_recording_ready_for', 'bigbluebuttonbn') .
+        ' &quot;' . $bigbluebuttonbn->name . '&quot; ' .
+        get_string('email_body_recording_ready_is_ready', 'bigbluebuttonbn') . '.</p>';
     $context = context_course::instance($bigbluebuttonbn->course);
     \mod_bigbluebuttonbn\locallib\notifier::notification_send($context, $sender, $bigbluebuttonbn, $messagetext);
 }
@@ -2081,7 +2081,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.
@@ -2213,8 +2213,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;

config-dist.php

Indentation +6 added lines, -6 removed lines

@@ -98,7 +98,7 @@ 
  * recordings from a different activity even from a different course.
  **/
 
- /*
+    /*
  * When the value is set to 1 (checked) the bigbluebuttonbn rooms or
  * activities will have the 'import recordings' capability enabled.
  * $CFG->bigbluebuttonbn['importrecordings_enabled'] = 0;
@@ -119,7 +119,7 @@ 
  * 'Join session' button enabled
  **/
 
- /*
+    /*
  * When the value is set to 1 (checked) the bigbluebuttonbn rooms or
  * activities will have the 'wait for moderator' capability enabled by
  * default.
@@ -298,27 +298,27 @@ 
  * $CFG->bigbluebuttonbn['general_warning_message'] = "Would you like to record your BigBlueButton sessions for later viewing? ";
  */
 
- /*
+    /*
  * The warning box is always shown to administrators, but it is also possible to define other roles
  * to whom the it will be shown. The roles are based on the shortnames defined by Moodle:
  *     'manager,coursecreator,editingteacher,teacher,student,guest,user,frontpage'
  * $CFG->bigbluebuttonbn['general_warning_roles'] = 'editingteacher,teacher';
  */
 
- /*
+    /*
  * As the general_warning_message is shown in a box, its type can be defined with general_warning_type
  * The default type is 'info' which is normaly rendered in blue when using a bootstrap theme.
  * All the modifiers for boxed in bootstrap can be used [info|success|warning|danger].
  * $CFG->bigbluebuttonbn['general_warning_box_type'] = 'info';
  */
 
- /*
+    /*
  * Additionally, when general_warning_button_href value is different than "", a button
  * can also be shown right after the message.
  * $CFG->bigbluebuttonbn['general_warning_button_href'] = "http://blindsidenetworks.com/";
  */
 
- /*
+    /*
  * Finally, the text and class for the button can be modified
  * $CFG->bigbluebuttonbn['general_warning_button_text'] = "Upgrade your site";
  * $CFG->bigbluebuttonbn['general_warning_button_class'] = "btn btn-primary";