Merge pull request #247 from DigitalTimK/enhancement/parameterConstructors

GhaziTriki · web-flow · commit edc3b71e59f0 · 2025-03-29T11:27:17.000+01:00
Improve parameter constructors
diff --git a/src/BigBlueButton.php b/src/BigBlueButton.php
@@ -302,11 +302,9 @@ public function getRecordingsUrl(GetRecordingsParameters $recordingsParams): str
     }
 
     /**
-     * @param mixed $recordingParams
-     *
      * @throws BadResponseException|\RuntimeException
      */
-    public function getRecordings($recordingParams): GetRecordingsResponse
+    public function getRecordings(GetRecordingsParameters $recordingParams): GetRecordingsResponse
     {
         $xml = $this->processXmlResponse($this->getUrlBuilder()->getRecordingsUrl($recordingParams));
 
@@ -414,11 +412,9 @@ public function getHooksCreateUrl(HooksCreateParameters $hookCreateParams): stri
     }
 
     /**
-     * @param mixed $hookCreateParams
-     *
      * @throws BadResponseException
      */
-    public function hooksCreate($hookCreateParams): HooksCreateResponse
+    public function hooksCreate(HooksCreateParameters $hookCreateParams): HooksCreateResponse
     {
         $xml = $this->processXmlResponse($this->getUrlBuilder()->getHooksCreateUrl($hookCreateParams));
 
@@ -452,11 +448,9 @@ public function getHooksDestroyUrl(HooksDestroyParameters $hooksDestroyParams):
     }
 
     /**
-     * @param mixed $hooksDestroyParams
-     *
      * @throws BadResponseException
      */
-    public function hooksDestroy($hooksDestroyParams): HooksDestroyResponse
+    public function hooksDestroy(HooksDestroyParameters $hooksDestroyParams): HooksDestroyResponse
     {
         $xml = $this->processXmlResponse($this->getUrlBuilder()->getHooksDestroyUrl($hooksDestroyParams));
 
diff --git a/src/Core/Track.php b/src/Core/Track.php
@@ -35,10 +35,7 @@ class Track
 
     private string $source;
 
-    /**
-     * @param mixed $track
-     */
-    public function __construct($track)
+    public function __construct(mixed $track)
     {
         $this->href   = $track->href;
         $this->kind   = $track->kind;
diff --git a/src/Parameters/CreateMeetingParameters.php b/src/Parameters/CreateMeetingParameters.php
@@ -29,9 +29,9 @@ class CreateMeetingParameters extends MetaParameters
 {
     use DocumentableTrait;
 
-    private ?string $meetingId = null;
+    private string $meetingId;
 
-    private ?string $meetingName = null;
+    private string $meetingName;
 
     /**
      * @deprecated Password-string replaced by an Enum\Role-constant in JoinMeetingParameters::__construct()
@@ -183,11 +183,8 @@ class CreateMeetingParameters extends MetaParameters
 
     /**
      * CreateMeetingParameters constructor.
-     *
-     * @param mixed $meetingId
-     * @param mixed $meetingName
      */
-    public function __construct($meetingId = null, $meetingName = null)
+    public function __construct(string $meetingId, string $meetingName)
     {
         $this->meetingId   = $meetingId;
         $this->meetingName = $meetingName;
@@ -609,12 +606,9 @@ public function isVirtualBackgroundsDisabled(): ?bool
      * Default: false
      *
      * @since 2.4.3
-     *
-     * @param mixed $virtualBackgroundsDisabled
-     *
      * @deprecated Removed in 2.5, temporarily still handled, please transition to disabledFeatures.
      */
-    public function setVirtualBackgroundsDisabled($virtualBackgroundsDisabled): self
+    public function setVirtualBackgroundsDisabled(bool $virtualBackgroundsDisabled): self
     {
         $this->virtualBackgroundsDisabled = $virtualBackgroundsDisabled;
 
@@ -998,10 +992,7 @@ public function setEndCallbackUrl($endCallbackUrl): self
         return $this;
     }
 
-    /**
-     * @param mixed $recordingReadyCallbackUrl
-     */
-    public function setRecordingReadyCallbackUrl($recordingReadyCallbackUrl): self
+    public function setRecordingReadyCallbackUrl(string $recordingReadyCallbackUrl): self
     {
         $this->addMeta('bbb-recording-ready-url', $recordingReadyCallbackUrl);
 
@@ -1102,11 +1093,9 @@ public function isBreakoutRoomsEnabled(): ?bool
      *
      * Default: true
      *
-     * @param mixed $breakoutRoomsEnabled
-     *
      * @deprecated Removed in 2.5, temporarily still handled, please transition to disabledFeatures.
      */
-    public function setBreakoutRoomsEnabled($breakoutRoomsEnabled): self
+    public function setBreakoutRoomsEnabled(bool $breakoutRoomsEnabled): self
     {
         $this->breakoutRoomsEnabled = $breakoutRoomsEnabled;
 
@@ -1195,10 +1184,8 @@ public function isAllowRequestsWithoutSession(): ?bool
      * Default: false
      *
      * @since 2.4.3
-     *
-     * @param mixed $allowRequestsWithoutSession
      */
-    public function setAllowRequestsWithoutSession($allowRequestsWithoutSession): self
+    public function setAllowRequestsWithoutSession(bool $allowRequestsWithoutSession): self
     {
         $this->allowRequestsWithoutSession = $allowRequestsWithoutSession;
 
@@ -1447,11 +1434,9 @@ public function getBreakoutRoomsGroups(): array
     }
 
     /**
-     * @param mixed $id
-     * @param mixed $name
-     * @param mixed $roster
+     * @param array<int, string> $roster
      */
-    public function addBreakoutRoomsGroup($id, $name, $roster): self
+    public function addBreakoutRoomsGroup(mixed $id, string $name, array $roster): self
     {
         $this->breakoutRoomsGroups[] = ['id' => $id, 'name' => $name, 'roster' => $roster];
 
diff --git a/src/Parameters/DeleteRecordingsParameters.php b/src/Parameters/DeleteRecordingsParameters.php
@@ -27,9 +27,9 @@
  */
 class DeleteRecordingsParameters extends BaseParameters
 {
-    private ?string $recordingId = null;
+    private string $recordingId;
 
-    public function __construct(?string $recordingId = null)
+    public function __construct(string $recordingId)
     {
         $this->recordingId = $recordingId;
     }
@@ -40,7 +40,7 @@ public function getRecordingId(): ?string
         return $this->recordingId;
     }
 
-    public function setRecordingId(string $recordingId): DeleteRecordingsParameters
+    public function setRecordingId(string $recordingId): self
     {
         $this->recordingId = $recordingId;
 
diff --git a/src/Parameters/EndMeetingParameters.php b/src/Parameters/EndMeetingParameters.php
@@ -27,14 +27,16 @@
  */
 class EndMeetingParameters extends BaseParameters
 {
-    private ?string $meetingId = null;
+    private string $meetingId;
 
     /**
+     * The password of the moderator.
+     *
      * @deprecated
      */
-    private ?string $password = null;
+    private ?string $password;
 
-    public function __construct(?string $meetingId = null, ?string $password = null)
+    public function __construct(string $meetingId, ?string $password = null)
     {
         $this->password  = $password;
         $this->meetingId = $meetingId;
@@ -65,7 +67,7 @@ public function getPassword(): ?string
     /**
      * @deprecated
      */
-    public function setPassword(string $password): self
+    public function setPassword(?string $password): self
     {
         $this->password = $password;
 
diff --git a/src/Parameters/GetMeetingInfoParameters.php b/src/Parameters/GetMeetingInfoParameters.php
@@ -27,13 +27,13 @@
  */
 class GetMeetingInfoParameters extends BaseParameters
 {
-    private ?string $meetingId = null;
+    private string $meetingId;
 
     private ?int $offset = null;
 
     private ?int $limit = null;
 
-    public function __construct(?string $meetingId = null)
+    public function __construct(string $meetingId)
     {
         $this->meetingId = $meetingId;
     }
@@ -57,7 +57,7 @@ public function getOffset(): ?int
         return $this->offset;
     }
 
-    public function setOffset(int $offset): self
+    public function setOffset(?int $offset): self
     {
         $this->offset = $offset;
 
@@ -70,7 +70,7 @@ public function getLimit(): ?int
         return $this->limit;
     }
 
-    public function setLimit(int $limit): self
+    public function setLimit(?int $limit): self
     {
         $this->limit = $limit;
 
diff --git a/src/Parameters/GetRecordingTextTracksParameters.php b/src/Parameters/GetRecordingTextTracksParameters.php
@@ -27,12 +27,12 @@
  */
 class GetRecordingTextTracksParameters extends MetaParameters
 {
-    private ?string $recordId = null;
+    private string $recordId;
 
     /**
      * GetRecordingTextTracksParameters constructor.
      */
-    public function __construct(?string $recordId = null)
+    public function __construct(string $recordId)
     {
         $this->recordId = $recordId;
     }
diff --git a/src/Parameters/InsertDocumentParameters.php b/src/Parameters/InsertDocumentParameters.php
@@ -29,9 +29,9 @@ class InsertDocumentParameters extends BaseParameters
 {
     use DocumentableTrait;
 
-    private ?string $meetingId = null;
+    private string $meetingId;
 
-    public function __construct(?string $meetingId = null)
+    public function __construct(string $meetingId)
     {
         $this->meetingId = $meetingId;
     }
diff --git a/src/Parameters/IsMeetingRunningParameters.php b/src/Parameters/IsMeetingRunningParameters.php
@@ -27,9 +27,9 @@
  */
 class IsMeetingRunningParameters extends BaseParameters
 {
-    private ?string $meetingId = null;
+    private string $meetingId;
 
-    public function __construct(?string $meetingId = null)
+    public function __construct(string $meetingId)
     {
         $this->meetingId = $meetingId;
     }
diff --git a/src/Parameters/JoinMeetingParameters.php b/src/Parameters/JoinMeetingParameters.php
@@ -28,9 +28,9 @@
  */
 class JoinMeetingParameters extends UserDataParameters
 {
-    private ?string $meetingId;
+    private string $meetingId;
 
-    private ?string $username;
+    private string $username;
 
     /**
      * @deprecated Password-string replaced by an Enum\Role-constant in JoinMeetingParameters::__construct()
@@ -50,7 +50,7 @@ class JoinMeetingParameters extends UserDataParameters
     /**
      * @var array<string, string>
      */
-    private array $customParameters;
+    private array $customParameters = [];
 
     private ?string $role = null;
 
@@ -60,12 +60,7 @@ class JoinMeetingParameters extends UserDataParameters
 
     private ?string $defaultLayout = null;
 
-    /**
-     * @param mixed $passwordOrRole
-     * @param mixed $meetingId
-     * @param mixed $username
-     */
-    public function __construct($meetingId = null, $username = null, $passwordOrRole = null)
+    public function __construct(string $meetingId, string $username, string $passwordOrRole)
     {
         $this->meetingId = $meetingId;
         $this->username  = $username;
@@ -75,7 +70,6 @@ public function __construct($meetingId = null, $username = null, $passwordOrRole
         } else {
             $this->password = $passwordOrRole;
         }
-        $this->customParameters = [];
     }
 
     #[ApiParameterMapper(attributeName: 'meetingID')]
@@ -84,7 +78,7 @@ public function getMeetingId(): ?string
         return $this->meetingId;
     }
 
-    public function setMeetingId(string $meetingId): JoinMeetingParameters
+    public function setMeetingId(string $meetingId): self
     {
         $this->meetingId = $meetingId;
 
@@ -116,7 +110,7 @@ public function getPassword(): ?string
     /**
      *@deprecated Password-string replaced by an Enum\Role-constant in JoinMeetingParameters::__construct()
      */
-    public function setPassword(string $password): self
+    public function setPassword(?string $password): self
     {
         $this->password = $password;
 
@@ -255,7 +249,7 @@ public function getHTTPQuery(): string
             $queries[$key] = $value;
         }
 
-        $queries = $this->buildUserData($queries);
+        $this->buildUserData($queries);
 
         return $this->buildHTTPQuery($queries);
     }
diff --git a/src/Parameters/PublishRecordingsParameters.php b/src/Parameters/PublishRecordingsParameters.php
@@ -27,11 +27,11 @@
  */
 class PublishRecordingsParameters extends BaseParameters
 {
-    private ?string $recordingId = null;
+    private string $recordingId;
 
-    private ?bool $publish = null;
+    private bool $publish;
 
-    public function __construct(string $recordingId, ?bool $publish = null)
+    public function __construct(string $recordingId, bool $publish)
     {
         $this->recordingId = $recordingId;
         $this->publish     = $publish;
@@ -71,7 +71,7 @@ public function toArray(): array
     {
         return [
             'recordID' => $this->recordingId,
-            'publish'  => !is_null($this->publish) ? ($this->publish ? 'true' : 'false') : $this->publish,
+            'publish'  => $this->publish ? 'true' : 'false',
         ];
     }
 }
diff --git a/src/Parameters/PutRecordingTextTrackParameters.php b/src/Parameters/PutRecordingTextTrackParameters.php
@@ -27,18 +27,18 @@
  */
 class PutRecordingTextTrackParameters extends BaseParameters
 {
-    private ?string $recordId = null;
+    private string $recordId;
 
-    private ?string $kind = null;
+    private string $kind;
 
-    private ?string $lang = null;
+    private string $lang;
 
-    private ?string $label = null;
+    private string $label;
 
     /**
      * PutRecordingTextTrackParameters constructor.
      */
-    public function __construct(?string $recordId = null, ?string $kind = null, ?string $lang = null, ?string $label = null)
+    public function __construct(string $recordId, string $kind, string $lang, string $label)
     {
         $this->recordId = $recordId;
         $this->kind     = $kind;
diff --git a/src/Parameters/UpdateRecordingsParameters.php b/src/Parameters/UpdateRecordingsParameters.php
@@ -27,9 +27,9 @@
  */
 class UpdateRecordingsParameters extends MetaParameters
 {
-    private ?string $recordingId = null;
+    private string $recordingId;
 
-    public function __construct(?string $recordingId = null)
+    public function __construct(string $recordingId)
     {
         $this->recordingId = $recordingId;
     }
diff --git a/src/Parameters/UserDataParameters.php b/src/Parameters/UserDataParameters.php
diff --git a/src/Responses/BaseJsonResponse.php b/src/Responses/BaseJsonResponse.php
diff --git a/tests/TestCase.php b/tests/TestCase.php
diff --git a/tests/TestServices/Fixtures.php b/tests/TestServices/Fixtures.php

Original file line number	Diff line number	Diff line change
`@@ -302,11 +302,9 @@ public function getRecordingsUrl(GetRecordingsParameters $recordingsParams): str`
`302`	`302`	`}`
`303`	`303`
`304`	`304`	`/**`
`305`		`- * @param mixed $recordingParams`
`306`		`- *`
`307`	`305`	`* @throws BadResponseException\|\RuntimeException`
`308`	`306`	`*/`
`309`		`- public function getRecordings($recordingParams): GetRecordingsResponse`
	`307`	`+ public function getRecordings(GetRecordingsParameters $recordingParams): GetRecordingsResponse`
`310`	`308`	`{`
`311`	`309`	`$xml = $this->processXmlResponse($this->getUrlBuilder()->getRecordingsUrl($recordingParams));`
`312`	`310`
`@@ -414,11 +412,9 @@ public function getHooksCreateUrl(HooksCreateParameters $hookCreateParams): stri`
`414`	`412`	`}`
`415`	`413`
`416`	`414`	`/**`
`417`		`- * @param mixed $hookCreateParams`
`418`		`- *`
`419`	`415`	`* @throws BadResponseException`
`420`	`416`	`*/`
`421`		`- public function hooksCreate($hookCreateParams): HooksCreateResponse`
	`417`	`+ public function hooksCreate(HooksCreateParameters $hookCreateParams): HooksCreateResponse`
`422`	`418`	`{`
`423`	`419`	`$xml = $this->processXmlResponse($this->getUrlBuilder()->getHooksCreateUrl($hookCreateParams));`
`424`	`420`
`@@ -452,11 +448,9 @@ public function getHooksDestroyUrl(HooksDestroyParameters $hooksDestroyParams):`
`452`	`448`	`}`
`453`	`449`
`454`	`450`	`/**`
`455`		`- * @param mixed $hooksDestroyParams`
`456`		`- *`
`457`	`451`	`* @throws BadResponseException`
`458`	`452`	`*/`
`459`		`- public function hooksDestroy($hooksDestroyParams): HooksDestroyResponse`
	`453`	`+ public function hooksDestroy(HooksDestroyParameters $hooksDestroyParams): HooksDestroyResponse`
`460`	`454`	`{`
`461`	`455`	`$xml = $this->processXmlResponse($this->getUrlBuilder()->getHooksDestroyUrl($hooksDestroyParams));`
`462`	`456`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,9 @@`
`27`	`27`	`*/`
`28`	`28`	`class DeleteRecordingsParameters extends BaseParameters`
`29`	`29`	`{`
`30`		`- private ?string $recordingId = null;`
	`30`	`+ private string $recordingId;`
`31`	`31`
`32`		`- public function __construct(?string $recordingId = null)`
	`32`	`+ public function __construct(string $recordingId)`
`33`	`33`	`{`
`34`	`34`	`$this->recordingId = $recordingId;`
`35`	`35`	`}`
`@@ -40,7 +40,7 @@ public function getRecordingId(): ?string`
`40`	`40`	`return $this->recordingId;`
`41`	`41`	`}`
`42`	`42`
`43`		`- public function setRecordingId(string $recordingId): DeleteRecordingsParameters`
	`43`	`+ public function setRecordingId(string $recordingId): self`
`44`	`44`	`{`
`45`	`45`	`$this->recordingId = $recordingId;`
`46`	`46`
Original file line number	Diff line number	Diff line change
`@@ -27,13 +27,13 @@`
`27`	`27`	`*/`
`28`	`28`	`class GetMeetingInfoParameters extends BaseParameters`
`29`	`29`	`{`
`30`		`- private ?string $meetingId = null;`
	`30`	`+ private string $meetingId;`
`31`	`31`
`32`	`32`	`private ?int $offset = null;`
`33`	`33`
`34`	`34`	`private ?int $limit = null;`
`35`	`35`
`36`		`- public function __construct(?string $meetingId = null)`
	`36`	`+ public function __construct(string $meetingId)`
`37`	`37`	`{`
`38`	`38`	`$this->meetingId = $meetingId;`
`39`	`39`	`}`
`@@ -57,7 +57,7 @@ public function getOffset(): ?int`
`57`	`57`	`return $this->offset;`
`58`	`58`	`}`
`59`	`59`
`60`		`- public function setOffset(int $offset): self`
	`60`	`+ public function setOffset(?int $offset): self`
`61`	`61`	`{`
`62`	`62`	`$this->offset = $offset;`
`63`	`63`
`@@ -70,7 +70,7 @@ public function getLimit(): ?int`
`70`	`70`	`return $this->limit;`
`71`	`71`	`}`
`72`	`72`
`73`		`- public function setLimit(int $limit): self`
	`73`	`+ public function setLimit(?int $limit): self`
`74`	`74`	`{`
`75`	`75`	`$this->limit = $limit;`
`76`	`76`
Original file line number	Diff line number	Diff line change
`@@ -27,12 +27,12 @@`
`27`	`27`	`*/`
`28`	`28`	`class GetRecordingTextTracksParameters extends MetaParameters`
`29`	`29`	`{`
`30`		`- private ?string $recordId = null;`
	`30`	`+ private string $recordId;`
`31`	`31`
`32`	`32`	`/**`
`33`	`33`	`* GetRecordingTextTracksParameters constructor.`
`34`	`34`	`*/`
`35`		`- public function __construct(?string $recordId = null)`
	`35`	`+ public function __construct(string $recordId)`
`36`	`36`	`{`
`37`	`37`	`$this->recordId = $recordId;`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,9 +29,9 @@ class InsertDocumentParameters extends BaseParameters`
`29`	`29`	`{`
`30`	`30`	`use DocumentableTrait;`
`31`	`31`
`32`		`- private ?string $meetingId = null;`
	`32`	`+ private string $meetingId;`
`33`	`33`
`34`		`- public function __construct(?string $meetingId = null)`
	`34`	`+ public function __construct(string $meetingId)`
`35`	`35`	`{`
`36`	`36`	`$this->meetingId = $meetingId;`
`37`	`37`	`}`