Added missing relation as argument for hook methods

[aimeos]

For both hooks, readRelated{name} and readingRelated{name}, it seems to be impossible to create an appropriate response at the moment because both hooks are called without $relation which is required for constructing the response:

laravel/src/Http/Controllers/Actions/FetchRelated.php

Lines 76 to 83 in 91d8e0c

	$response = $this->{$hook}($model, $data, $request);
	}
	return $response ?: RelatedResponse::make(
	$model,
	$relation->name(),
	$data,
	)->withQueryParameters($request);

[lindyhopchris]

@aimeos what is it you need from the relation object? I.e. what methods on that object are you looking to call within your hook?

[aimeos]

Obviously, $relation->name() to build the RelatedResponse:

laravel/src/Http/Controllers/Actions/FetchRelated.php

Line 81 in 91d8e0c

$relation->name(),

[lindyhopchris]

Ok, but you don't need the name from the relation, because it's already in the method name that's being called.

I.e. if the JSON:API field is comments, then the method on the controller being called is readingRelatedComments. So you already know the field name is comments.

So not sure why you'd need to call $relation->name()? Or am I missing something?

[aimeos]

OK, didn't knew that it can be static in that case. It would be great to have example code in the docs what you can do in the hooks, e.g. here and following sections: https://laraveljsonapi.io/docs/3.0/routing/controllers.html#fetch-many-aka-index

public function read( ?Post $post, PageQuery $query ) : DataResponse
{
    return \LaravelJsonApi\Core\Responses\DataResponse::make( $post )
      ->withMeta( ['key' => 'value'] )
      ->withQueryParameters( $query );
}

Or here: https://laraveljsonapi.io/docs/3.0/routing/controllers.html#fetch-related-aka-show-related

public function readingRelatedAuthor(Post $post, UserQuery $query): RelatedResponse
  return \LaravelJsonApi\Core\Responses\RelatedResponse::make( $post, 'author', $data )
      ->withMeta( ['key' => 'value'] )
      ->withQueryParameters( $request );
}

BTW: The docs contains an error because the hook functions must not return void.

[lindyhopchris]

Closing this as I'm not planning on making any changes.

FYI the docs show a return type of void, because you don't have to return anything from a hook method. You could just implement a side-effect, e.g. dispatching a job to the Laravel queue. Obviously if you do return anything from a hook (e.g. a response is a good example), you can type-hint your hook to return that value. (Hooks are not defined on an interface anywhere, so the return type can be anything you want, including void.)