blindsidenetworks / moodle-mod_bigbluebuttonbn

locallib.php

Doc Comments +31 added lines

@@ -189,6 +189,9 @@ 
     return $xml;
 }
 
+/**
+ * @param string $meetingID
+ */
 function bigbluebuttonbn_getMeetingInfoArray( $meetingID, $modPW, $URL, $SALT ) {
     $xml = bigbluebuttonbn_wrap_xml_load_file( bigbluebuttonbn_getMeetingInfoURL( $meetingID, $modPW, $URL, $SALT ) );
 
@@ -206,6 +209,9 @@ 
     }
 }
 
+/**
+ * @param string $meetingIDs
+ */
 function bigbluebuttonbn_getRecordingsArray( $meetingIDs, $URL, $SALT ) {
     $recordings = array();
 
@@ -287,6 +293,10 @@ 
     else return 1;
 }
 
+/**
+ * @param string $URL
+ * @param string $SALT
+ */
 function bigbluebuttonbn_doDeleteRecordings( $recordIDs, $URL, $SALT ) {
     $ids = 	explode(",", $recordIDs);
     foreach( $ids as $id){
@@ -297,6 +307,11 @@ 
     return true;
 }
 
+/**
+ * @param string $set
+ * @param string $URL
+ * @param string $SALT
+ */
 function bigbluebuttonbn_doPublishRecordings( $recordIDs, $set, $URL, $SALT ) {
     $ids = 	explode(",", $recordIDs);
     foreach( $ids as $id){
@@ -307,6 +322,10 @@ 
     return true;
 }
 
+/**
+ * @param string $URL
+ * @param string $SALT
+ */
 function bigbluebuttonbn_doEndMeeting( $meetingID, $modPW, $URL, $SALT ) {
     $xml = bigbluebuttonbn_wrap_xml_load_file( bigbluebuttonbn_getEndMeetingURL( $meetingID, $modPW, $URL, $SALT ) );
 
@@ -328,6 +347,9 @@ 
 }
 
 
+/**
+ * @param string $URL
+ */
 function bigbluebuttonbn_getServerVersion( $URL ){
     $xml = bigbluebuttonbn_wrap_xml_load_file( $URL."api" );
     if ( $xml && $xml->returncode == 'SUCCESS' ) {
@@ -346,6 +368,9 @@ 
     }
 }
 
+/**
+ * @param string $url
+ */
 function bigbluebuttonbn_wrap_xml_load_file($url, $method=BIGBLUEBUTTONBN_METHOD_GET, $data=null) {
     if ( bigbluebuttonbn_debugdisplay() ) error_log("Request to: ".$url);
 
@@ -781,6 +806,9 @@ 
     $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'mod_bigbluebuttonbn', 'meetings_cache');
 }
 
+/**
+ * @param boolean $is_moderator
+ */
 function bigbluebuttonbn_bbb_broker_participant_joined($meetingid, $is_moderator) {
     $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'mod_bigbluebuttonbn', 'meetings_cache');
     $result = $cache->get($meetingid);
@@ -1365,6 +1393,9 @@ 
     return (isset($BIGBLUEBUTTONBN_CFG->bigbluebuttonbn_recordingready_enabled)? $BIGBLUEBUTTONBN_CFG->bigbluebuttonbn_recordingready_enabled: (isset($CFG->bigbluebuttonbn_recordingready_enabled)? $CFG->bigbluebuttonbn_recordingready_enabled: false));
 }
 
+/**
+ * @return string
+ */
 function bigbluebuttonbn_get_cfg_moderator_default() {
     global $BIGBLUEBUTTONBN_CFG, $CFG;
     return (isset($BIGBLUEBUTTONBN_CFG->bigbluebuttonbn_moderator_default)? $BIGBLUEBUTTONBN_CFG->bigbluebuttonbn_moderator_default: (isset($CFG->bigbluebuttonbn_moderator_default)? $CFG->bigbluebuttonbn_moderator_default: 'owner'));