Merge pull request #102 from littleredbutton/deprecated-code

remove support for config xml

Author: sualko

README.md

@@ -25,8 +25,6 @@ Inc.**
         * [Create a meeting](#create-a-meeting)
         * [Join a meeting](#join-a-meeting)
         * [End a meeting](#end-a-meeting)
-        * [Get default config](#get-default-config)
-        * [Set default config](#set-default-config)
     * [Monitoring](#monitoring)
         * [Get a list of meetings](#get-a-list-of-meetings)
         * [Is a meeting running?](#is-a-meeting-running)
@@ -176,36 +174,6 @@ $endMeetingParams = new EndMeetingParameters($meetingID, $moderator_password);
 $response = $bbb->endMeeting($endMeetingParams);
 ```
 
-#### Get default config
-> :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.
-
-```php
-$response = $bbb->getDefaultConfigXML();
-
-if ($response->failed()) {
-    // error handling
-}
-
-$response->getRawXml();
-```
-
-#### Set default config
-> :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.
-
-```php
-use BigBlueButton\Parameters\SetConfigXMLParameters;
-
-$setConfigXmlParams = new SetConfigXMLParameters($meetingId);
-$setConfigXmlParams->setRawXml($rawXml);
-
-$response = $bbb->setConfigXML($setConfigXmlParams);
-
-if ($response->failed()) {
-    // error handling
-}
-
-$response->getToken();
-```
 
 ### Monitoring
 #### Get a list of meetings
@@ -468,12 +436,12 @@ final class CustomTransport implements TransportInterface
         $contentType = $request->getContentType();
         // aka request body
         $payload = $request->getPayload();
-        
+
         // [...]
-        
+
         return new TransportResponse($reponseBody, $jsessionId);
-     } 
- } 
+     }
+ }
 ~~~
 
 Your `TranportInterface` implementation must use all values provided by the `TransportRequest` object passed (currently content type, URL and payload (body)).

src/BigBlueButton.php

@@ -38,13 +38,11 @@
 use BigBlueButton\Parameters\IsMeetingRunningParameters;
 use BigBlueButton\Parameters\JoinMeetingParameters;
 use BigBlueButton\Parameters\PublishRecordingsParameters;
-use BigBlueButton\Parameters\SetConfigXMLParameters;
 use BigBlueButton\Parameters\UpdateRecordingsParameters;
 use BigBlueButton\Responses\ApiVersionResponse;
 use BigBlueButton\Responses\CreateMeetingResponse;
 use BigBlueButton\Responses\DeleteRecordingsResponse;
 use BigBlueButton\Responses\EndMeetingResponse;
-use BigBlueButton\Responses\GetDefaultConfigXMLResponse;
 use BigBlueButton\Responses\GetMeetingInfoResponse;
 use BigBlueButton\Responses\GetMeetingsResponse;
 use BigBlueButton\Responses\GetRecordingsResponse;
@@ -56,7 +54,6 @@
 use BigBlueButton\Responses\IsMeetingRunningResponse;
 use BigBlueButton\Responses\JoinMeetingResponse;
 use BigBlueButton\Responses\PublishRecordingsResponse;
-use BigBlueButton\Responses\SetConfigXMLResponse;
 use BigBlueButton\Responses\UpdateRecordingsResponse;
 use BigBlueButton\Util\UrlBuilder;
 use SimpleXMLElement;
@@ -182,8 +179,6 @@ public function getConnectionError(): ?int
     /* __________________ BBB ADMINISTRATION METHODS _________________ */
     /* The methods in the following section support the following categories of the BBB API:
     -- create
-    -- getDefaultConfigXML
-    -- setConfigXML
     -- join
     -- end
     */
@@ -210,62 +205,8 @@ public function createMeeting(CreateMeetingParameters $createMeetingParams)
     }
 
     /**
-     * @return string
-     * @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.
-     */
-    public function getDefaultConfigXMLUrl()
-    {
-        @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);
-
-        return $this->urlBuilder->buildUrl(ApiMethod::GET_DEFAULT_CONFIG_XML);
-    }
-
-    /**
-     * @return GetDefaultConfigXMLResponse
-     * @throws NetworkException
-     * @throws ParsingException
-     * @throws RuntimeException
-     * @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.
-     */
-    public function getDefaultConfigXML()
-    {
-        @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);
-
-        $xml = $this->processXmlResponse($this->getDefaultConfigXMLUrl());
-
-        return new GetDefaultConfigXMLResponse($xml);
-    }
-
-    /**
-     * @return string
-     * @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.
-     */
-    public function setConfigXMLUrl()
-    {
-        @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);
-
-        return $this->urlBuilder->buildUrl(ApiMethod::SET_CONFIG_XML, '', false);
-    }
-
-    /**
-     * @return SetConfigXMLResponse
-     * @throws NetworkException
-     * @throws ParsingException
-     * @throws RuntimeException
-     * @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.
-     */
-    public function setConfigXML(SetConfigXMLParameters $setConfigXMLParams)
-    {
-        @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);
-
-        $setConfigXMLPayload = $this->urlBuilder->buildQs(ApiMethod::SET_CONFIG_XML, $setConfigXMLParams->getHTTPQuery());
-
-        $xml = $this->processXmlResponse($this->setConfigXMLUrl(), $setConfigXMLPayload, 'application/x-www-form-urlencoded');
-
-        return new SetConfigXMLResponse($xml);
-    }
-
-    /**
+     * @param JoinMeetingParameters $joinMeetingParams
+     *
      * @return string
      */
     public function getJoinMeetingURL(JoinMeetingParameters $joinMeetingParams)

src/Core/ApiMethod.php

@@ -30,20 +30,6 @@ class ApiMethod
     public const IS_MEETING_RUNNING        = 'isMeetingRunning';
     public const GET_MEETING_INFO          = 'getMeetingInfo';
     public const GET_MEETINGS              = 'getMeetings';
-    /**
-     * @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.
-     */
-    public const GET_DEFAULT_CONFIG_XML    = 'getDefaultConfigXML';
-    /**
-     * @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.
-     */
-    public const SET_CONFIG_XML            = 'setConfigXML';
-    /**
-     * Note: Unused in the whole project.
-     *
-     * @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.
-     */
-    public const CONFIG_XML                = 'configXML';
     public const SIGN_OUT                  = 'signOut';
     public const GET_RECORDINGS            = 'getRecordings';
     public const PUBLISH_RECORDINGS        = 'publishRecordings';

src/Parameters/SetConfigXMLParameters.php

@@ -26,22 +26,6 @@ class EndMeetingResponse extends BaseResponse
 {
     const KEY_SET_END_MEETING_REQUEST = 'sentEndMeetingRequest';
 
-    /**
-     * @return string
-     */
-    public function getMessageKey()
-    {
-        return $this->rawXml->messageKey->__toString();
-    }
-
-    /**
-     * @return string
-     */
-    public function getMessage()
-    {
-        return $this->rawXml->message->__toString();
-    }
-
     /**
      * @return bool
      */