Added userdata property to CreateMeetingParameters

Author: GhaziTriki

phpunit.xml.dist

@@ -16,7 +16,7 @@
         <!-- Specify the value of your BigBlueButton secret -->
         <env name="BBB_SECRET" value="8cd8ef52e8e101574e400365b55e11a6"/>
         <!-- Specify the Server Base URL of your BigBlueButton -->
-        <env name="BBB_SERVER_BASE_URL" value="http://test-install.blindsidenetworks.com/bigbluebutton/"/>
+        <env name="BBB_SERVER_BASE_URL" value="https://test-install.blindsidenetworks.com/bigbluebutton/"/>
     </php>
 
     <log type="coverage-html" target="./coverage"

src/Parameters/CreateMeetingParameters.php

@@ -21,7 +21,7 @@
 /**
  * Class CreateMeetingParameters.
  */
-class CreateMeetingParameters extends MetaParameters
+class CreateMeetingParameters extends UserDataParameters
 {
     /**
      * @var string
@@ -713,6 +713,7 @@ public function getHTTPQuery()
         }
 
         $this->buildMeta($queries);
+        $this->buildUserData($queries);
 
         return $this->buildHTTPQuery($queries);
     }

src/Parameters/UserDataParameters.php

@@ -0,0 +1,62 @@
+<?php
+/**
+ * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
+ *
+ * Copyright (c) 2016-2018 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\Parameters;
+
+/**
+ * Class UserDataParameters
+ * @package BigBlueButton\Parameters
+ */
+abstract class UserDataParameters extends MetaParameters
+{
+    /**
+     * @var array
+     */
+    private $userData = [];
+
+    /**
+     * @param $key
+     * @return mixed
+     */
+    public function getUserData($key)
+    {
+        return $this->userData[$key];
+    }
+
+    /**
+     * @param string $key
+     * @param string $value
+     *
+     * @return $this
+     */
+    public function addUserData($key, $value)
+    {
+        $this->userData[$key] = $value;
+
+        return $this;
+    }
+
+    protected function buildUserData(&$queries)
+    {
+        if (count($this->userData) !== 0) {
+            foreach ($this->userData as $k => $v) {
+                $queries['userdata-' . $k] = $v;
+            }
+        }
+    }
+}

src/Responses/CreateMeetingResponse.php

@@ -123,20 +123,4 @@ public function hasBeenForciblyEnded()
     {
         return $this->rawXml->hasBeenForciblyEnded->__toString() === 'true';
     }
-
-    /**
-     * @return string
-     */
-    public function getMessageKey()
-    {
-        return $this->rawXml->messageKey->__toString();
-    }
-
-    /**
-     * @return string
-     */
-    public function getMessage()
-    {
-        return $this->rawXml->message->__toString();
-    }
 }

tests/Parameters/CreateMeetingParametersTest.php

@@ -52,6 +52,7 @@ public function testCreateMeetingParameters()
         $this->assertEquals($params['muteOnStart'], $createMeetingParams->isMuteOnStart());
         $this->assertEquals($params['meta_presenter'], $createMeetingParams->getMeta('presenter'));
         $this->assertEquals($params['meta_endCallbackUrl'], $createMeetingParams->getMeta('endCallbackUrl'));
+        $this->assertEquals($params['userdata_countrycode'], $createMeetingParams->getUserData('countrycode'));
 
         // Check values are empty of this is not a breakout room
         $this->assertNull($createMeetingParams->isBreakout());

tests/TestCase.php

@@ -87,7 +87,8 @@ protected function generateCreateParams()
             'copyright'               => $this->faker->text,
             'muteOnStart'             => $this->faker->boolean(50),
             'meta_presenter'          => $this->faker->name,
-            'meta_endCallbackUrl'     => $this->faker->url
+            'meta_endCallbackUrl'     => $this->faker->url,
+            'userdata_countrycode'    => $this->faker->countryCode
         ];
     }
 
@@ -114,13 +115,14 @@ protected function getCreateMock($params)
     {
         $createMeetingParams = new CreateMeetingParameters($params['meetingId'], $params['meetingName']);
 
-        return $createMeetingParams->setAttendeePassword($params['attendeePassword'])->setModeratorPassword($params['moderatorPassword'])->
-        setDialNumber($params['dialNumber'])->setVoiceBridge($params['voiceBridge'])->setWebVoice($params['webVoice'])->
-        setLogoutUrl($params['logoutUrl'])->setMaxParticipants($params['maxParticipants'])->setRecord($params['record'])->
-        setDuration($params['duration'])->setWelcomeMessage($params['welcomeMessage'])->setAutoStartRecording($params['autoStartRecording'])->
-        setAllowStartStopRecording($params['allowStartStopRecording'])->setModeratorOnlyMessage($params['moderatorOnlyMessage'])->
-        setWebcamsOnlyForModerator($params['webcamsOnlyForModerator'])->setLogo($params['logo'])->setCopyright($params['copyright'])->
-        setEndCallbackUrl($params['meta_endCallbackUrl'])->setMuteOnStart($params['muteOnStart'])->addMeta('presenter', $params['meta_presenter']);
+        return $createMeetingParams->setAttendeePassword($params['attendeePassword'])->setModeratorPassword($params['moderatorPassword'])
+            ->setDialNumber($params['dialNumber'])->setVoiceBridge($params['voiceBridge'])->setWebVoice($params['webVoice'])
+            ->setLogoutUrl($params['logoutUrl'])->setMaxParticipants($params['maxParticipants'])->setRecord($params['record'])
+            ->setDuration($params['duration'])->setWelcomeMessage($params['welcomeMessage'])->setAutoStartRecording($params['autoStartRecording'])
+            ->setAllowStartStopRecording($params['allowStartStopRecording'])->setModeratorOnlyMessage($params['moderatorOnlyMessage'])
+            ->setWebcamsOnlyForModerator($params['webcamsOnlyForModerator'])->setLogo($params['logo'])->setCopyright($params['copyright'])
+            ->setEndCallbackUrl($params['meta_endCallbackUrl'])->setMuteOnStart($params['muteOnStart'])->addMeta('presenter', $params['meta_presenter'])
+            ->addUserData('countrycode', $params['userdata_countrycode']);
     }
 
     /**