[11.x] Introduce RouteParameter attribute

[bastien-phi]

Accessing route parameter outside the Controller, in the FormRequest for example, can be done in various ways. In order to have correct IDE completion and good static analysis, we can do :

class UpdatePost extends FormRequest
{
    public function authorize(#[CurrentUser] User $user): bool
    {
        /** @var Post $post */
        $post = $this->route('post');
        
        return $post->user_id === $user->id;
    }
    
    public function rules(): array
    {
        /** @var Post $post */
        $post = $this->route('post');

        return [
            'slug' => ['required', 'string', Rule::unique(Post::class, 'slug')->ignore($post->id);
            // ...
        ];
    }
}

/** 
 * @property-read Post $post
 */
class UpdatePost extends FormRequest
{
    public function authorize(#[CurrentUser] User $user): bool
    {
        return $this->post->user_id === $user->id;
    }
    
    public function rules(): array
    {
        return [
            'slug' => ['required', 'string', Rule::unique(Post::class, 'slug')->ignore($this->post->id);
            // ...
        ];
    }
}

Both ways feel a bit tricky to me and not very elegant IMHO.

That's why I propose the introduction of the RouteParameter attribute which can streamline the syntax, leveraging existing ContextualAttribute and the container :

class UpdatePost extends FormRequest
{
    public function authorize(#[CurrentUser] User $user, #[RouteParameter('post')] Post $post): bool
    {
        return $post->user_id === $user->id;
    }
    
    public function rules(#[RouteParameter('post')] Post $post): array
    {
        return [
            'slug' => ['required', 'string', Rule::unique(Post::class, 'slug')->ignore($post->id);
            // ...
        ];
    }
}

The attribute can be used on any type of route parameter : Model, enum, string, ...

[bastien-phi]

Thanks !

[andrey-helldar]

Everything is great, but it lacks support for the prepareForValidation method:

Declaration of App\Http\Requests\Private\Contest\UpdateRequest::prepareForValidation(App\Models\Contest $contest): void
must be compatible with Illuminate\Foundation\Http\FormRequest::prepareForValidation() 

class UpdateRequest extends Request
{
    public function rules(#[RouteParameter('contest')] Contest $contest): array
    {
        return [
            // some rules
        ];
    }

    protected function prepareForValidation(#[RouteParameter('contest')] Contest $contest): void
    {
        $this->merge([
            'slug' => $this->firstOrSecond('slug', 'title'),
        ]);

        $this->mergeIfMissing([
            'params' => [
                'winnersCount' => $contest->params?->winnersCount
                    ?? DefaultCount::WINNERS,

                'audienceWinnersCount' => $contest->params?->audienceWinnersCount
                    ?? DefaultCount::AUDIENCE_WINNERS,
            ],
        ]);
    }
}

Crutch for that:

class UpdateRequest extends Request
{
    public function rules(#[RouteParameter('contest')] Contest $contest): array
    {
        return [
            // some rules
        ];
    }

    protected function prepareForValidation(): void
    {
        $this->merge([
            'slug' => $this->firstOrSecond('slug', 'title'),
        ]);

        /** @var Contest $contest */
        $contest = $this->route('contest');

        $this->mergeIfMissing([
            'params' => [
                'winnersCount' => $contest->params?->winnersCount
                    ?? DefaultCount::WINNERS,

                'audienceWinnersCount' => $contest->params?->audienceWinnersCount
                    ?? DefaultCount::AUDIENCE_WINNERS,
            ],
        ]);
    }
}