Complete API features from BigBlueButton 2.4 with create and join.

Author: GhaziTriki

.gitignore

@@ -8,4 +8,6 @@ composer.lock
 /nbproject
 
 # PHP CS Fixer cache file
-.php_cs.cache
+.php-cs-fixer.cache
+
+.phpunit.result.cache

src/Enum/Role.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
+ *
+ * Copyright (c) 2016-2022 BigBlueButton Inc. and by respective authors (see below).
+ *
+ * This program is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation; either version 3.0 of the License, or (at your option) any later
+ * version.
+ *
+ * BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along
+ * with BigBlueButton; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace BigBlueButton\Enum;
+
+use MabeEnum\Enum;
+
+class Role extends Enum
+{
+    public const MODERATOR = 'MODERATOR';
+    public const VIEWER    = 'VIEWER';
+}

src/Parameters/CreateMeetingParameters.php

@@ -295,7 +295,6 @@ class CreateMeetingParameters extends MetaParameters
      */
     private $userCameraCap;
 
-
     /**
      * CreateMeetingParameters constructor.
      *
@@ -1303,21 +1302,20 @@ public function setAllowRequestsWithoutSession($allowRequestsWithoutSession)
         return $this;
     }
 
-    /**
-     * @return int
-     */
     public function getUserCameraCap(): int
     {
         return $this->userCameraCap;
     }
 
     /**
      * @param int $userCameraCap
+     *
      * @return CreateMeetingParameters
      */
     public function setUserCameraCap($userCameraCap)
     {
         $this->userCameraCap = $userCameraCap;
+
         return $this;
     }
 

src/Parameters/JoinMeetingParameters.php

@@ -73,7 +73,7 @@ class JoinMeetingParameters extends UserDataParameters
     private $redirect;
 
     /**
-     * @var
+     * @var string
      */
     private $clientURL;
 
@@ -82,6 +82,16 @@ class JoinMeetingParameters extends UserDataParameters
      */
     private $customParameters;
 
+    /**
+     * @var string
+     */
+    private $role;
+
+    /**
+     * @var bool
+     */
+    private $excludeFromDashboard;
+
     /**
      * JoinMeetingParametersTest constructor.
      *
@@ -301,6 +311,42 @@ public function setClientURL($clientURL)
         return $this;
     }
 
+    /**
+     * @return string
+     */
+    public function getRole()
+    {
+        return $this->role;
+    }
+
+    /**
+     * @param string $role
+     */
+    public function setRole($role): JoinMeetingParameters
+    {
+        $this->role = $role;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isExcludeFromDashboard()
+    {
+        return $this->excludeFromDashboard;
+    }
+
+    /**
+     * @param bool $excludeFromDashboard
+     */
+    public function setExcludeFromDashboard($excludeFromDashboard): JoinMeetingParameters
+    {
+        $this->excludeFromDashboard = $excludeFromDashboard;
+
+        return $this;
+    }
+
     /**
      * @param string $paramName
      * @param string $paramValue

tests/Parameters/JoinMeetingParametersTest.php

@@ -20,6 +20,7 @@
 
 namespace BigBlueButton\Parameters;
 
+use BigBlueButton\Enum\Role;
 use BigBlueButton\TestCase;
 
 /**
@@ -39,21 +40,26 @@ public function testJoinMeetingParameters()
         $this->assertEquals($params['userId'], $joinMeetingParams->getUserId());
         $this->assertEquals($params['webVoiceConf'], $joinMeetingParams->getWebVoiceConf());
         $this->assertEquals($params['creationTime'], $joinMeetingParams->getCreationTime());
+        $this->assertEquals($params['role'], $joinMeetingParams->getRole());
         $this->assertEquals($params['userdata_countrycode'], $joinMeetingParams->getUserData('countrycode'));
         $this->assertEquals($params['userdata_email'], $joinMeetingParams->getUserData('email'));
         $this->assertEquals($params['userdata_commercial'], $joinMeetingParams->getUserData('commercial'));
 
         // Test setters that are ignored by the constructor
-        $joinMeetingParams->setMeetingId($newId         = $this->faker->uuid);
-        $joinMeetingParams->setUsername($newName        = $this->faker->name);
-        $joinMeetingParams->setPassword($newPassword    = $this->faker->password);
-        $joinMeetingParams->setConfigToken($configToken = $this->faker->md5);
-        $joinMeetingParams->setAvatarURL($avatarUrl     = $this->faker->url);
-        $joinMeetingParams->setRedirect($redirect       = $this->faker->boolean(50));
-        $joinMeetingParams->setClientURL($clientUrl     = $this->faker->url);
+        $joinMeetingParams->setMeetingId($newId                           = $this->faker->uuid);
+        $joinMeetingParams->setUsername($newName                          = $this->faker->name);
+        $joinMeetingParams->setRole($newRole                              = $this->faker->randomElement(Role::getValues()));
+        $joinMeetingParams->setPassword($newPassword                      = $this->faker->password);
+        $joinMeetingParams->setExcludeFromDashboard($excludeFromDashboard = $this->faker->boolean);
+        $joinMeetingParams->setConfigToken($configToken                   = $this->faker->md5);
+        $joinMeetingParams->setAvatarURL($avatarUrl                       = $this->faker->url);
+        $joinMeetingParams->setRedirect($redirect                         = $this->faker->boolean(50));
+        $joinMeetingParams->setClientURL($clientUrl                       = $this->faker->url);
         $this->assertEquals($newId, $joinMeetingParams->getMeetingId());
         $this->assertEquals($newName, $joinMeetingParams->getUsername());
+        $this->assertEquals($newRole, $joinMeetingParams->getRole());
         $this->assertEquals($newPassword, $joinMeetingParams->getPassword());
+        $this->assertEquals($excludeFromDashboard, $joinMeetingParams->isExcludeFromDashboard());
         $this->assertEquals($configToken, $joinMeetingParams->getConfigToken());
         $this->assertEquals($avatarUrl, $joinMeetingParams->getAvatarURL());
         $this->assertEquals($redirect, $joinMeetingParams->isRedirect());

tests/TestCase.php

@@ -20,8 +20,9 @@
 
 namespace BigBlueButton;
 
-use BigBlueButton\Core\MeetingLayout;
 use BigBlueButton\Enum\GuestPolicy;
+use BigBlueButton\Enum\MeetingLayout;
+use BigBlueButton\Enum\Role;
 use BigBlueButton\Parameters\CreateMeetingParameters;
 use BigBlueButton\Parameters\EndMeetingParameters;
 use BigBlueButton\Parameters\JoinMeetingParameters;
@@ -158,7 +159,7 @@ protected function generateCreateParams()
             'lockSettingsHideViewersCursor'          => $this->faker->boolean(50),
             'allowModsToUnmuteUsers'                 => $this->faker->boolean(50),
             'allowModsToEjectCameras'                => $this->faker->boolean(50),
-            'guestPolicy'                            => $this->faker->randomElement([GuestPolicy::ALWAYS_ACCEPT, GuestPolicy::ALWAYS_DENY, GuestPolicy::ASK_MODERATOR]),
+            'guestPolicy'                            => $this->faker->randomElement(GuestPolicy::getValues()),
             'endWhenNoModerator'                     => $this->faker->boolean(50),
             'endWhenNoModeratorDelayInMinutes'       => $this->faker->numberBetween(1, 30),
             'meetingKeepEvents'                      => $this->faker->boolean(50),
@@ -173,7 +174,7 @@ protected function generateCreateParams()
             'breakoutRoomsRecord'                    => $this->faker->boolean(50),
             'breakoutRoomsPrivateChatEnabled'        => $this->faker->boolean(50),
             'meetingEndedURL'                        => $this->faker->url,
-            'meetingLayout'                          => $this->faker->randomElement([MeetingLayout::CUSTOM_LAYOUT, MeetingLayout::SMART_LAYOUT, MeetingLayout::PRESENTATION_FOCUS, MeetingLayout::VIDEO_FOCUS]),
+            'meetingLayout'                          => $this->faker->randomElement(MeetingLayout::getValues()),
             'meta_presenter'                         => $this->faker->name,
             'meta_endCallbackUrl'                    => $this->faker->url,
             'meta_bbb-recording-ready-url'           => $this->faker->url,
@@ -281,6 +282,8 @@ protected function generateJoinMeetingParams()
             'userId'               => $this->faker->numberBetween(1, 1000),
             'webVoiceConf'         => $this->faker->word,
             'creationTime'         => $this->faker->unixTime,
+            'role'                 => $this->faker->randomElement(Role::getValues()),
+            'excludeFromDashboard' => $this->faker->boolean,
             'userdata_countrycode' => $this->faker->countryCode,
             'userdata_email'       => $this->faker->email,
             'userdata_commercial'  => false,