Merge branch 'master' into tests/coverage

Author: DigitalTimK

src/BigBlueButton.php

@@ -25,17 +25,12 @@
  */
 abstract class BaseParameters
 {
-    /**
-     * @return string
-     */
-    abstract public function getHTTPQuery();
+    abstract public function getHTTPQuery(): string;
 
     /**
      * @param mixed $array
-     *
-     * @return string
      */
-    protected function buildHTTPQuery($array)
+    protected function buildHTTPQuery($array): string
     {
         return str_replace(['%20', '!', "'", '(', ')', '*'], ['+', '%21', '%27', '%28', '%29', '%2A'], http_build_query(array_filter($array), '', '&', \PHP_QUERY_RFC3986));
     }

src/Parameters/BaseParameters.php

@@ -46,8 +46,6 @@ class JoinMeetingParameters extends UserDataParameters
 
     private ?bool $redirect = null;
 
-    private ?string $clientURL = null;
-
     /**
      * @var array<string, string>
      */
@@ -57,8 +55,6 @@ class JoinMeetingParameters extends UserDataParameters
 
     private ?bool $excludeFromDashboard = null;
 
-    private ?string $configToken = null;
-
     private ?bool $guest = null;
 
     private ?string $defaultLayout = null;
@@ -183,18 +179,6 @@ public function setRedirect(bool $redirect): self
         return $this;
     }
 
-    public function getClientURL(): ?string
-    {
-        return $this->clientURL;
-    }
-
-    public function setClientURL(?string $clientURL): self
-    {
-        $this->clientURL = $clientURL;
-
-        return $this;
-    }
-
     public function getRole(): ?string
     {
         return $this->role;
@@ -219,18 +203,6 @@ public function setExcludeFromDashboard(bool $excludeFromDashboard): self
         return $this;
     }
 
-    public function getConfigToken(): ?string
-    {
-        return $this->configToken;
-    }
-
-    public function setConfigToken(string $configToken): self
-    {
-        $this->configToken = $configToken;
-
-        return $this;
-    }
-
     public function isGuest(): ?bool
     {
         return $this->guest;
@@ -275,8 +247,6 @@ public function getHTTPQuery(): string
             'excludeFromDashboard' => !is_null($this->excludeFromDashboard) ? ($this->excludeFromDashboard ? 'true' : 'false') : $this->excludeFromDashboard,
             'avatarURL'            => $this->avatarURL,
             'redirect'             => !is_null($this->redirect) ? ($this->redirect ? 'true' : 'false') : $this->redirect,
-            'clientURL'            => $this->clientURL,
-            'configToken'          => $this->configToken,
             'guest'                => !is_null($this->guest) ? ($this->guest ? 'true' : 'false') : $this->guest,
             'defaultLayout'        => $this->defaultLayout,
         ];

src/Parameters/JoinMeetingParameters.php

@@ -25,26 +25,17 @@
  */
 class ApiVersionResponse extends BaseResponse
 {
-    /**
-     * @return string
-     */
-    public function getVersion()
+    public function getVersion(): string
     {
         return $this->rawXml->version->__toString();
     }
 
-    /**
-     * @return string
-     */
-    public function getApiVersion()
+    public function getApiVersion(): string
     {
         return $this->rawXml->apiVersion->__toString();
     }
 
-    /**
-     * @return string
-     */
-    public function getBbbVersion()
+    public function getBbbVersion(): string
     {
         return $this->rawXml->bbbVersion->__toString();
     }

src/Responses/ApiVersionResponse.php

@@ -46,10 +46,7 @@ public function getRawJson()
         return json_encode($this->data);
     }
 
-    /**
-     * @return null|mixed
-     */
-    public function getMessage()
+    public function getMessage(): ?string
     {
         if ($this->failed()) {
             return $this->data->response->message;
@@ -58,10 +55,7 @@ public function getMessage()
         return null;
     }
 
-    /**
-     * @return null|mixed
-     */
-    public function getMessageKey()
+    public function getMessageKey(): ?string
     {
         if ($this->failed()) {
             return $this->data->response->messageKey;
@@ -71,9 +65,11 @@ public function getMessageKey()
     }
 
     /**
-     * @return mixed
+     * Return will be either 'SUCCESS' or 'FAILED' (nothing else).
+     *
+     * @see: https://docs.bigbluebutton.org/development/api/#api-calls
      */
-    public function getReturnCode()
+    public function getReturnCode(): string
     {
         return $this->data->response->returncode;
     }

src/Responses/BaseJsonResponse.php

@@ -25,11 +25,8 @@
  */
 class DeleteRecordingsResponse extends BaseResponse
 {
-    /**
-     * @return null|bool
-     */
-    public function isDeleted()
+    public function isDeleted(): bool
     {
-        return 'true' == $this->rawXml->deleted->__toString();
+        return 'true' === $this->rawXml->deleted->__toString();
     }
 }

src/Responses/DeleteRecordingsResponse.php

@@ -27,20 +27,8 @@
  */
 class GetMeetingInfoResponse extends BaseResponse
 {
-    /**
-     * @var Meeting
-     */
-    private $meeting;
-
-    /**
-     * @return Meeting
-     */
-    public function getMeeting()
+    public function getMeeting(): Meeting
     {
-        if (null === $this->meeting) {
-            $this->meeting = new Meeting($this->rawXml);
-        }
-
-        return $this->meeting;
+        return new Meeting($this->rawXml);
     }
 }

src/Responses/GetMeetingInfoResponse.php

@@ -25,26 +25,17 @@
  */
 class HooksCreateResponse extends BaseResponse
 {
-    /**
-     * @return int
-     */
-    public function getHookId()
+    public function getHookId(): int
     {
         return (int) $this->rawXml->hookID->__toString();
     }
 
-    /**
-     * @return null|bool
-     */
-    public function isPermanentHook()
+    public function isPermanentHook(): bool
     {
         return 'true' === $this->rawXml->permanentHook->__toString();
     }
 
-    /**
-     * @return null|bool
-     */
-    public function hasRawData()
+    public function hasRawData(): bool
     {
         return 'true' === $this->rawXml->rawData->__toString();
     }

src/Responses/HooksCreateResponse.php

@@ -25,10 +25,7 @@
  */
 class HooksDestroyResponse extends BaseResponse
 {
-    /**
-     * @return null|bool
-     */
-    public function removed()
+    public function removed(): bool
     {
         return 'true' === $this->rawXml->removed->__toString();
     }

src/Responses/HooksDestroyResponse.php

@@ -25,10 +25,7 @@
  */
 class IsMeetingRunningResponse extends BaseResponse
 {
-    /**
-     * @return null|bool
-     */
-    public function isRunning()
+    public function isRunning(): bool
     {
         return 'true' === $this->rawXml->running->__toString();
     }