Routing Attributes Reference

PHP 8.1+ attributes for declaring routes on controllers.

Route

Base route prefix for a controller:

use Nexphant\Route;

#[Route('/api/users')]
class UserController { }

Get

use Nexphant\Get;

#[Get('/')]
public function index(): array { }

#[Get('/{id}')]
public function show(int $id): array { }

Post

use Nexphant\Post;

#[Post('/')]
public function store(Request $request): array { }

Put

use Nexphant\Put;

#[Put('/{id}')]
public function replace(Request $request, int $id): array { }

Patch

use Nexphant\Patch;

#[Patch('/{id}')]
public function update(Request $request, int $id): array { }

Delete

use Nexphant\Delete;

#[Delete('/{id}')]
public function destroy(int $id): array { }

Combined Example

#[Route('/api/users')]
class UserController
{
    #[Get('/')]
    public function index(): array { return DB::table('users')->get(); }

    #[Post('/')]
    public function store(Request $req): array { /* ... */ }

    #[Patch('/{id}')]
    public function update(Request $req, int $id): array { /* ... */ }

    #[Delete('/{id}')]
    public function destroy(int $id): array { return ['deleted' => true]; }
}