LoanController
class LoanController extends Controller (View source)
Controller responsible for managing loans (CRUD operations).
Provides endpoints to list, create, retrieve, extend, and finalize loans.
Traits
Trait JsonResponseTrait.
Provides standardized and safe error logging with UTF-8 encoding, sensitive data masking, and controlled stack traces.
Methods
Return a 200 OK JSON response.
Return a 201 Created JSON response.
Return a 202 Accepted JSON response (request accepted for processing).
Return a 205 Reset Content JSON response.
Return a 400 Bad Request JSON response.
Return a 401 Unauthorized JSON response.
Return a 403 Forbidden JSON response.
Return a 404 Not Found JSON response.
Return a 409 Conflict JSON response.
Return a 422 Unprocessable Entity JSON response for validation errors.
Return a 429 Too Many Requests JSON response.
Return a 500 Internal Server Error JSON response.
Logs an error with consistent formatting and context.
Masks common sensitive fields (e.g., passwords, tokens) in the given context array.
Recursively converts all string values to UTF-8.
Returns a string representation of the exception trace, limited to the given number of lines.
Paginate query results dynamically using cursor pagination.
Retrieve a paginated list of loans with optional search terms and filters.
Retrieve a specific loan by its UUID.
Find a loan by its barcode.
Extend a loan by a configurable number of days.
Finalize a loan by setting the returned date to today.
Details
protected JsonResponse
successResponse(array $data = [])
Return a 200 OK JSON response.
protected JsonResponse
createdResponse(array $data = [])
Return a 201 Created JSON response.
protected JsonResponse
acceptedResponse()
Return a 202 Accepted JSON response (request accepted for processing).
protected JsonResponse
noContentResponse()
Return a 204 No Content JSON response.
protected JsonResponse
resetContentResponse()
Return a 205 Reset Content JSON response.
protected JsonResponse
badRequestResponse(array $errors)
Return a 400 Bad Request JSON response.
protected JsonResponse
unauthorizedResponse(string $message = 'Não autorizado.')
Return a 401 Unauthorized JSON response.
protected JsonResponse
forbiddenResponse(string $message = 'Acesso negado.')
Return a 403 Forbidden JSON response.
protected JsonResponse
notFoundResponse(string $message = 'Recurso não encontrado.')
Return a 404 Not Found JSON response.
protected JsonResponse
conflictResponse(array $errors)
Return a 409 Conflict JSON response.
protected JsonResponse
validationErrorResponse(array $errors)
Return a 422 Unprocessable Entity JSON response for validation errors.
protected JsonResponse
tooManyRequestsResponse(string $message = 'Muitas requisições. Tente novamente mais tarde.')
Return a 429 Too Many Requests JSON response.
protected JsonResponse
internalErrorResponse(Throwable $e, string $message = 'Erro interno.')
Return a 500 Internal Server Error JSON response.
Logs the exception and returns a standardized JSON error message.
protected void
logError(string $message, Throwable $exception, array $context = [], string|null $channel = null)
Logs an error with consistent formatting and context.
protected array
sanitizeSensitiveData(array $data)
Masks common sensitive fields (e.g., passwords, tokens) in the given context array.
protected array
encodeStringsUtf8(array $data)
Recursively converts all string values to UTF-8.
protected string
getLimitedTrace(Throwable $exception, int $maxLines = 10)
Returns a string representation of the exception trace, limited to the given number of lines.
CursorPaginator
paginateWithSettings(Builder $query, Request $request, int $maxLimit = 250)
Paginate query results dynamically using cursor pagination.
JsonResponse
index(Request $request)
Retrieve a paginated list of loans with optional search terms and filters.
This endpoint processes the incoming request, applies search keywords, filters, and pagination rules, and returns a structured JSON payload containing the resulting dataset, pagination cursors, and filter metadata used to build the dynamic UI.
JsonResponse
store(LoanStoreRequest $request)
Create a new loan for a student and a book copy.
Steps:
- Validates the request
- Checks student, book, and copy existence and availability
- Checks borrow permissions
- Creates the loan record in a transaction
- Dispatches asynchronous printing of receipt
JsonResponse
show(string $id)
Retrieve a specific loan by its UUID.
JsonResponse
findByBarcode(string $barcode)
Find a loan by its barcode.
Validates the provided barcode and returns basic loan information if found.
JsonResponse
extend(string $id)
Extend a loan by a configurable number of days.
JsonResponse
finalize(string $id)
Finalize a loan by setting the returned date to today.