Skip to content

Commit 3b58634

Browse files
committed
Remove legacy Flash client 'configXML' related API.
1 parent 0d1d2c4 commit 3b58634

14 files changed

+56
-650
lines changed

composer.json

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"authors": [
1313
{
1414
"name": "Ghazi Triki",
15-
"email": "ghazi.[email protected]",
15+
"email": "ghazi.[email protected]",
1616
"role": "Developer"
1717
}
1818
],
@@ -30,12 +30,15 @@
3030
},
3131
"require-dev": {
3232
"ext-mbstring": "*",
33-
"composer/composer": "^1.10.0",
34-
"phpunit/phpunit": "^8",
35-
"fakerphp/faker": "^1.14",
36-
"friendsofphp/php-cs-fixer": "2.*",
37-
"squizlabs/php_codesniffer": "3.*",
38-
"php-coveralls/php-coveralls": "^2.4.0"
33+
"composer/composer": "^1.10.24",
34+
"phpunit/phpunit": "^8.5",
35+
"fakerphp/faker": "^1.17",
36+
"friendsofphp/php-cs-fixer": "^2.19",
37+
"squizlabs/php_codesniffer": "^3.6",
38+
"php-coveralls/php-coveralls": "^2.5.2"
39+
},
40+
"options": {
41+
"symlink": false
3942
},
4043
"autoload": {
4144
"psr-4": {

src/BigBlueButton.php

Lines changed: 3 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@
3535
use BigBlueButton\Responses\CreateMeetingResponse;
3636
use BigBlueButton\Responses\DeleteRecordingsResponse;
3737
use BigBlueButton\Responses\EndMeetingResponse;
38-
use BigBlueButton\Responses\GetDefaultConfigXMLResponse;
3938
use BigBlueButton\Responses\GetMeetingInfoResponse;
4039
use BigBlueButton\Responses\GetMeetingsResponse;
4140
use BigBlueButton\Responses\GetRecordingsResponse;
@@ -45,7 +44,6 @@
4544
use BigBlueButton\Responses\IsMeetingRunningResponse;
4645
use BigBlueButton\Responses\JoinMeetingResponse;
4746
use BigBlueButton\Responses\PublishRecordingsResponse;
48-
use BigBlueButton\Responses\SetConfigXMLResponse;
4947
use BigBlueButton\Responses\UpdateRecordingsResponse;
5048
use BigBlueButton\Util\UrlBuilder;
5149
use SimpleXMLElement;
@@ -91,8 +89,6 @@ public function getApiVersion()
9189
/* __________________ BBB ADMINISTRATION METHODS _________________ */
9290
/* The methods in the following section support the following categories of the BBB API:
9391
-- create
94-
-- getDefaultConfigXML
95-
-- setConfigXML
9692
-- join
9793
-- end
9894
*/
@@ -118,47 +114,6 @@ public function createMeeting($createMeetingParams)
118114
return new CreateMeetingResponse($xml);
119115
}
120116

121-
/**
122-
* @return string
123-
*/
124-
public function getDefaultConfigXMLUrl()
125-
{
126-
return $this->urlBuilder->buildUrl(ApiMethod::GET_DEFAULT_CONFIG_XML);
127-
}
128-
129-
/**
130-
* @return GetDefaultConfigXMLResponse
131-
* @throws \RuntimeException
132-
*/
133-
public function getDefaultConfigXML()
134-
{
135-
$xml = $this->processXmlResponse($this->getDefaultConfigXMLUrl());
136-
137-
return new GetDefaultConfigXMLResponse($xml);
138-
}
139-
140-
/**
141-
* @return string
142-
*/
143-
public function setConfigXMLUrl()
144-
{
145-
return $this->urlBuilder->buildUrl(ApiMethod::SET_CONFIG_XML, '', false);
146-
}
147-
148-
/**
149-
* @param $setConfigXMLParams
150-
* @return SetConfigXMLResponse
151-
* @throws \RuntimeException
152-
*/
153-
public function setConfigXML($setConfigXMLParams)
154-
{
155-
$setConfigXMLPayload = $this->urlBuilder->buildQs(ApiMethod::SET_CONFIG_XML, $setConfigXMLParams->getHTTPQuery());
156-
157-
$xml = $this->processXmlResponse($this->setConfigXMLUrl(), $setConfigXMLPayload, 'application/x-www-form-urlencoded');
158-
159-
return new SetConfigXMLResponse($xml);
160-
}
161-
162117
/**
163118
* @param $joinMeetingParams JoinMeetingParameters
164119
*
@@ -508,12 +463,13 @@ private function processXmlResponse($url, $payload = '', $contentType = 'applica
508463

509464
/**
510465
* Set Curl Timeout (Optional), Default 10 Seconds
511-
* @param int $TimeOutInSeconds
512-
* @return static
466+
* @param int $TimeOutInSeconds
467+
* @return static
513468
*/
514469
public function setTimeOut($TimeOutInSeconds)
515470
{
516471
$this->timeOut = $TimeOutInSeconds;
472+
517473
return $this;
518474
}
519475
}

src/Core/ApiMethod.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@ abstract class ApiMethod
2727
const IS_MEETING_RUNNING = 'isMeetingRunning';
2828
const GET_MEETING_INFO = 'getMeetingInfo';
2929
const GET_MEETINGS = 'getMeetings';
30-
const GET_DEFAULT_CONFIG_XML = 'getDefaultConfigXML';
31-
const SET_CONFIG_XML = 'setConfigXML';
32-
const CONFIG_XML = 'configXML';
3330
const SIGN_OUT = 'signOut';
3431
const GET_RECORDINGS = 'getRecordings';
3532
const PUBLISH_RECORDINGS = 'publishRecordings';

src/Parameters/CreateMeetingParameters.php

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,7 @@ public function getBannerText()
596596
}
597597

598598
/**
599-
* @param string $bannerText
599+
* @param string $bannerText
600600
* @return CreateMeetingParameters
601601
*/
602602
public function setBannerText($bannerText)
@@ -615,7 +615,7 @@ public function getBannerColor()
615615
}
616616

617617
/**
618-
* @param string $bannerColor
618+
* @param string $bannerColor
619619
* @return CreateMeetingParameters
620620
*/
621621
public function setBannerColor($bannerColor)
@@ -634,7 +634,7 @@ public function isLearningDashboardEnabled()
634634
}
635635

636636
/**
637-
* @param bool $learningDashboardEnabled
637+
* @param bool $learningDashboardEnabled
638638
* @return CreateMeetingParameters
639639
*/
640640
public function setLearningDashboardEnabled($learningDashboardEnabled)
@@ -653,7 +653,7 @@ public function getLearningDashboardCleanupDelayInMinutes()
653653
}
654654

655655
/**
656-
* @param int $learningDashboardCleanupDelayInMinutes
656+
* @param int $learningDashboardCleanupDelayInMinutes
657657
* @return CreateMeetingParameters
658658
*/
659659
public function setLearningDashboardCleanupDelayInMinutes($learningDashboardCleanupDelayInMinutes)
@@ -672,7 +672,7 @@ public function getEndWhenNoModeratorDelayInMinutes()
672672
}
673673

674674
/**
675-
* @param int $endWhenNoModeratorDelayInMinutes
675+
* @param int $endWhenNoModeratorDelayInMinutes
676676
* @return CreateMeetingParameters
677677
*/
678678
public function setEndWhenNoModeratorDelayInMinutes($endWhenNoModeratorDelayInMinutes)
@@ -691,7 +691,7 @@ public function isEndWhenNoModerator()
691691
}
692692

693693
/**
694-
* @param bool $endWhenNoModerator
694+
* @param bool $endWhenNoModerator
695695
* @return CreateMeetingParameters
696696
*/
697697
public function setEndWhenNoModerator($endWhenNoModerator)
@@ -710,7 +710,7 @@ public function isMeetingKeepEvents()
710710
}
711711

712712
/**
713-
* @param bool $meetingKeepEvents
713+
* @param bool $meetingKeepEvents
714714
* @return CreateMeetingParameters
715715
*/
716716
public function setMeetingKeepEvents($meetingKeepEvents)
@@ -1128,43 +1128,43 @@ public function getPresentationsAsXML()
11281128
public function getHTTPQuery()
11291129
{
11301130
$queries = [
1131-
'name' => $this->meetingName,
1132-
'meetingID' => $this->meetingId,
1133-
'attendeePW' => $this->attendeePassword,
1134-
'moderatorPW' => $this->moderatorPassword,
1135-
'dialNumber' => $this->dialNumber,
1136-
'voiceBridge' => $this->voiceBridge,
1137-
'webVoice' => $this->webVoice,
1138-
'logoutURL' => $this->logoutUrl,
1139-
'record' => $this->record ? 'true' : 'false',
1140-
'duration' => $this->duration,
1141-
'maxParticipants' => $this->maxParticipants,
1142-
'autoStartRecording' => $this->autoStartRecording ? 'true' : 'false',
1143-
'allowStartStopRecording' => $this->allowStartStopRecording ? 'true' : 'false',
1144-
'welcome' => trim($this->welcomeMessage),
1145-
'moderatorOnlyMessage' => trim($this->moderatorOnlyMessage),
1146-
'webcamsOnlyForModerator' => $this->webcamsOnlyForModerator ? 'true' : 'false',
1147-
'logo' => $this->logo,
1148-
'copyright' => $this->copyright,
1149-
'muteOnStart' => $this->muteOnStart ? 'true' : 'false',
1150-
'guestPolicy' => $this->guestPolicy,
1151-
'lockSettingsDisableCam' => $this->isLockSettingsDisableCam() ? 'true' : 'false',
1152-
'lockSettingsDisableMic' => $this->isLockSettingsDisableMic() ? 'true' : 'false',
1153-
'lockSettingsDisablePrivateChat' => $this->isLockSettingsDisablePrivateChat() ? 'true' : 'false',
1154-
'lockSettingsDisablePublicChat' => $this->isLockSettingsDisablePublicChat() ? 'true' : 'false',
1155-
'lockSettingsDisableNote' => $this->isLockSettingsDisableNote() ? 'true' : 'false',
1156-
'lockSettingsHideUserList' => $this->isLockSettingsHideUserList() ? 'true' : 'false',
1157-
'lockSettingsLockedLayout' => $this->isLockSettingsLockedLayout() ? 'true' : 'false',
1158-
'lockSettingsLockOnJoin' => $this->isLockSettingsLockOnJoin() ? 'true' : 'false',
1159-
'lockSettingsLockOnJoinConfigurable' => $this->isLockSettingsLockOnJoinConfigurable() ? 'true' : 'false',
1160-
'allowModsToUnmuteUsers' => $this->isAllowModsToUnmuteUsers() ? 'true' : 'false',
1161-
'bannerText' => trim($this->bannerText),
1162-
'bannerColor' => trim($this->bannerColor),
1163-
'learningDashboardEnabled' => $this->isLearningDashboardEnabled() ? 'true' : 'false',
1131+
'name' => $this->meetingName,
1132+
'meetingID' => $this->meetingId,
1133+
'attendeePW' => $this->attendeePassword,
1134+
'moderatorPW' => $this->moderatorPassword,
1135+
'dialNumber' => $this->dialNumber,
1136+
'voiceBridge' => $this->voiceBridge,
1137+
'webVoice' => $this->webVoice,
1138+
'logoutURL' => $this->logoutUrl,
1139+
'record' => $this->record ? 'true' : 'false',
1140+
'duration' => $this->duration,
1141+
'maxParticipants' => $this->maxParticipants,
1142+
'autoStartRecording' => $this->autoStartRecording ? 'true' : 'false',
1143+
'allowStartStopRecording' => $this->allowStartStopRecording ? 'true' : 'false',
1144+
'welcome' => trim($this->welcomeMessage),
1145+
'moderatorOnlyMessage' => trim($this->moderatorOnlyMessage),
1146+
'webcamsOnlyForModerator' => $this->webcamsOnlyForModerator ? 'true' : 'false',
1147+
'logo' => $this->logo,
1148+
'copyright' => $this->copyright,
1149+
'muteOnStart' => $this->muteOnStart ? 'true' : 'false',
1150+
'guestPolicy' => $this->guestPolicy,
1151+
'lockSettingsDisableCam' => $this->isLockSettingsDisableCam() ? 'true' : 'false',
1152+
'lockSettingsDisableMic' => $this->isLockSettingsDisableMic() ? 'true' : 'false',
1153+
'lockSettingsDisablePrivateChat' => $this->isLockSettingsDisablePrivateChat() ? 'true' : 'false',
1154+
'lockSettingsDisablePublicChat' => $this->isLockSettingsDisablePublicChat() ? 'true' : 'false',
1155+
'lockSettingsDisableNote' => $this->isLockSettingsDisableNote() ? 'true' : 'false',
1156+
'lockSettingsHideUserList' => $this->isLockSettingsHideUserList() ? 'true' : 'false',
1157+
'lockSettingsLockedLayout' => $this->isLockSettingsLockedLayout() ? 'true' : 'false',
1158+
'lockSettingsLockOnJoin' => $this->isLockSettingsLockOnJoin() ? 'true' : 'false',
1159+
'lockSettingsLockOnJoinConfigurable' => $this->isLockSettingsLockOnJoinConfigurable() ? 'true' : 'false',
1160+
'allowModsToUnmuteUsers' => $this->isAllowModsToUnmuteUsers() ? 'true' : 'false',
1161+
'bannerText' => trim($this->bannerText),
1162+
'bannerColor' => trim($this->bannerColor),
1163+
'learningDashboardEnabled' => $this->isLearningDashboardEnabled() ? 'true' : 'false',
11641164
'learningDashboardCleanupDelayInMinutes' => $this->learningDashboardCleanupDelayInMinutes,
1165-
'endWhenNoModeratorDelayInMinutes' => $this->endWhenNoModeratorDelayInMinutes,
1166-
'endWhenNoModerator' => $this->isEndWhenNoModerator() ? 'true' : 'false',
1167-
'meetingKeepEvents' => $this->isMeetingKeepEvents() ? 'true' : 'false',
1165+
'endWhenNoModeratorDelayInMinutes' => $this->endWhenNoModeratorDelayInMinutes,
1166+
'endWhenNoModerator' => $this->isEndWhenNoModerator() ? 'true' : 'false',
1167+
'meetingKeepEvents' => $this->isMeetingKeepEvents() ? 'true' : 'false',
11681168
];
11691169

11701170
// Add breakout rooms parameters only if the meeting is a breakout room

src/Parameters/SetConfigXMLParameters.php

Lines changed: 0 additions & 97 deletions
This file was deleted.

0 commit comments

Comments
 (0)