fix: remove deprecation notices in php 8.4

Author: lindyhopchris

.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [8.2, 8.3]
+        php: [8.2, 8.3, 8.4]
         laravel: [11]
 
     steps:

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. This projec
 
 ## Unreleased
 
+### Fixed
+
+- Removed deprecation notices in PHP 8.4.
+
 ## [4.2.0] - 2024-08-21
 
 ### Added

phpunit.xml

@@ -13,6 +13,7 @@
          failOnWarning="true"
          failOnDeprecation="true"
          failOnNotice="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
 >
   <coverage/>
   <testsuites>

src/Contracts/Schema/Schema.php

@@ -72,7 +72,7 @@ public function uriType(): string;
      * @param bool|null $secure
      * @return string
      */
-    public function url($extra = [], bool $secure = null): string;
+    public function url($extra = [], ?bool $secure = null): string;
 
     /**
      * Do resources of this type have a `self` link?

src/Contracts/Server/Server.php

@@ -74,5 +74,5 @@ public function authorizable(): bool;
      * @param bool|null $secure
      * @return string
      */
-    public function url($extra = [], bool $secure = null): string;
+    public function url($extra = [], ?bool $secure = null): string;
 }

src/Core/Document/JsonApi.php

@@ -34,7 +34,7 @@ class JsonApi implements Serializable
      * @param string|null $version
      * @return JsonApi
      */
-    public static function make(string $version = null): self
+    public static function make(?string $version = null): self
     {
         return new self($version);
     }
@@ -113,7 +113,7 @@ public static function nullable($value): ?self
      *
      * @param string|null $version
      */
-    public function __construct(string $version = null)
+    public function __construct(?string $version = null)
     {
         $this->version = $version ?: null;
     }

src/Core/Document/LinkHref.php

@@ -56,7 +56,7 @@ public static function cast($value): self
      * @param string $uri
      * @param iterable|null $query
      */
-    public function __construct(string $uri, iterable $query = null)
+    public function __construct(string $uri, ?iterable $query = null)
     {
         if (empty($uri)) {
             throw new UnexpectedValueException('Expecting a non-empty string URI.');

src/Core/Exceptions/JsonApiException.php

@@ -38,7 +38,7 @@ class JsonApiException extends Exception implements HttpExceptionInterface, Resp
      * @param Throwable|null $previous
      * @return static
      */
-    public static function make($errors, Throwable $previous = null): self
+    public static function make($errors, ?Throwable $previous = null): self
     {
         return new self($errors, $previous);
     }
@@ -50,7 +50,7 @@ public static function make($errors, Throwable $previous = null): self
      * @param Throwable|null $previous
      * @return static
      */
-    public static function error($error, Throwable $previous = null): self
+    public static function error($error, ?Throwable $previous = null): self
     {
         return new self(Error::cast($error), $previous);
     }
@@ -62,7 +62,7 @@ public static function error($error, Throwable $previous = null): self
      * @param Throwable|null $previous
      * @param array $headers
      */
-    public function __construct($errors, Throwable $previous = null, array $headers = [])
+    public function __construct($errors, ?Throwable $previous = null, array $headers = [])
     {
         parent::__construct('JSON:API error', 0, $previous);
         $this->errors = ErrorList::cast($errors);

src/Core/Json/Hash.php

@@ -55,7 +55,7 @@ public static function cast($value): self
      *
      * @param array|null $value
      */
-    public function __construct(array $value = null)
+    public function __construct(?array $value = null)
     {
         $this->value = $value ?: [];
     }

src/Core/Query/Custom/ExtendedQueryParameters.php

@@ -34,7 +34,7 @@ class ExtendedQueryParameters extends QueryParameters
      * @param string|null $name
      * @return string
      */
-    public static function withCount(string $name = null): string
+    public static function withCount(?string $name = null): string
     {
         if (empty($name)) {
             return self::$withCount;
@@ -59,12 +59,12 @@ public static function withCount(string $name = null): string
      * @param array|null $unrecognised
      */
     public function __construct(
-        IncludePaths $includePaths = null,
-        FieldSets $fieldSets = null,
-        SortFields $sortFields = null,
-        array $page = null,
-        FilterParameters $filters = null,
-        array $unrecognised = null
+        ?IncludePaths $includePaths = null,
+        ?FieldSets $fieldSets = null,
+        ?SortFields $sortFields = null,
+        ?array $page = null,
+        ?FilterParameters $filters = null,
+        ?array $unrecognised = null
     ) {
         parent::__construct(
             $includePaths,

src/Core/Query/QueryParameters.php

@@ -158,12 +158,12 @@ public static function nullable($value): ?self
      * @param array|null $unrecognised
      */
     public function __construct(
-        IncludePaths $includePaths = null,
-        FieldSets $fieldSets = null,
-        SortFields $sortFields = null,
-        array $page = null,
-        FilterParameters $filters = null,
-        array $unrecognised = null
+        ?IncludePaths $includePaths = null,
+        ?FieldSets $fieldSets = null,
+        ?SortFields $sortFields = null,
+        ?array $page = null,
+        ?FilterParameters $filters = null,
+        ?array $unrecognised = null
     ) {
         $this->includePaths = $includePaths;
         $this->fieldSets = $fieldSets;

src/Core/Resources/JsonApiResource.php

@@ -309,7 +309,7 @@ protected function identifierMeta(): array
      * @param string|null $keyName
      * @return Relation
      */
-    protected function relation(string $fieldName, string $keyName = null): Relation
+    protected function relation(string $fieldName, ?string $keyName = null): Relation
     {
         $field = $this->schema->isRelationship($fieldName) ? $this->schema->relationship($fieldName) : null;
 

src/Core/Resources/Relation.php

@@ -91,8 +91,8 @@ public function __construct(
         object $resource,
         ?string $baseUri,
         string $fieldName,
-        string $keyName = null,
-        string $uriName = null
+        ?string $keyName = null,
+        ?string $uriName = null
     ) {
         $this->resource = $resource;
         $this->baseUri = $baseUri;

src/Core/Responses/Concerns/IsResponsable.php

@@ -143,7 +143,7 @@ public function withEncodeOptions(int $options): self
      * @param string|null $value
      * @return $this
      */
-    public function withHeader(string $name, string $value = null): self
+    public function withHeader(string $name, ?string $value = null): self
     {
         $this->headers[$name] = $value;
 

src/Core/Schema/IdParser.php

@@ -44,7 +44,7 @@ public static function encoder($value): IdEncoderContract
      * @param ID|null $field
      * @return static
      */
-    public static function make(ID $field = null): self
+    public static function make(?ID $field = null): self
     {
         return new self($field);
     }

src/Core/Server/Server.php

@@ -159,7 +159,7 @@ public function authorizable(): bool
     /**
      * @inheritDoc
      */
-    public function url($extra = [], bool $secure = null): string
+    public function url($extra = [], ?bool $secure = null): string
     {
         $tail = Collection::make(Arr::wrap($extra))
             ->map(fn($value) => ($value instanceof UrlRoutable) ? $value->getRouteKey() : $value)