Merge branch 'release/7.1.0'

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,17 @@ All notable changes to this project will be documented in this file. This projec
 
 ## Unreleased
 
+## [7.1.0] - 2025-01-11
+
+### Changed
+
+- Removed PHP 8.4 deprecation notices.
+
+### Fixed
+
+- [#648](https://github.com/cloudcreativity/laravel-json-api/pull/648) Ensure self link is removed when it is returned
+  as `false`.
+
 ## [7.0.0] - 2024-03-14
 
 ### Changed
@@ -39,7 +50,7 @@ All notable changes to this project will be documented in this file. This projec
 
 - **BREAKING** Upgraded the `neomerx/json-api` dependency from `v1` to `v5` of our fork
   `laravel-json-api/neomerx-json-api`. Refer to the [Upgrade Guide](./docs/upgrade.md) for details of the required
-  changes.  
+  changes.
 
 ## [4.1.0] - 2023-01-21
 

composer.json

@@ -24,7 +24,7 @@
     "require": {
         "php": "^8.2",
         "ext-json": "*",
-        "laravel-json-api/neomerx-json-api": "^5.0.2",
+        "laravel-json-api/neomerx-json-api": "^5.0.3",
         "laravel/framework": "^11.0",
         "nyholm/psr7": "^1.8",
         "ramsey/uuid": "^4.0",

docs/basics/schemas.md

@@ -392,9 +392,9 @@ class Schema extends SchemaProvider
 {
     // ...
 
-    public function getResourceLinks($resource): ?array
+    public function getResourceLinks($resource): iterable
     {
-        return null;
+        return ['self' => false];
     }
 }
 ```

src/Api/Repository.php

@@ -72,7 +72,7 @@ public function exists($apiName)
      *      route parameters, if needed.
      * @return Api
      */
-    public function createApi(string $apiName, string $host = null, array $parameters = [])
+    public function createApi(string $apiName, ?string $host = null, array $parameters = [])
     {
         $config = $this->configFor($apiName);
         $config = $this->normalize($config, $host);

src/Broadcasting/BroadcastsData.php

@@ -51,7 +51,7 @@ protected function broadcastEncoder()
      * @param array|null $fieldsets
      * @return array
      */
-    protected function serializeData($data, $includePaths = null, array $fieldsets = null)
+    protected function serializeData($data, $includePaths = null, ?array $fieldsets = null)
     {
         $params = new QueryParameters($includePaths ? (array) $includePaths : null, $fieldsets);
 

src/Client/AbstractClient.php

@@ -72,7 +72,7 @@ abstract class AbstractClient implements ClientInterface
     abstract protected function request(
         $method,
         $uri,
-        array $payload = null,
+        ?array $payload = null,
         array $parameters = []
     );
 

src/Client/GuzzleClient.php

@@ -60,7 +60,7 @@ public function __construct(
     protected function request(
         $method,
         $uri,
-        array $payload = null,
+        ?array $payload = null,
         array $parameters = []
     ) {
         $request = new Request($method, $uri);

src/Codec/Encoding.php

@@ -54,7 +54,7 @@ class Encoding
     public static function create(
         $mediaType,
         int $options = 0,
-        string $urlPrefix = null,
+        ?string $urlPrefix = null,
         int $depth = 512
     ): self
     {
@@ -73,7 +73,7 @@ public static function create(
      * @param int $depth
      * @return Encoding
      */
-    public static function jsonApi(int $options = 0, string $urlPrefix = null, int $depth = 512): self
+    public static function jsonApi(int $options = 0, ?string $urlPrefix = null, int $depth = 512): self
     {
         return self::create(
             MediaTypeInterface::JSON_API_MEDIA_TYPE,
@@ -104,7 +104,7 @@ public static function custom($mediaType): self
      * @param string|null $urlPrefix
      * @return Encoding
      */
-    public static function fromArray($key, $value, string $urlPrefix = null): self
+    public static function fromArray($key, $value, ?string $urlPrefix = null): self
     {
         if (is_numeric($key)) {
             $key = $value;

src/Codec/EncodingList.php

@@ -47,7 +47,7 @@ class EncodingList implements IteratorAggregate, Countable
      * @param string|null $urlPrefix
      * @return EncodingList
      */
-    public static function fromArray(iterable $config, string $urlPrefix = null): self
+    public static function fromArray(iterable $config, ?string $urlPrefix = null): self
     {
         $values = Collection::make($config)
             ->map(fn($value, $key) => Encoding::fromArray($key, $value, $urlPrefix))

src/Container.php

@@ -379,7 +379,7 @@ protected function getCreatedAdapter($resourceType)
      * @param ResourceAdapterInterface|null $adapter
      * @return void
      */
-    protected function setCreatedAdapter($resourceType, ResourceAdapterInterface $adapter = null)
+    protected function setCreatedAdapter($resourceType, ?ResourceAdapterInterface $adapter = null)
     {
         $this->createdAdapters[$resourceType] = $adapter;
     }
@@ -467,7 +467,7 @@ protected function getCreatedAuthorizer($resourceType)
      * @param AuthorizerInterface|null $authorizer
      * @return void
      */
-    protected function setCreatedAuthorizer($resourceType, AuthorizerInterface $authorizer = null)
+    protected function setCreatedAuthorizer($resourceType, ?AuthorizerInterface $authorizer = null)
     {
         $this->createdAuthorizers[$resourceType] = $authorizer;
     }

src/Contracts/Schema/SchemaProviderInterface.php

@@ -78,7 +78,7 @@ public function getRelationships(object $resource, bool $isPrimary, array $inclu
      * @param object|null $resource
      * @return string
      */
-    public function getSelfSubUrl(object $resource = null): string;
+    public function getSelfSubUrl(?object $resource = null): string;
 
     /**
      * Get the resource self sub link.

src/Document/Error/Error.php

@@ -134,12 +134,12 @@ public static function fromArray(array $input): self
     public function __construct(
         $id = null,
         $status = null,
-        string $code = null,
-        string $title = null,
-        string $detail = null,
-        iterable $source = null,
-        iterable $links = null,
-        iterable $meta = null
+        ?string $code = null,
+        ?string $title = null,
+        ?string $detail = null,
+        ?iterable $source = null,
+        ?iterable $links = null,
+        ?iterable $meta = null
     )
     {
         $this->setId($id);

src/Document/Error/Translator.php

@@ -17,6 +17,7 @@
 
 namespace CloudCreativity\LaravelJsonApi\Document\Error;
 
+use Closure;
 use CloudCreativity\LaravelJsonApi\Exceptions\ValidationException;
 use CloudCreativity\LaravelJsonApi\LaravelJsonApi;
 use CloudCreativity\LaravelJsonApi\Utils\Str;
@@ -402,7 +403,7 @@ public function resourceFieldExistsInAttributesAndRelationships(
      * @param string|null $detail
      * @return ErrorInterface
      */
-    public function resourceCannotBeDeleted(string $detail = null): ErrorInterface
+    public function resourceCannotBeDeleted(?string $detail = null): ErrorInterface
     {
         return new NeomerxError(
             null,
@@ -475,11 +476,11 @@ public function invalidQueryParameter(string $param, ?string $detail = null, arr
      * Create errors for a failed validator.
      *
      * @param ValidatorContract $validator
-     * @param \Closure|null $closure
+     * @param Closure|null $closure
      *      a closure that is bound to the translator.
      * @return ErrorCollection
      */
-    public function failedValidator(ValidatorContract $validator, \Closure $closure = null): ErrorCollection
+    public function failedValidator(ValidatorContract $validator, ?Closure $closure = null): ErrorCollection
     {
         $failed = $this->doesIncludeFailed() ? $validator->failed() : [];
         $errors = new ErrorCollection();
@@ -513,12 +514,12 @@ public function failedValidator(ValidatorContract $validator, \Closure $closure
      * Create a JSON API exception for a failed validator.
      *
      * @param ValidatorContract $validator
-     * @param \Closure|null $closure
+     * @param Closure|null $closure
      * @return JsonApiException
      */
     public function failedValidatorException(
         ValidatorContract $validator,
-        \Closure $closure = null
+        ?Closure $closure = null
     ): JsonApiException
     {
         return new ValidationException(
@@ -529,11 +530,11 @@ public function failedValidatorException(
     /**
      * Create an error by calling the closure with it bound to the error translator.
      *
-     * @param \Closure $closure
+     * @param Closure $closure
      * @param mixed ...$args
      * @return ErrorInterface
      */
-    public function call(\Closure $closure, ...$args): ErrorInterface
+    public function call(Closure $closure, ...$args): ErrorInterface
     {
         return $closure->call($this, ...$args);
     }

src/Eloquent/AbstractAdapter.php

@@ -17,6 +17,7 @@
 
 namespace CloudCreativity\LaravelJsonApi\Eloquent;
 
+use Closure;
 use CloudCreativity\LaravelJsonApi\Adapter\AbstractResourceAdapter;
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\HasManyAdapterInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Adapter\RelationshipAdapterInterface;
@@ -115,7 +116,7 @@ abstract protected function filter($query, Collection $filters);
      * @param Model $model
      * @param PagingStrategyInterface|null $paging
      */
-    public function __construct(Model $model, PagingStrategyInterface $paging = null)
+    public function __construct(Model $model, ?PagingStrategyInterface $paging = null)
     {
         $this->model = $model;
         $this->paging = $paging;
@@ -259,11 +260,11 @@ public function addScopes(Scope ...$scopes): self
     /**
      * Add a global scope using a closure.
      *
-     * @param \Closure $scope
+     * @param Closure $scope
      * @param string|null $identifier
      * @return $this
      */
-    public function addClosureScope(\Closure $scope, string $identifier = null): self
+    public function addClosureScope(Closure $scope, ?string $identifier = null): self
     {
         $identifier = $identifier ?: spl_object_hash($scope);
 
@@ -616,20 +617,20 @@ protected function morphMany(HasManyAdapterInterface ...$adapters)
     }
 
     /**
-     * @param \Closure $factory
+     * @param Closure $factory
      *      a factory that creates a new Eloquent query builder.
      * @return QueriesMany
      */
-    protected function queriesMany(\Closure $factory)
+    protected function queriesMany(Closure $factory)
     {
         return new QueriesMany($factory);
     }
 
     /**
-     * @param \Closure $factory
+     * @param Closure $factory
      * @return QueriesOne
      */
-    protected function queriesOne(\Closure $factory)
+    protected function queriesOne(Closure $factory)
     {
         return new QueriesOne($factory);
     }

src/Encoder/EncoderOptions.php

@@ -43,7 +43,7 @@ class EncoderOptions
      * @param string|null $urlPrefix
      * @param int $depth
      */
-    public function __construct(int $options = 0, string $urlPrefix = null, int $depth = 512)
+    public function __construct(int $options = 0, ?string $urlPrefix = null, int $depth = 512)
     {
         $this->options   = $options;
         $this->depth     = $depth;

src/Exceptions/ClientException.php

@@ -17,6 +17,7 @@
 
 namespace CloudCreativity\LaravelJsonApi\Exceptions;
 
+use Exception;
 use Illuminate\Support\Collection;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -50,12 +51,12 @@ class ClientException extends \RuntimeException
      *
      * @param RequestInterface $request
      * @param ResponseInterface|null $response
-     * @param \Exception|null $previous
+     * @param Exception|null $previous
      */
     public function __construct(
         RequestInterface $request,
-        ResponseInterface $response = null,
-        \Exception $previous = null
+        ?ResponseInterface $response = null,
+        ?Exception $previous = null
     ) {
         parent::__construct(
             $previous ? $previous->getMessage() : 'Client encountered an error.',
@@ -104,7 +105,7 @@ public function getErrors()
 
         try {
             $this->errors = $this->parse();
-        } catch (\Exception $ex) {
+        } catch (Exception $ex) {
             $this->errors = [];
         }
 

src/Exceptions/DocumentRequiredException.php

@@ -35,7 +35,7 @@ class DocumentRequiredException extends InvalidJsonException
      *
      * @param Exception|null $previous
      */
-    public function __construct(Exception $previous = null)
+    public function __construct(?Exception $previous = null)
     {
         parent::__construct(
             null,

src/Exceptions/InvalidJsonException.php

@@ -44,7 +44,7 @@ class InvalidJsonException extends JsonApiException
      * @param Exception|null $previous
      * @return InvalidJsonException
      */
-    public static function create($defaultHttpCode = self::HTTP_CODE_BAD_REQUEST, Exception $previous = null)
+    public static function create($defaultHttpCode = self::HTTP_CODE_BAD_REQUEST, ?Exception $previous = null)
     {
         return new self(json_last_error(), json_last_error_msg(), $defaultHttpCode, $previous);
     }
@@ -61,7 +61,7 @@ public function __construct(
         $jsonError = null,
         $jsonErrorMessage = null,
         $defaultHttpCode = self::HTTP_CODE_BAD_REQUEST,
-        Exception $previous = null
+        ?Exception $previous = null
     ) {
         parent::__construct([], $defaultHttpCode, $previous);
 

src/Exceptions/JsonApiException.php

@@ -46,7 +46,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);
     }
@@ -58,7 +58,7 @@ public static function make($errors, 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 = Errors::cast($errors);