Add return types to jsonSerialize to suppress deprecation message. (#507

) * Add return types to jsonSerialize to surpress deprecation message. Fixes issue #506. * Fix pre-existing style issue, rewrite if block with empty body. Fixes issue #506. --------- Co-authored-by: Marc Runkel <[email protected]>
lesstif · Apr 16, 2023 · 5fe666f · 5fe666f
1 parent db4ef1f
commit 5fe666f
Show file tree

Hide file tree

Showing 42 changed files with 51 additions and 59 deletions.
diff --git a/src/Auth/AuthSession.php b/src/Auth/AuthSession.php
@@ -19,7 +19,7 @@ class AuthSession implements \JsonSerializable
  public $loginInfo;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Auth/CurrentUser.php b/src/Auth/CurrentUser.php
@@ -24,7 +24,7 @@ class CurrentUser implements \JsonSerializable
  public $loginInfo;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Auth/LoginInfo.php b/src/Auth/LoginInfo.php
@@ -33,7 +33,7 @@ class LoginInfo implements \JsonSerializable
  public $previousLoginTime;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Auth/SessionInfo.php b/src/Auth/SessionInfo.php
@@ -19,7 +19,7 @@ class SessionInfo implements \JsonSerializable
  public $value;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Board/Board.php b/src/Board/Board.php
@@ -68,7 +68,7 @@ public function getLocation()
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this), function ($var) {
  return !is_null($var);

diff --git a/src/Board/Location.php b/src/Board/Location.php
@@ -85,7 +85,7 @@ public function getName()
  * {@inheritdoc}
  */
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this), function ($var) {
  return !is_null($var);

diff --git a/src/Component/Component.php b/src/Component/Component.php
@@ -92,12 +92,10 @@ public function setProject(string $project): static
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
- $vars = array_filter(get_object_vars($this), function ($var) {
+ return array_filter(get_object_vars($this), function ($var) {
  return !is_null($var);
  });
-
- return $vars;
  }
 }
diff --git a/src/Field/Field.php b/src/Field/Field.php
@@ -112,7 +112,7 @@ public function setSearcherKey(string $searcherKey)
  public $schema;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Group/Group.php b/src/Group/Group.php
@@ -37,7 +37,7 @@ class Group implements \JsonSerializable
  public $expand;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Group/GroupSearchResult.php b/src/Group/GroupSearchResult.php
@@ -40,7 +40,7 @@ class GroupSearchResult implements \JsonSerializable
  public $values;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Attachment.php b/src/Issue/Attachment.php
@@ -32,7 +32,7 @@ class Attachment implements \JsonSerializable
  public $thumbnail;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/ChangeLog.php b/src/Issue/ChangeLog.php
@@ -22,7 +22,7 @@ class ChangeLog implements \JsonSerializable
  public $histories;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Comment.php b/src/Issue/Comment.php
@@ -38,7 +38,7 @@ public function setBody($body)
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Comments.php b/src/Issue/Comments.php
@@ -20,7 +20,7 @@ class Comments implements \JsonSerializable
  public $comments;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Component.php b/src/Issue/Component.php
@@ -13,7 +13,7 @@ public function __construct($name = null)
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/ContentField.php b/src/Issue/ContentField.php
@@ -22,7 +22,7 @@ public function __construct()
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/CustomFieldUsage.php b/src/Issue/CustomFieldUsage.php
@@ -18,7 +18,7 @@ public function __construct()
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/History.php b/src/Issue/History.php
@@ -22,7 +22,7 @@ class History implements \JsonSerializable
  public $items;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Issue.php b/src/Issue/Issue.php
@@ -32,7 +32,7 @@ class Issue implements \JsonSerializable
  public ?ChangeLog $changelog;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/IssueField.php b/src/Issue/IssueField.php
@@ -111,7 +111,7 @@ public function __construct($updateIssue = false)
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): mixed
  {
  $vars = array_filter(get_object_vars($this), function ($var) {
  return !is_null($var);
@@ -120,12 +120,10 @@ public function jsonSerialize()
  // if assignee property has empty value then remove it.
  // @see https:/lesstif/php-jira-rest-client/issues/126
  // @see https:/lesstif/php-jira-rest-client/issues/177
- if (!empty($this->assignee)) {
- // do nothing
- if ($this->assignee->isWantUnassigned() === true) {
- } elseif ($this->assignee->isEmpty()) {
- unset($vars['assignee']);
- }
+ if (!empty($this->assignee) &&
+ $this->assignee->isWantUnassigned() !== true &&
+ $this->assignee->isEmpty()) {
+ unset($vars['assignee']);
  }
 
  // clear undefined json property

diff --git a/src/Issue/IssueStatus.php b/src/Issue/IssueStatus.php
@@ -23,7 +23,7 @@ class IssueStatus implements \JsonSerializable
  public $statuscategory;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/IssueType.php b/src/Issue/IssueType.php
@@ -24,7 +24,7 @@ class IssueType implements \JsonSerializable
  public int $hierarchyLevel;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Notify.php b/src/Issue/Notify.php
@@ -125,7 +125,7 @@ public function setRestrictPermission($id, $key)
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Priority.php b/src/Issue/Priority.php
@@ -23,7 +23,7 @@ class Priority implements \JsonSerializable
  public $description;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/RemoteIssueLink.php b/src/Issue/RemoteIssueLink.php
@@ -23,7 +23,7 @@ class RemoteIssueLink implements \JsonSerializable
  public $object;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Reporter.php b/src/Issue/Reporter.php
@@ -42,9 +42,9 @@ class Reporter implements \JsonSerializable
  public string $accountType;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): ?array
  {
- $vars = (get_object_vars($this));
+ $vars = get_object_vars($this);
 
  foreach ($vars as $key => $value) {
  if ($key === 'name' && ($this->isWantUnassigned() === true)) {

diff --git a/src/Issue/SecurityScheme.php b/src/Issue/SecurityScheme.php
@@ -23,7 +23,7 @@ class SecurityScheme implements \JsonSerializable
  public $levels;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/TimeTracking.php b/src/Issue/TimeTracking.php
@@ -163,11 +163,11 @@ public function setTimeSpentSeconds($timeSpentSeconds)
  *
  * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
  *
- * @return mixed data which can be serialized by <b>json_encode</b>,
+ * @return array data which can be serialized by <b>json_encode</b>,
  * which is a value of any type other than a resource.
  */
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Transition.php b/src/Issue/Transition.php
@@ -85,7 +85,7 @@ public function setCommentBody($commentBody)
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Version.php b/src/Issue/Version.php
@@ -37,7 +37,7 @@ public function __construct($name = null)
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/VersionIssueCounts.php b/src/Issue/VersionIssueCounts.php
@@ -24,7 +24,7 @@ public function __construct()
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/VersionUnresolvedCount.php b/src/Issue/VersionUnresolvedCount.php
@@ -11,7 +11,7 @@ class VersionUnresolvedCount implements \JsonSerializable
  public $issuesUnresolvedCount;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Visibility.php b/src/Issue/Visibility.php
@@ -28,7 +28,7 @@ public function getValue(): string
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Issue/Worklog.php b/src/Issue/Worklog.php
@@ -76,7 +76,7 @@ class Worklog
  * @return array
  */
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/IssueLink/IssueLink.php b/src/IssueLink/IssueLink.php
@@ -22,11 +22,9 @@ class IssueLink implements \JsonSerializable
  public $comment;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
- $vars = array_filter(get_object_vars($this));
-
- return $vars;
+ return array_filter(get_object_vars($this));
  }
 
  /**

diff --git a/src/IssueLink/IssueLinkType.php b/src/IssueLink/IssueLinkType.php
@@ -29,10 +29,8 @@ class IssueLinkType implements \JsonSerializable
  public $self;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
- $vars = array_filter(get_object_vars($this));
-
- return $vars;
+ return array_filter(get_object_vars($this));
  }
 }
diff --git a/src/JsonSerializableTrait.php b/src/JsonSerializableTrait.php
@@ -5,7 +5,7 @@
 trait JsonSerializableTrait
 {
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Project/Project.php b/src/Project/Project.php
@@ -106,7 +106,7 @@ class Project implements \JsonSerializable
  public bool $archived;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): mixed
  {
  $params = array_filter(get_object_vars($this), function ($var) {
  return !is_null($var);

diff --git a/src/Request/Author.php b/src/Request/Author.php
@@ -23,7 +23,7 @@ class Author implements \JsonSerializable
  public $timeZone;
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this));
  }

diff --git a/src/Request/RequestComment.php b/src/Request/RequestComment.php
@@ -44,7 +44,7 @@ public function setIsPublic(bool $public)
  }
 
  #[\ReturnTypeWillChange]
- public function jsonSerialize()
+ public function jsonSerialize(): array
  {
  return array_filter(get_object_vars($this), function ($var) {
  return $var !== null;