JsonApiResource not able to lazy-load relations

[simon-tma]

Laravel Version

13.9.0 and 12.58.0

PHP Version

8.5.6

Database Driver & Version

No response

Description

The documentation for JsonApiResources contains this example:

/**
 * Get the resource's relationships.
 */
public function toRelationships(Request $request): array
{
    return [
        'author' => UserResource::class,
        'comments' => fn () => CommentResource::collection(
            $request->user()->is($this->resource)
                ? $this->comments
                : $this->comments->where('is_public', true),
        ),
    ];
}

However running this results in:

Illuminate\Http\Resources\JsonApi\RelationResolver::handle(): Return value must be of type Illuminate\Database\Eloquent\Collection|Illuminate\Database\Eloquent\Model|null, Illuminate\Http\Resources\JsonApi\AnonymousResourceCollection returned

Changing the code to just return $this->comments->where('is_public', true) from the closure means there's no way to provide the resource class to use.

Steps To Reproduce

Create a JsonApi resource that uses the code in the documentation

[Sgtp4py]

Résumé de la tâche :
Un utilisateur rencontre une erreur lors de l'utilisation des JsonApiResource dans Laravel (versions 12.58.0 et 13.9.0) pour lazy-loader des relations. Le problème vient du fait que la méthode toRelationships retourne une collection de ressources (AnonymousResourceCollection) alors que Laravel attend une instance d'Eloquent\Collection, Eloquent\Model ou null. L'utilisateur cherche une solution pour appliquer un filtre sur les relations tout en retournant la bonne classe de ressource.

Estimation rapide de faisabilité :
Cette tâche est réalisable techniquement, car elle concerne la correction ou l'amélioration d'un usage spécifique des ressources JSON API dans Laravel. Elle nécessite une bonne connaissance de Laravel, des ressources API et de la gestion des relations Eloquent. La résolution peut être proposée sous forme de correctif de code ou d'explication détaillée.

Réponse / Candidature prête à poster :

Bonjour,

Je comprends votre problème avec la méthode `toRelationships` dans les JsonApiResource de Laravel. L'erreur provient du fait que Laravel attend une instance d'`Eloquent\Collection`, `Eloquent\Model` ou `null`, alors que vous retournez une collection de ressources (`AnonymousResourceCollection`).

Une approche possible est de retourner directement la relation filtrée (une collection Eloquent) dans la closure, et de définir la classe de ressource à utiliser dans la déclaration de la relation, comme suit :

```php
public function toRelationships(Request $request): array
{
    return [
        'author' => UserResource::class,
        'comments' => fn () => $this->comments->where('is_public', true),
    ];
}

Cependant, cela ne permet pas de spécifier la classe de ressource pour les commentaires. Une autre solution est d'utiliser une ressource personnalisée qui applique le filtre dans sa méthode toArray ou de gérer la logique dans le contrôleur avant de passer les données à la ressource.

Je peux vous aider à implémenter une solution adaptée à votre cas, avec un exemple de code fonctionnel et testé.

Pourriez-vous me confirmer si vous souhaitez une intervention rémunérée pour cette assistance ? Je vous fournirai alors un devis adapté.

Cordialement,
[Votre prénom]

**Question de paiement :**  
Souhaitez-vous une prestation rémunérée pour la résolution complète de ce problème, incluant la mise en place d'un correctif et des tests ?  

---

Je reste disponible pour toute précision.

[simon-tma]

In English?

[boris-glumpler]

I just migrated a project from timacdonald/json-api and am running into this issue.