From 96626e68e6dca77e1e601ae1be5e7ec56ac1b3b9 Mon Sep 17 00:00:00 2001 From: Marc Runkel Date: Fri, 7 Apr 2023 09:23:47 +0200 Subject: [PATCH] Add return types to jsonSerialize to surpress deprecation message. Fixes issue #506. --- src/Auth/AuthSession.php | 2 +- src/Auth/CurrentUser.php | 2 +- src/Auth/LoginInfo.php | 2 +- src/Auth/SessionInfo.php | 2 +- src/Board/Board.php | 2 +- src/Board/Location.php | 2 +- src/Component/Component.php | 6 ++---- src/Field/Field.php | 2 +- src/Group/Group.php | 2 +- src/Group/GroupSearchResult.php | 2 +- src/Issue/Attachment.php | 2 +- src/Issue/ChangeLog.php | 2 +- src/Issue/Comment.php | 2 +- src/Issue/Comments.php | 2 +- src/Issue/Component.php | 2 +- src/Issue/ContentField.php | 2 +- src/Issue/CustomFieldUsage.php | 2 +- src/Issue/History.php | 2 +- src/Issue/Issue.php | 2 +- src/Issue/IssueField.php | 2 +- src/Issue/IssueStatus.php | 2 +- src/Issue/IssueType.php | 2 +- src/Issue/Notify.php | 2 +- src/Issue/Priority.php | 2 +- src/Issue/RemoteIssueLink.php | 2 +- src/Issue/Reporter.php | 2 +- src/Issue/SecurityScheme.php | 2 +- src/Issue/TimeTracking.php | 4 ++-- src/Issue/Transition.php | 2 +- src/Issue/Version.php | 2 +- src/Issue/VersionIssueCounts.php | 2 +- src/Issue/VersionUnresolvedCount.php | 2 +- src/Issue/Visibility.php | 2 +- src/Issue/Worklog.php | 2 +- src/IssueLink/IssueLink.php | 6 ++---- src/IssueLink/IssueLinkType.php | 6 ++---- src/JsonSerializableTrait.php | 2 +- src/Project/Project.php | 2 +- src/Request/Author.php | 2 +- src/Request/RequestComment.php | 2 +- src/Status/Status.php | 2 +- src/User/User.php | 2 +- 42 files changed, 46 insertions(+), 52 deletions(-) diff --git a/src/Auth/AuthSession.php b/src/Auth/AuthSession.php index a9e2296f..7c392f4f 100644 --- 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 index b95434d3..5a2428ea 100644 --- 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 index 65094a2d..07331299 100644 --- 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 index 37be0fa0..cbdaa9b6 100644 --- 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 index d230e09e..696a12b5 100644 --- 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 index 7155bedd..58aa445c 100644 --- 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 index f2be0a95..0efe298b 100644 --- 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 index b9221d88..8322978f 100644 --- 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 index 780ebc06..4d1df1d1 100644 --- 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 index 7174ee19..b860b5ee 100644 --- 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 index dc47cb84..05e5bfa3 100644 --- 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 index 67046093..f57bf126 100644 --- 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 index 8fea03b2..b7b0b169 100644 --- 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 index 10ab2076..d6e73111 100644 --- 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 index a3c5e9a7..0d9a2962 100644 --- 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 index 4c5e2d7b..6af1ecbf 100644 --- 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 index ada7fca9..d3c81d83 100644 --- 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 index 841cffe6..33fc80f5 100644 --- 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 index 71d30038..e6616ab0 100644 --- 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 index 114e1b60..400c0a15 100644 --- 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); diff --git a/src/Issue/IssueStatus.php b/src/Issue/IssueStatus.php index 9d40eeac..aa8f0d81 100644 --- 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 index 4fa23587..5c3b83dd 100644 --- 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 index a0750d69..8eda0488 100644 --- 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 index 6039b091..08b15a52 100644 --- 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 index 850e8940..90d62e4d 100644 --- 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 index 140731af..fa95dcdc 100644 --- a/src/Issue/Reporter.php +++ b/src/Issue/Reporter.php @@ -42,7 +42,7 @@ class Reporter implements \JsonSerializable public string $accountType; #[\ReturnTypeWillChange] - public function jsonSerialize() + public function jsonSerialize(): ?array { $vars = (get_object_vars($this)); diff --git a/src/Issue/SecurityScheme.php b/src/Issue/SecurityScheme.php index 8d7975fd..1ae4d5b6 100644 --- 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 index 49df0102..cc9ec806 100644 --- 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 json_encode, + * @return array data which can be serialized by json_encode, * 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 index b0a8cd13..4f5eb964 100644 --- 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 index 13606676..eb3b23a6 100644 --- 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 index 1b468a8a..e50b2699 100644 --- 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 index e0305c7e..a3368b96 100644 --- 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 index 46764567..5069205a 100644 --- 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 index 54451942..ddb0c6e5 100644 --- 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 index 3b5db0ad..e9133ac0 100644 --- 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 index ed003cad..0b79fb52 100644 --- 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 index ad478bce..848507d3 100644 --- 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 index 23e41b21..e66db698 100644 --- 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 index d4c6431a..e224b38b 100644 --- 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 index 9d7d1e1b..7fb8ead2 100644 --- 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; diff --git a/src/Status/Status.php b/src/Status/Status.php index 5eef04ca..aca044f1 100644 --- a/src/Status/Status.php +++ b/src/Status/Status.php @@ -14,7 +14,7 @@ class Status implements \JsonSerializable public ?string $description = null; #[\ReturnTypeWillChange] - public function jsonSerialize() + public function jsonSerialize(): array { return array_filter(get_object_vars($this)); } diff --git a/src/User/User.php b/src/User/User.php index 500f1df1..81954714 100644 --- a/src/User/User.php +++ b/src/User/User.php @@ -12,7 +12,7 @@ class User extends Reporter { #[\ReturnTypeWillChange] - public function jsonSerialize() + public function jsonSerialize(): array { return array_filter(get_object_vars($this)); }