v2.3-beta: Release (#129)

* v2.3-beta: Bumped up version tags to 2.3-beta

* v2.3-beta: Fixed all the warnings throw by phpdocs and codechecker

CHANGES

@@ -0,0 +1,15 @@
+Bug: Fix for instanceTypeProfiles array used by keys but NOT defined so (CONTRIB-7399).
+Bug: Fix for hard-coded strings in recordings table based on YUI datatables (CONTRIB-7518).
+Bug: Fix for Join session timeline button don't work (CONTRIB-7538).
+Bug: Fix for Index page does not show actions (CONTRIB-7579).
+Enhancement: Playback recordings should be shown in a new tab (CONTRIB-7386).
+Enhancement: Limit instance type repertoire by capabilities (CONTRIB-7400).
+Enhancement: Media files in the description are not shown (CONTRIB-7440).
+Enhancement: Code cleanup and refactoring (CONTRIB-7625).
+New Feature: Being able to define a default presentation file for a Moodle site through settings (CONTRIB-6970).
+New Feature: Users being able to see recordings of only the rooms they have access to (CONTRIB-7225).
+New Feature: Add support for mobile application (CONTRIB-7227).
+New Feature: Add support for muteOnStart (CONTRIB-7519).
+New Feature: Add option for forcing all the sessions to be recorded (with no button) (CONTRIB-7520).
+New Feature: Add support for recordings of breakout rooms (CONTRIB-7521).
+New Feature: Recording list should give an option for searching recordings (CONTRIB-7522).

bbb_view.php

@@ -409,8 +409,9 @@ function bigbluebutton_bbb_view_create_meeting_metadata(&$bbbsession) {
 /**
  * Helper for preparing data used while joining the meeting.
  *
- * @param  array    $bbbsession
+ * @param array    $bbbsession
  * @param object   $bigbluebuttonbn
+ * @param integer  $origin
  */
 function bigbluebutton_bbb_view_join_meeting($bbbsession, $bigbluebuttonbn, $origin = 0) {
     // Update the cache.

classes/analytics/indicator/cognitive_depth.php

@@ -47,10 +47,22 @@ public static function get_name() : \lang_string {
         return new \lang_string('indicator:cognitivedepth', 'mod_bigbluebuttonbn');
     }
 
+    /**
+     * Returns the indicator type.
+     *
+     * @return integer
+     */
     public function get_indicator_type() {
         return self::INDICATOR_COGNITIVE;
     }
 
+    /**
+     * Returns the cognitive depth level.
+     *
+     * @param cm_info $cm
+     *
+     * @return integer
+     */
     public function get_cognitive_depth_level(\cm_info $cm) {
         return self::COGNITIVE_LEVEL_4;
     }

classes/analytics/indicator/social_breadth.php

@@ -47,10 +47,22 @@ public static function get_name() : \lang_string {
         return new \lang_string('indicator:socialbreadth', 'mod_bigbluebuttonbn');
     }
 
+    /**
+     * Returns the indicator type.
+     *
+     * @return integer
+     */
     public function get_indicator_type() {
         return self::INDICATOR_SOCIAL;
     }
 
+    /**
+     * Returns the social breadth level.
+     *
+     * @param cm_info $cm
+     *
+     * @return integer
+     */
     public function get_social_breadth_level(\cm_info $cm) {
         return self::SOCIAL_LEVEL_1;
     }

classes/event/activity_viewed.php

@@ -38,6 +38,8 @@ class activity_viewed extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_PARTICIPATING) {
         parent::init($crud, $edulevel);

classes/event/base.php

@@ -62,6 +62,8 @@ abstract class base extends \core\event\base {
 
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_PARTICIPATING) {
         $this->data['crud'] = $crud;

classes/event/bigbluebuttonbn_activity_management_viewed.php

@@ -37,6 +37,8 @@ class bigbluebuttonbn_activity_management_viewed extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_PARTICIPATING) {
         parent::init($crud, $edulevel);

classes/event/events.php

@@ -36,6 +36,11 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class events {
+
+    /**
+     * Event name matcher.
+     * @var $events
+     */
     public static $events = array(
         'create' => 'activity_created',
         'view' => 'activity_viewed',

classes/event/live_session_event.php

@@ -38,6 +38,8 @@ class live_session_event extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/event/meeting_created.php

@@ -38,6 +38,8 @@ class meeting_created extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/event/meeting_ended.php

@@ -38,6 +38,8 @@ class meeting_ended extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/event/meeting_joined.php

@@ -38,6 +38,8 @@ class meeting_joined extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_PARTICIPATING) {
         parent::init($crud, $edulevel);

classes/event/meeting_left.php

@@ -38,6 +38,8 @@ class meeting_left extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_PARTICIPATING) {
         parent::init($crud, $edulevel);

classes/event/recording_deleted.php

@@ -38,6 +38,8 @@ class recording_deleted extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/event/recording_edited.php

@@ -38,6 +38,8 @@ class recording_edited extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/event/recording_imported.php

@@ -38,6 +38,8 @@ class recording_imported extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/event/recording_protected.php

@@ -38,6 +38,8 @@ class recording_protected extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/event/recording_published.php

@@ -38,6 +38,8 @@ class recording_published extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/event/recording_unprotected.php

@@ -38,6 +38,8 @@ class recording_unprotected extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/event/recording_unpublished.php

@@ -38,6 +38,8 @@ class recording_unpublished extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/event/recording_viewed.php

@@ -38,6 +38,8 @@ class recording_viewed extends base
 {
     /**
      * Init method.
+     * @param string $crud
+     * @param integer $edulevel
      */
     protected function init($crud = 'r', $edulevel = self::LEVEL_OTHER) {
         parent::init($crud, $edulevel);

classes/locallib/mobileview.php

@@ -38,8 +38,8 @@ class mobileview {
 
     /**
      * Return standard array with configurations required for BBB server.
-     * @param $context
-     * @param $session
+     * @param context $context
+     * @param array $session
      * @return mixed
      * @throws \coding_exception
      * @throws \dml_exception
@@ -124,10 +124,10 @@ public static function bigbluebuttonbn_view_bbbsession_set($context, &$session)
     /**
      * Build url for join to session.
      * This method is similar to "bigbluebutton_bbb_view_join_meeting()" in bbb_view.
-     * @param $bbbsession
+     * @param array $bbbsession
      * @return string
      */
-    public static function build_url_join_session($bbbsession) {
+    public static function build_url_join_session(&$bbbsession) {
         $password = $bbbsession['viewerPW'];
         if ($bbbsession['administrator'] || $bbbsession['moderator']) {
             $password = $bbbsession['modPW'];
@@ -199,7 +199,7 @@ public static function bigbluebutton_bbb_view_create_meeting_metadata(&$bbbsessi
 
     /**
      * Helper to prepare data used for create meeting.
-     * @param $bbbsession
+     * @param array $bbbsession
      * @return array
      * @throws \coding_exception
      */
@@ -219,7 +219,6 @@ public static function bigbluebutton_bbb_view_create_meeting_data(&$bbbsession)
                 $data['allowStartStopRecording'] = 'false';
             }
         }
-
         $data['welcome'] = trim($bbbsession['welcome']);
         // Set the duration for the meeting.
         $durationtime = self::bigbluebutton_bbb_view_create_meeting_data_duration($bbbsession['bigbluebuttonbn']->closingtime);

classes/output/import_view.php

@@ -114,6 +114,7 @@ public function __construct($course, $bigbluebuttonbn, $tc) {
     }
 
     /**
+     * Defer to template.
      * @param  renderer_base $output
      * @return array
      */

classes/output/mobile.php

@@ -44,7 +44,7 @@ class mobile {
 
     /**
      * Returns the bigbluebuttonbn course view for the mobile app.
-     * @param $args
+     * @param mixed $args
      * @return array HTML, javascript and other data.
      * @throws \coding_exception
      * @throws \moodle_exception
@@ -250,7 +250,7 @@ public static function mobile_course_view($args) {
 
     /**
      * Returns the view for errors.
-     * @param  string $error Error to display.
+     * @param string $error Error to display.
      *
      * @return array       HTML, javascript and otherdata
      */
@@ -276,12 +276,11 @@ protected static function mobile_print_error($error) {
 
     /**
      * Returns the view for messages.
-     * @param $bigbluebuttonbn
-     * @param $cm
-     * @param  string $message Message to display.
-     * @param  array $notstarted Extra messages for not started session.
-     *
-     * @return array       HTML, javascript and otherdata
+     * @param object $bigbluebuttonbn
+     * @param stdClass $cm
+     * @param string $message Message to display.
+     * @param array $notstarted Extra messages for not started session.
+     * @return array HTML, javascript and otherdata
      */
     protected static function mobile_print_notification($bigbluebuttonbn, $cm, $message, $notstarted = array()) {
 

classes/output/renderer.php

@@ -41,6 +41,7 @@
 class renderer extends plugin_renderer_base {
 
     /**
+     * Renderer for index.
      * @param  index $indexobj
      * @return string
      */
@@ -49,6 +50,7 @@ protected function render_index(index $indexobj) {
     }
 
     /**
+     * Renderer for import_view.
      * @param  import_view $widget
      * @return string
      */

classes/plugin.php

@@ -31,11 +31,17 @@
 defined('MOODLE_INTERNAL') || die();
 
 /**
- * Class plugin
+ * Class plugin.
  * @package mod_bigbluebuttonbn
+ * @copyright 2019 onwards, Blindside Networks Inc
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author    Darko Miletic  (darko.miletic [at] gmail [dt] com)
  */
 abstract class plugin {
 
+    /**
+     * Component name.
+     */
     const COMPONENT = 'mod_bigbluebuttonbn';
 
     /**

lib.php

@@ -82,7 +82,7 @@
 /** @var BIGBLUEBUTTON_LOG_EVENT_CALLBACK string defines the bigbluebuttonbn callback event */
 const BIGBLUEBUTTON_LOG_EVENT_CALLBACK = 'Callback';
 /**
- * Indicates API features that the forum supports.
+ * Indicates API features that the bigbluebuttonbn supports.
  *
  * @uses FEATURE_IDNUMBER
  * @uses FEATURE_GROUPS
@@ -275,7 +275,7 @@ function bigbluebuttonbn_get_extra_capabilities() {
 
 /**
  * This function is used by the reset_course_userdata function in moodlelib.
- * @param $data the data submitted from the reset course.
+ * @param array $data the data submitted from the reset course.
  * @return array status array
  */
 function bigbluebuttonbn_reset_userdata($data) {
@@ -545,6 +545,13 @@ function bigbluebuttonbn_process_post_save_event(&$bigbluebuttonbn) {
     calendar_event::create($event);
 }
 
+/**
+ * Generates an event after a bigbluebuttonbn activity is completed.
+ *
+ * @param object $bigbluebuttonbn BigBlueButtonBN form data
+ *
+ * @return void
+ **/
 function bigbluebuttonbn_process_post_save_completion($bigbluebuttonbn) {
     if (!empty($bigbluebuttonbn->completionexpected)) {
         \core_completion\api::update_completion_date_event(