Merge branch 'master' into 5.0

Author: FelixJacobi

.php-cs-fixer.php

@@ -0,0 +1,23 @@
+<?php
+
+// Invoke the config easily with `php-cs-fixer fix`
+
+$finder = \PhpCsFixer\Finder::create()
+    ->files()
+    ->name('*.php')
+    ->in(__DIR__ . '/src')
+    ->in(__DIR__ . '/tests');
+
+$config = new PhpCsFixer\Config();
+
+return $config
+    ->setUsingCache(false)
+    ->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        'yoda_style' => false,
+        'single_line_throw' => false,
+        'increment_style' => false,
+    ])
+    ->setRiskyAllowed(true)
+    ->setFinder($finder);

.php_cs

@@ -127,7 +127,7 @@
           "fakerphp/faker": "^1.14"
         }
       },
-      "friendsofphp/php-cs-fixer": "^3.7",
+      "friendsofphp/php-cs-fixer": "^3.3",
       "php-coveralls/php-coveralls": "^2.4",
       "phpunit/phpunit": "^8",
       "vimeo/psalm": "^4.22"

composer.json

@@ -16,6 +16,7 @@
  * 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;
 
 use BigBlueButton\Core\ApiMethod;
@@ -32,13 +33,13 @@
 use BigBlueButton\Parameters\GetMeetingInfoParameters;
 use BigBlueButton\Parameters\GetRecordingsParameters;
 use BigBlueButton\Parameters\GetRecordingTextTracksParameters;
-use BigBlueButton\Parameters\PutRecordingTextTrackParameters;
 use BigBlueButton\Parameters\HooksCreateParameters;
 use BigBlueButton\Parameters\HooksDestroyParameters;
 use BigBlueButton\Parameters\InsertDocumentParameters;
 use BigBlueButton\Parameters\IsMeetingRunningParameters;
 use BigBlueButton\Parameters\JoinMeetingParameters;
 use BigBlueButton\Parameters\PublishRecordingsParameters;
+use BigBlueButton\Parameters\PutRecordingTextTrackParameters;
 use BigBlueButton\Parameters\UpdateRecordingsParameters;
 use BigBlueButton\Responses\ApiVersionResponse;
 use BigBlueButton\Responses\CreateMeetingResponse;
@@ -48,27 +49,27 @@
 use BigBlueButton\Responses\GetMeetingsResponse;
 use BigBlueButton\Responses\GetRecordingsResponse;
 use BigBlueButton\Responses\GetRecordingTextTracksResponse;
-use BigBlueButton\Responses\PutRecordingTextTrackResponse;
 use BigBlueButton\Responses\HooksCreateResponse;
 use BigBlueButton\Responses\HooksDestroyResponse;
 use BigBlueButton\Responses\HooksListResponse;
 use BigBlueButton\Responses\InsertDocumentResponse;
 use BigBlueButton\Responses\IsMeetingRunningResponse;
 use BigBlueButton\Responses\JoinMeetingResponse;
 use BigBlueButton\Responses\PublishRecordingsResponse;
+use BigBlueButton\Responses\PutRecordingTextTrackResponse;
 use BigBlueButton\Responses\UpdateRecordingsResponse;
 use BigBlueButton\Util\UrlBuilder;
 use SimpleXMLElement;
 
 /**
- * Class BigBlueButton
+ * Class BigBlueButton.
+ *
  * @final since 4.0.
- * @package BigBlueButton
  */
 class BigBlueButton
 {
     public const CONNECTION_ERROR_BASEURL = 1;
-    public const CONNECTION_ERROR_SECRET  = 2;
+    public const CONNECTION_ERROR_SECRET = 2;
 
     /**
      * @var string
@@ -101,27 +102,29 @@ class BigBlueButton
     protected $transport;
 
     /**
-     * @param  string|null             $baseUrl   (optional) If not given, it will be retrieved from the environment.
-     * @param  string|null             $secret    (optional) If not given, it will be retrieved from the environment.
-     * @param  TransportInterface|null $transport (optional) Use a custom transport for all HTTP requests. Will fallback to default CurlTransport.
+     * @param string|null             $baseUrl   (optional) If not given, it will be retrieved from the environment
+     * @param string|null             $secret    (optional) If not given, it will be retrieved from the environment
+     * @param TransportInterface|null $transport (optional) Use a custom transport for all HTTP requests. Will fallback to default CurlTransport.
+     *
      * @throws ConfigException
      */
     public function __construct(?string $baseUrl = null, ?string $secret = null, ?TransportInterface $transport = null)
     {
         // Keeping backward compatibility with older deployed versions
-        $this->securitySecret   = $secret ?: getenv('BBB_SECURITY_SALT') ?: getenv('BBB_SECRET');
+        $this->securitySecret = $secret ?: getenv('BBB_SECURITY_SALT') ?: getenv('BBB_SECRET');
         $this->bbbServerBaseUrl = $baseUrl ?: getenv('BBB_SERVER_BASE_URL');
 
         if (empty($this->bbbServerBaseUrl)) {
             throw new ConfigException('Base url required');
         }
 
         $this->urlBuilder = new UrlBuilder($this->securitySecret, $this->bbbServerBaseUrl);
-        $this->transport  = $transport ?? CurlTransport::createWithDefaultOptions();
+        $this->transport = $transport ?? CurlTransport::createWithDefaultOptions();
     }
 
     /**
      * @return ApiVersionResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -134,7 +137,8 @@ public function getApiVersion()
     }
 
     /**
-     * Check if connection to api can be established with the baseurl and secret
+     * Check if connection to api can be established with the baseurl and secret.
+     *
      * @return bool connection successful
      */
     public function isConnectionWorking(): bool
@@ -169,7 +173,7 @@ public function isConnectionWorking(): bool
     }
 
     /**
-     * Return connection error type
+     * Return connection error type.
      *
      * @return int|null Connection error (const CONNECTION_ERROR_BASEURL or CONNECTION_ERROR_SECRET)
      */
@@ -195,6 +199,7 @@ public function getCreateMeetingUrl(CreateMeetingParameters $createMeetingParams
 
     /**
      * @return CreateMeetingResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -207,8 +212,6 @@ public function createMeeting(CreateMeetingParameters $createMeetingParams)
     }
 
     /**
-     * @param JoinMeetingParameters $joinMeetingParams
-     *
      * @return string
      */
     public function getJoinMeetingURL(JoinMeetingParameters $joinMeetingParams)
@@ -218,6 +221,7 @@ public function getJoinMeetingURL(JoinMeetingParameters $joinMeetingParams)
 
     /**
      * @return JoinMeetingResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -239,6 +243,7 @@ public function getEndMeetingURL(EndMeetingParameters $endParams)
 
     /**
      * @return EndMeetingResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -260,6 +265,7 @@ public function getIsMeetingRunningUrl(IsMeetingRunningParameters $meetingParams
 
     /**
      * @return IsMeetingRunningResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -281,6 +287,7 @@ public function getMeetingsUrl()
 
     /**
      * @return GetMeetingsResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -302,6 +309,7 @@ public function getMeetingInfoUrl(GetMeetingInfoParameters $meetingParams)
 
     /**
      * @return GetMeetingInfoResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -323,6 +331,7 @@ public function getRecordingsUrl(GetRecordingsParameters $recordingsParams)
 
     /**
      * @return GetRecordingsResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -344,6 +353,7 @@ public function getPublishRecordingsUrl(PublishRecordingsParameters $recordingPa
 
     /**
      * @return PublishRecordingsResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -365,6 +375,7 @@ public function getDeleteRecordingsUrl(DeleteRecordingsParameters $recordingPara
 
     /**
      * @return DeleteRecordingsResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -386,6 +397,7 @@ public function getUpdateRecordingsUrl(UpdateRecordingsParameters $recordingPara
 
     /**
      * @return UpdateRecordingsResponse
+     *
      * @throws NetworkException
      * @throws ParsingException
      * @throws RuntimeException
@@ -407,6 +419,7 @@ public function getRecordingTextTracksUrl(GetRecordingTextTracksParameters $getR
 
     /**
      * @return GetRecordingTextTracksResponse
+     *
      * @throws NetworkException
      * @throws RuntimeException
      */
@@ -427,12 +440,13 @@ public function getPutRecordingTextTrackUrl(PutRecordingTextTrackParameters $put
 
     /**
      * @return PutRecordingTextTrackResponse
+     *
      * @throws NetworkException
      * @throws RuntimeException
      */
     public function putRecordingTextTrack(PutRecordingTextTrackParameters $putRecordingTextTrackParams)
     {
-        $url  = $this->getPutRecordingTextTrackUrl($putRecordingTextTrackParams);
+        $url = $this->getPutRecordingTextTrackUrl($putRecordingTextTrackParams);
         $file = $putRecordingTextTrackParams->getFile();
 
         return new PutRecordingTextTrackResponse(
@@ -452,6 +466,7 @@ public function getHooksCreateUrl(HooksCreateParameters $hookCreateParams)
 
     /**
      * @return HooksCreateResponse
+     *
      * @throws NetworkException
      * @throws RuntimeException
      * @throws ParsingException
@@ -491,6 +506,7 @@ public function getHooksDestroyUrl(HooksDestroyParameters $hooksDestroyParams)
 
     /**
      * @return HooksDestroyResponse
+     *
      * @throws NetworkException
      * @throws RuntimeException
      * @throws ParsingException
@@ -502,9 +518,6 @@ public function hooksDestroy(HooksDestroyParameters $hooksDestroyParams)
         return new HooksDestroyResponse($xml);
     }
 
-    /**
-     * @return string
-     */
     public function getInsertDocumentUrl(InsertDocumentParameters $insertDocumentParams): string
     {
         return $this->urlBuilder->buildUrl(ApiMethod::INSERT_DOCUMENT, $insertDocumentParams->getHTTPQuery());
@@ -549,7 +562,7 @@ private function processXmlResponse(string $url, string $payload = '', string $c
     {
         try {
             return new SimpleXMLElement($this->requestUrl($url, $payload, $contentType));
-        } catch (NetworkException | RuntimeException $e) {
+        } catch (NetworkException|RuntimeException $e) {
             throw $e;
         } catch (\Throwable $e) {
             throw new ParsingException('Could not parse payload as XML', 0, $e);
@@ -569,10 +582,6 @@ private function processJsonResponse(string $url, string $payload = '', string $
     /**
      * A private utility method used by other public methods to request from the api.
      *
-     * @param string $url
-     * @param string $payload
-     * @param string $contentType
-     *
      * @return string Response body
      *
      * @throws RuntimeException|NetworkException

src/BigBlueButton.php

@@ -16,26 +16,27 @@
  * 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\Core;
 
 final class ApiMethod
 {
-    public const CREATE                    = 'create';
-    public const JOIN                      = 'join';
-    public const ENTER                     = 'enter';
-    public const END                       = 'end';
-    public const IS_MEETING_RUNNING        = 'isMeetingRunning';
-    public const GET_MEETING_INFO          = 'getMeetingInfo';
-    public const GET_MEETINGS              = 'getMeetings';
-    public const SIGN_OUT                  = 'signOut';
-    public const GET_RECORDINGS            = 'getRecordings';
-    public const PUBLISH_RECORDINGS        = 'publishRecordings';
-    public const DELETE_RECORDINGS         = 'deleteRecordings';
-    public const UPDATE_RECORDINGS         = 'updateRecordings';
+    public const CREATE = 'create';
+    public const JOIN = 'join';
+    public const ENTER = 'enter';
+    public const END = 'end';
+    public const IS_MEETING_RUNNING = 'isMeetingRunning';
+    public const GET_MEETING_INFO = 'getMeetingInfo';
+    public const GET_MEETINGS = 'getMeetings';
+    public const SIGN_OUT = 'signOut';
+    public const GET_RECORDINGS = 'getRecordings';
+    public const PUBLISH_RECORDINGS = 'publishRecordings';
+    public const DELETE_RECORDINGS = 'deleteRecordings';
+    public const UPDATE_RECORDINGS = 'updateRecordings';
     public const GET_RECORDING_TEXT_TRACKS = 'getRecordingTextTracks';
-    public const PUT_RECORDING_TEXT_TRACK  = 'putRecordingTextTrack';
-    public const HOOKS_CREATE              = 'hooks/create';
-    public const HOOKS_LIST                = 'hooks/list';
-    public const HOOKS_DESTROY             = 'hooks/destroy';
-    public const INSERT_DOCUMENT           = 'insertDocument';
+    public const PUT_RECORDING_TEXT_TRACK = 'putRecordingTextTrack';
+    public const HOOKS_CREATE = 'hooks/create';
+    public const HOOKS_LIST = 'hooks/list';
+    public const HOOKS_DESTROY = 'hooks/destroy';
+    public const INSERT_DOCUMENT = 'insertDocument';
 }