codebar-ag/formrequests

Form Requests

When to Use

• For controller endpoints that accept user input and need validation + authorization.
• When you want reusable, testable validation outside controllers.
• When localized or domain-specific validation messages are required.

When NOT to Use

• For read-only endpoints with no user input to validate.
• For internal-only workflows that do not pass through HTTP controllers.
• For cross-cutting protocol checks better handled in middleware (for example signature headers).

Rules

• Every controller action that accepts user input must use a dedicated FormRequest class (keeps controllers thin and validations testable)
• Never call $request->validate() or Validator::make() inside a controller (avoid duplicated inline rules)
• Place Form Requests in app/Http/Requests/ or a subdirectory matching the domain (e.g. Auth/)
• Naming pattern: Store{Resource}Request, Update{Resource}Request
• Match the resource name to the controller: StoreSprintController → StoreSprintRequest
• Define authorize(): bool with proper authorization logic — never leave it as a passive return true without intention
• Define rules(): array with a PHPDoc @return array shape
• Use array-based rule definitions, not pipe-delimited strings
• Add messages(): array when validation messages need localization or extra clarity
• Prefer $this->user() over global helpers for request-bound auth access inside authorize() and rules()

Examples

use Illuminate\Validation\Rule;

class StoreSprintRequest extends FormRequest
{
    public function authorize(): bool
    {
        return $this->user() !== null;
    }

    /**
     * @return array<string, array<int, string|object>>
     */
    public function rules(): array
    {
        return [
            'title'  => ['required', 'string', 'max:255'],
            'locale' => ['required', Locale::validationRule()],
            'billing_code' => Rule::when(
                $this->user()?->isAdmin() === true,
                ['required', 'string', 'max:50'],
                ['nullable']
            ),
        ];
    }

    public function messages(): array
    {
        return [
            'title.required' => __('A title is required.'),
        ];
    }
}

// Controller usage — inject the FormRequest
class StoreSprintController extends Controller
{
    public function __invoke(StoreSprintRequest $request, CreateSprint $action): JsonResponse
    {
        $sprint = $action->execute($request->validated());

        return new JsonResponse(new SprintResource($sprint), 201);
    }
}

// Authorization using a policy
public function authorize(): bool
{
    return $this->user()->can('create', Post::class);
}

// Scoped to an admin role
public function authorize(): bool
{
    return $this->user()->isAdmin();
}

Anti-Patterns

• Calling $request->validate() inside a controller — always use a FormRequest
• Using pipe-delimited rule strings: 'required|string|max:255' instead of ['required', 'string', 'max:255']
• Leaving authorize() as return true without documenting why all users are permitted
• Not adding a messages() method for user-facing validation errors that need clarity

References

• Laravel Form Requests
• Related: Controllers/SKILL.md — controllers that use Form Requests
• Related: Policies/SKILL.md — can() used in authorize() method