mirror of
https://github.com/sp-tarkov/forge.git
synced 2025-02-13 04:30:41 -05:00
Refringe
2cca45bcea
Part of moving back to PHPStan level 5 means we can remove some of these. They're very busy and don't give enough context to outweigh the ugly.
45 lines
2.2 KiB
PHP
45 lines
2.2 KiB
PHP
<?php
|
|
|
|
namespace App\Http\Controllers\Api\V0;
|
|
|
|
use App\Http\Filters\V1\UserFilter;
|
|
use App\Http\Resources\Api\V0\UserResource;
|
|
use App\Models\User;
|
|
use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
|
|
use Illuminate\Http\Resources\Json\JsonResource;
|
|
use Knuckles\Scribe\Attributes\QueryParam;
|
|
|
|
class UsersController extends ApiController
|
|
{
|
|
/**
|
|
* Get Users
|
|
*
|
|
* List, filter, and sort basic information about users.
|
|
*
|
|
* @group Users
|
|
*/
|
|
#[QueryParam('include', 'string', 'The relationships to include within the `includes` key. By default no relationships are automatically included.', required: false, example: 'user_role')]
|
|
#[QueryParam('filter[id]', 'string', 'Filter by the `id`. Select multiple by separating the IDs with a comma.', required: false, example: '5,10,15')]
|
|
#[QueryParam('filter[name]', 'string', 'Filter by the `name` attribute. Use `*` as the wildcard character.', required: false, example: '*fringe')]
|
|
#[QueryParam('filter[created_at]', 'string', 'Filter by the `created_at` attribute. Ranges are possible by separating the dates with a comma.', required: false, example: '2023-12-31,2024-12-31')]
|
|
#[QueryParam('filter[updated_at]', 'string', 'Filter by the `updated_at` attribute. Ranges are possible by separating the dates with a comma.', required: false, example: '2023-12-31,2024-12-31')]
|
|
#[QueryParam('sort', 'string', 'Sort the results by a comma seperated list of attributes. The default sort direction is ASC, append the attribute name with a minus to sort DESC.', required: false, example: 'created_at,-name')]
|
|
public function index(UserFilter $filters): AnonymousResourceCollection
|
|
{
|
|
return UserResource::collection(User::filter($filters)->paginate());
|
|
}
|
|
|
|
/**
|
|
* Get User
|
|
*
|
|
* Display more detailed information about a specific user.
|
|
*
|
|
* @group Users
|
|
*/
|
|
#[QueryParam('include', 'string', 'The relationships to include within the `includes` key. By default no relationships are automatically included.', required: false, example: 'user_role')]
|
|
public function show(User $user): JsonResource
|
|
{
|
|
return new UserResource($user);
|
|
}
|
|
}
|