blindsidenetworks / moodle-mod_bigbluebuttonbn

JWT.php

Doc Comments +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
      * Sign a string with a given key and algorithm.
      *
      * @param string $msg          The message to sign
-     * @param string|resource $key The secret key
+     * @param string $key The secret key
      * @param string $alg       The signing algorithm. Supported algorithms
      *                               are 'HS256', 'HS384', 'HS512' and 'RS256'
      *

lib.php

Doc Comments +8 added lines, -10 removed lines

@@ -66,7 +66,6 @@ 
  * will create a new instance and return the id number
  * of the new instance.
  *
- * @param object $bigbluebuttonbn An object from the form in mod_form.php
  * @return int The id of the newly inserted bigbluebuttonbn record
  */
 function bigbluebuttonbn_add_instance($data, $mform) {
@@ -93,7 +92,6 @@ 
  * (defined by the form in mod_form.php) this function
  * will update an existing instance with new data.
  *
- * @param object $bigbluebuttonbn An object from the form in mod_form.php
  * @return boolean Success/Fail
  */
 function bigbluebuttonbn_update_instance($data, $mform) {
@@ -162,7 +160,7 @@ 
  * $return->time = the time they did it
  * $return->info = a short text description
  *
- * @return null
+ * @return boolean
  */
 function bigbluebuttonbn_user_outline($course, $user, $mod, $bigbluebuttonbn) {
     return true;
@@ -230,7 +228,7 @@ 
  * See other modules as example.
  *
  * @param int $bigbluebuttonbnid ID of an instance of this module
- * @return mixed boolean/array of students
+ * @return boolean boolean/array of students
  */
 function bigbluebuttonbn_get_participants($bigbluebuttonbnid) {
     return false;
@@ -238,7 +236,7 @@ 
 
 /**
  * Returns all other caps used in module
- * @return array
+ * @return string[]
  */
 function bigbluebuttonbn_get_extra_capabilities() {
     return array('moodle/site:accessallgroups');
@@ -255,7 +253,7 @@ 
  * as reference.
  *
  * @param int $bigbluebuttonbnid ID of an instance of this module
- * @return mixed
+ * @return boolean
  */
 function bigbluebuttonbn_scale_used($bigbluebuttonbnid, $scaleid) {
     $return = false;
@@ -288,7 +286,7 @@ 
 
 /**
  * List of view style log actions
- * @return array
+ * @return string[]
  */
 function bigbluebuttonbn_get_view_actions() {
     return array('view', 'view all');
@@ -296,7 +294,7 @@ 
 
 /**
  * List of update style log actions
- * @return array
+ * @return string[]
  */
 function bigbluebuttonbn_get_post_actions() {
     return array('update', 'add', 'create', 'join', 'end', 'left', 'publish', 'unpublish', 'delete');
@@ -310,7 +308,7 @@ 
  *
  * @global object
  * @param object $coursemodule
- * @return object|null
+ * @return null|cached_cm_info
  */
 function bigbluebuttonbn_get_coursemodule_info($coursemodule) {
     global $CFG, $DB;
@@ -502,7 +500,7 @@ 
  * @param array $args extra arguments
  * @param bool $forcedownload whether or not force download
  * @param array $options additional options affecting the file serving
- * @return bool false if file not found, does not return if found - justsend the file
+ * @return false|null false if file not found, does not return if found - justsend the file
  */
 function bigbluebuttonbn_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
     global $CFG, $DB;

locallib.php

Doc Comments +31 added lines

@@ -194,6 +194,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 ) );
 
@@ -211,6 +214,9 @@ 
     }
 }
 
+/**
+ * @param string $meetingIDs
+ */
 function bigbluebuttonbn_getRecordingsArray( $meetingIDs, $URL, $SALT ) {
     $recordings = array();
 
@@ -292,6 +298,10 @@ 
     }
 }
 
+/**
+ * @param string $URL
+ * @param string $SALT
+ */
 function bigbluebuttonbn_doDeleteRecordings( $recordIDs, $URL, $SALT ) {
     $ids = 	explode(",", $recordIDs);
     foreach( $ids as $id){
@@ -303,6 +313,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){
@@ -314,6 +329,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 ) );
 
@@ -335,6 +354,9 @@ 
 }
 
 
+/**
+ * @param string $URL
+ */
 function bigbluebuttonbn_getServerVersion( $URL ){
     $xml = bigbluebuttonbn_wrap_xml_load_file( $URL."api" );
     if ( $xml && $xml->returncode == 'SUCCESS' ) {
@@ -353,6 +375,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);
 
@@ -813,6 +838,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);
@@ -1402,6 +1430,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'));