Implement breakout rooms groups in create API.

Author: GhaziTriki

src/Parameters/CreateMeetingParameters.php

@@ -321,11 +321,9 @@ class CreateMeetingParameters extends MetaParameters
     private $disabledFeatures = [];
 
     /**
-     * @var
-     *
-     * @todo
+     * @var array
      */
-    private $breakoutRoomsGroups;
+    private $breakoutRoomsGroups = [];
 
     /**
      * CreateMeetingParameters constructor.
@@ -1429,6 +1427,25 @@ public function setDisabledFeatures(array $disabledFeatures): CreateMeetingParam
         return $this;
     }
 
+    public function getBreakoutRoomsGroups(): array
+    {
+        return $this->breakoutRoomsGroups;
+    }
+
+    /**
+     * @param $id
+     * @param $name
+     * @param $roster
+     *
+     * @return $this
+     */
+    public function addBreakoutRoomsGroup($id, $name, $roster)
+    {
+        $this->breakoutRoomsGroups[] = ['id' => $id, 'name' => $name, 'roster' => $roster];
+
+        return $this;
+    }
+
     /**
      * @return array
      */
@@ -1528,7 +1545,6 @@ public function getHTTPQuery()
             'bannerColor'                            => trim($this->bannerColor),
             'learningDashboardEnabled'               => $this->learningDashboardEnabled ? 'true' : 'false',
             'virtualBackgroundsDisabled'             => $this->virtualBackgroundsDisabled ? 'true' : 'false',
-            'learningDashboardCleanupDelayInMinutes' => $this->learningDashboardCleanupDelayInMinutes,
             'endWhenNoModeratorDelayInMinutes'       => $this->endWhenNoModeratorDelayInMinutes,
             'allowRequestsWithoutSession'            => $this->allowRequestsWithoutSession ? 'true' : 'false',
             'meetingEndedURL'                        => $this->meetingEndedURL,
@@ -1553,6 +1569,17 @@ public function getHTTPQuery()
                 'sequence'        => $this->sequence,
                 'freeJoin'        => $this->freeJoin ? 'true' : 'false',
             ]);
+        } else {
+            $queries = array_merge($queries, [
+                'learningDashboardCleanupDelayInMinutes' => $this->learningDashboardCleanupDelayInMinutes,
+            ]);
+
+            // Pre-defined groups to automatically assign the students to a given breakout room
+            if (!empty($this->breakoutRoomsGroups)) {
+                $queries = array_merge($queries, [
+                    'groups' => json_encode($this->breakoutRoomsGroups),
+                ]);
+            }
         }
 
         $this->buildMeta($queries);

tests/BigBlueButtonTest.php

@@ -265,16 +265,15 @@ public function testGetMeetingInfoUrl()
     {
         $meeting = $this->createRealMeeting($this->bbb);
 
-        $url = $this->bbb->getMeetingInfoUrl(new GetMeetingInfoParameters($meeting->getMeetingId(), $meeting->getModeratorPassword()));
+        $url = $this->bbb->getMeetingInfoUrl(new GetMeetingInfoParameters($meeting->getMeetingId()));
         $this->assertStringContainsString('=' . urlencode($meeting->getMeetingId()), $url);
-        $this->assertStringContainsString('=' . urlencode($meeting->getModeratorPassword()), $url);
     }
 
     public function testGetMeetingInfo()
     {
         $meeting = $this->createRealMeeting($this->bbb);
 
-        $result = $this->bbb->getMeetingInfo(new GetMeetingInfoParameters($meeting->getMeetingId(), $meeting->getModeratorPassword()));
+        $result = $this->bbb->getMeetingInfo(new GetMeetingInfoParameters($meeting->getMeetingId()));
         $this->assertEquals('SUCCESS', $result->getReturnCode());
         $this->assertTrue($result->success());
     }

tests/Parameters/CreateMeetingParametersTest.php

@@ -86,6 +86,8 @@ public function testCreateMeetingParameters()
         $this->assertEquals($params['meetingExpireIfNoUserJoinedInMinutes'], $createMeetingParams->getMeetingExpireIfNoUserJoinedInMinutes());
         $this->assertEquals($params['meetingExpireWhenLastUserLeftInMinutes'], $createMeetingParams->getMeetingExpireWhenLastUserLeftInMinutes());
         $this->assertEquals($params['preUploadedPresentationOverrideDefault'], $createMeetingParams->isPreUploadedPresentationOverrideDefault());
+        $this->assertEquals($params['disabledFeatures'], $createMeetingParams->getDisabledFeatures());
+        $this->assertEquals(json_encode($params['groups']), json_encode($createMeetingParams->getBreakoutRoomsGroups()));
         $this->assertEquals($params['meta_presenter'], $createMeetingParams->getMeta('presenter'));
         $this->assertEquals($params['meta_endCallbackUrl'], $createMeetingParams->getMeta('endCallbackUrl'));
         $this->assertEquals($params['meta_bbb-recording-ready-url'], $createMeetingParams->getMeta('bbb-recording-ready-url'));

tests/Parameters/GetMeetingInfoParametersTest.php

@@ -33,12 +33,9 @@ public function testGetMeetingInfoParameters()
         $getMeetingInfoParams = new GetMeetingInfoParameters($meetingId = $this->faker->uuid, $password = $this->faker->password());
 
         $this->assertEquals($meetingId, $getMeetingInfoParams->getMeetingId());
-        $this->assertEquals($password, $getMeetingInfoParams->getPassword());
 
         // Test setters that are ignored by the constructor
-        $getMeetingInfoParams->setMeetingId($newId      = $this->faker->uuid);
-        $getMeetingInfoParams->setPassword($newPassword = $this->faker->password);
+        $getMeetingInfoParams->setMeetingId($newId = $this->faker->uuid);
         $this->assertEquals($newId, $getMeetingInfoParams->getMeetingId());
-        $this->assertEquals($newPassword, $getMeetingInfoParams->getPassword());
     }
 }

tests/TestCase.php

@@ -176,16 +176,29 @@ protected function generateCreateParams()
             'breakoutRoomsPrivateChatEnabled'        => $this->faker->boolean(50),
             'meetingEndedURL'                        => $this->faker->url,
             'meetingLayout'                          => $this->faker->randomElement(MeetingLayout::getValues()),
+            'meetingCameraCap'                       => $this->faker->numberBetween(1, 3),
             'meetingExpireIfNoUserJoinedInMinutes'   => $this->faker->numberBetween(1, 10),
             'meetingExpireWhenLastUserLeftInMinutes' => $this->faker->numberBetween(5, 15),
             'preUploadedPresentationOverrideDefault' => $this->faker->boolean,
+            'groups'                                 => $this->generateBreakoutRoomsGroups(),
             'disabledFeatures'                       => $this->faker->randomElements(Feature::getValues()),
             'meta_presenter'                         => $this->faker->name,
             'meta_endCallbackUrl'                    => $this->faker->url,
             'meta_bbb-recording-ready-url'           => $this->faker->url,
         ];
     }
 
+    protected function generateBreakoutRoomsGroups()
+    {
+        $br     = $this->faker->numberBetween(0, 8);
+        $groups = [];
+        for ($i = 0; $i <= $br; ++$i) {
+            $groups[] = ['id' => $this->faker->uuid, 'name' => $this->faker->name, 'roster' => $this->faker->randomElements];
+        }
+
+        return $groups;
+    }
+
     /**
      * @param $createParams
      *
@@ -210,6 +223,10 @@ protected function getCreateMock($params)
     {
         $createMeetingParams = new CreateMeetingParameters($params['meetingId'], $params['meetingName']);
 
+        foreach ($params['groups'] as $group) {
+            $createMeetingParams->addBreakoutRoomsGroup($group['id'], $group['name'], $group['roster']);
+        }
+
         return $createMeetingParams
             ->setAttendeePassword($params['attendeePassword'])
             ->setModeratorPassword($params['moderatorPassword'])
@@ -262,7 +279,7 @@ protected function getCreateMock($params)
             ->setMeetingExpireIfNoUserJoinedInMinutes($params['meetingExpireIfNoUserJoinedInMinutes'])
             ->setMeetingExpireWhenLastUserLeftInMinutes($params['meetingExpireWhenLastUserLeftInMinutes'])
             ->setPreUploadedPresentationOverrideDefault($params['preUploadedPresentationOverrideDefault'])
-            ->disabledFeatures($params['disabledFeatures'])
+            ->setDisabledFeatures($params['disabledFeatures'])
             ->addMeta('presenter', $params['meta_presenter'])
             ->addMeta('bbb-recording-ready-url', $params['meta_bbb-recording-ready-url'])
         ;
@@ -311,7 +328,7 @@ protected function getJoinMeetingMock($params)
 
         return $joinMeetingParams->setUserId($params['userId'])->setWebVoiceConf($params['webVoiceConf'])
             ->setCreationTime($params['creationTime'])->addUserData('countrycode', $params['userdata_countrycode'])
-            ->addUserData('email', $params['userdata_email'])->addUserData('commercial', $params['userdata_commercial']);
+            ->setRole($params['role'])->addUserData('email', $params['userdata_email'])->addUserData('commercial', $params['userdata_commercial']);
     }
 
     /**