Skip to content

Commit 12c8a8d

Browse files
committed
remove support for config xml
The API was deactivated in BBB 2.2 and removed in 2.3. This library deprecated all related functions in 4.0.
1 parent adc30ee commit 12c8a8d

12 files changed

Lines changed: 4 additions & 502 deletions

README.md

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ Inc.**
2525
* [Create a meeting](#create-a-meeting)
2626
* [Join a meeting](#join-a-meeting)
2727
* [End a meeting](#end-a-meeting)
28-
* [Get default config](#get-default-config)
29-
* [Set default config](#set-default-config)
3028
* [Monitoring](#monitoring)
3129
* [Get a list of meetings](#get-a-list-of-meetings)
3230
* [Is a meeting running?](#is-a-meeting-running)
@@ -176,36 +174,6 @@ $endMeetingParams = new EndMeetingParameters($meetingID, $moderator_password);
176174
$response = $bbb->endMeeting($endMeetingParams);
177175
```
178176

179-
#### Get default config
180-
> :warning: This API call does not have any effect since BBB 2.2 and was removed from BBB 2.3. Deprecated starting from version 4.0 of this library and to be removed in 4.1.
181-
182-
```php
183-
$response = $bbb->getDefaultConfigXML();
184-
185-
if ($response->failed()) {
186-
// error handling
187-
}
188-
189-
$response->getRawXml();
190-
```
191-
192-
#### Set default config
193-
> :warning: This API call does not have any effect since BBB 2.2 and was removed from BBB 2.3. Deprecated starting from version 4.0 of this library and to be removed in 4.1.
194-
195-
```php
196-
use BigBlueButton\Parameters\SetConfigXMLParameters;
197-
198-
$setConfigXmlParams = new SetConfigXMLParameters($meetingId);
199-
$setConfigXmlParams->setRawXml($rawXml);
200-
201-
$response = $bbb->setConfigXML($setConfigXmlParams);
202-
203-
if ($response->failed()) {
204-
// error handling
205-
}
206-
207-
$response->getToken();
208-
```
209177

210178
### Monitoring
211179
#### Get a list of meetings
@@ -468,12 +436,12 @@ final class CustomTransport implements TransportInterface
468436
$contentType = $request->getContentType();
469437
// aka request body
470438
$payload = $request->getPayload();
471-
439+
472440
// [...]
473-
441+
474442
return new TransportResponse($reponseBody, $jsessionId);
475-
}
476-
}
443+
}
444+
}
477445
~~~
478446

479447
Your `TranportInterface` implementation must use all values provided by the `TransportRequest` object passed (currently content type, URL and payload (body)).

src/BigBlueButton.php

Lines changed: 0 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,11 @@
3737
use BigBlueButton\Parameters\IsMeetingRunningParameters;
3838
use BigBlueButton\Parameters\JoinMeetingParameters;
3939
use BigBlueButton\Parameters\PublishRecordingsParameters;
40-
use BigBlueButton\Parameters\SetConfigXMLParameters;
4140
use BigBlueButton\Parameters\UpdateRecordingsParameters;
4241
use BigBlueButton\Responses\ApiVersionResponse;
4342
use BigBlueButton\Responses\CreateMeetingResponse;
4443
use BigBlueButton\Responses\DeleteRecordingsResponse;
4544
use BigBlueButton\Responses\EndMeetingResponse;
46-
use BigBlueButton\Responses\GetDefaultConfigXMLResponse;
4745
use BigBlueButton\Responses\GetMeetingInfoResponse;
4846
use BigBlueButton\Responses\GetMeetingsResponse;
4947
use BigBlueButton\Responses\GetRecordingsResponse;
@@ -55,7 +53,6 @@
5553
use BigBlueButton\Responses\IsMeetingRunningResponse;
5654
use BigBlueButton\Responses\JoinMeetingResponse;
5755
use BigBlueButton\Responses\PublishRecordingsResponse;
58-
use BigBlueButton\Responses\SetConfigXMLResponse;
5956
use BigBlueButton\Responses\UpdateRecordingsResponse;
6057
use BigBlueButton\Util\UrlBuilder;
6158
use SimpleXMLElement;
@@ -159,8 +156,6 @@ public function getConnectionError(): ?int
159156
/* __________________ BBB ADMINISTRATION METHODS _________________ */
160157
/* The methods in the following section support the following categories of the BBB API:
161158
-- create
162-
-- getDefaultConfigXML
163-
-- setConfigXML
164159
-- join
165160
-- end
166161
*/
@@ -188,60 +183,6 @@ public function createMeeting($createMeetingParams)
188183
return new CreateMeetingResponse($xml);
189184
}
190185

191-
/**
192-
* @return string
193-
* @deprecated since 4.0 and will be removed in 4.1. The getDefaultConfigXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.
194-
*/
195-
public function getDefaultConfigXMLUrl()
196-
{
197-
@trigger_error(sprintf('"%s()" is deprecated since 4.0 and will be removed in 4.1. The getDefaultConfigXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.', __METHOD__), E_USER_DEPRECATED);
198-
199-
return $this->urlBuilder->buildUrl(ApiMethod::GET_DEFAULT_CONFIG_XML);
200-
}
201-
202-
/**
203-
* @return GetDefaultConfigXMLResponse
204-
* @throws RuntimeException
205-
* @deprecated since 4.0 and will be removed in 4.1. The getDefaultConfigXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.
206-
*/
207-
public function getDefaultConfigXML()
208-
{
209-
@trigger_error(sprintf('"%s()" is deprecated since 4.0 and will be removed in 4.1. The getDefaultConfigXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.', __METHOD__), E_USER_DEPRECATED);
210-
211-
$xml = $this->processXmlResponse($this->getDefaultConfigXMLUrl());
212-
213-
return new GetDefaultConfigXMLResponse($xml);
214-
}
215-
216-
/**
217-
* @return string
218-
* @deprecated since 4.0 and will be removed in 4.1. The setConfigXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.
219-
*/
220-
public function setConfigXMLUrl()
221-
{
222-
@trigger_error(sprintf('"%s()" is deprecated since 4.0 and will be removed in 4.1. The setConfigXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.', __METHOD__), E_USER_DEPRECATED);
223-
224-
return $this->urlBuilder->buildUrl(ApiMethod::SET_CONFIG_XML, '', false);
225-
}
226-
227-
/**
228-
* @param SetConfigXMLParameters $setConfigXMLParams
229-
*
230-
* @return SetConfigXMLResponse
231-
* @throws RuntimeException
232-
* @deprecated since 4.0 and will be removed in 4.1. The setConfigXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.
233-
*/
234-
public function setConfigXML($setConfigXMLParams)
235-
{
236-
@trigger_error(sprintf('"%s()" is deprecated since 4.0 and will be removed in 4.1. The setConfigXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.', __METHOD__), E_USER_DEPRECATED);
237-
238-
$setConfigXMLPayload = $this->urlBuilder->buildQs(ApiMethod::SET_CONFIG_XML, $setConfigXMLParams->getHTTPQuery());
239-
240-
$xml = $this->processXmlResponse($this->setConfigXMLUrl(), $setConfigXMLPayload, 'application/x-www-form-urlencoded');
241-
242-
return new SetConfigXMLResponse($xml);
243-
}
244-
245186
/**
246187
* @param JoinMeetingParameters $joinMeetingParams
247188
*

src/Core/ApiMethod.php

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,6 @@ abstract class ApiMethod
2727
const IS_MEETING_RUNNING = 'isMeetingRunning';
2828
const GET_MEETING_INFO = 'getMeetingInfo';
2929
const GET_MEETINGS = 'getMeetings';
30-
/**
31-
* @deprecated since 4.0 and will be removed in 4.1. The getDefaultConfigXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.
32-
*/
33-
const GET_DEFAULT_CONFIG_XML = 'getDefaultConfigXML';
34-
/**
35-
* @deprecated since 4.0 and will be removed in 4.1. The setConfigXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.
36-
*/
37-
const SET_CONFIG_XML = 'setConfigXML';
38-
/**
39-
* Note: Unused in the whole project.
40-
*
41-
* @deprecated since 4.0 and will be removed in 4.1. The configXML API was related to the old Flash client which is no longer available since BigBlueButton 2.2. In BigBlueButton 2.3 the whole API call was removed.
42-
*/
43-
const CONFIG_XML = 'configXML';
4430
const SIGN_OUT = 'signOut';
4531
const GET_RECORDINGS = 'getRecordings';
4632
const PUBLISH_RECORDINGS = 'publishRecordings';

src/Parameters/SetConfigXMLParameters.php

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

src/Responses/GetDefaultConfigXMLResponse.php

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

src/Responses/SetConfigXMLResponse.php

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

tests/TestCase.php

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
use BigBlueButton\Parameters\CreateMeetingParameters as CreateMeetingParameters;
2222
use BigBlueButton\Parameters\EndMeetingParameters;
2323
use BigBlueButton\Parameters\JoinMeetingParameters as JoinMeetingParameters;
24-
use BigBlueButton\Parameters\SetConfigXMLParameters as SetConfigXMLParameters;
2524
use BigBlueButton\Parameters\UpdateRecordingsParameters as UpdateRecordingsParameters;
2625
use BigBlueButton\Responses\CreateMeetingResponse;
2726
use BigBlueButton\Responses\UpdateRecordingsResponse;
@@ -265,26 +264,6 @@ protected function getUpdateRecordingsParamsMock($params)
265264
return $updateRecordingsParams->addMeta('presenter', $params['meta_presenter']);
266265
}
267266

268-
/**
269-
* @return array
270-
*/
271-
protected function generateSetConfigXMLParams()
272-
{
273-
return [
274-
'meetingID' => $this->faker->uuid,
275-
];
276-
}
277-
278-
/**
279-
* @param $params array
280-
*
281-
* @return SetConfigXMLParameters
282-
*/
283-
protected function getSetConfigXMLMock($params)
284-
{
285-
return new SetConfigXMLParameters($params['meetingID']);
286-
}
287-
288267
// Load fixtures
289268

290269
protected function loadXmlFile($path)

0 commit comments

Comments
 (0)