class SettingController extends Controller (View source)

Controller responsible for rendering settings pages and their sections.

This controller provides partial HTML views consumed by the settings panel via asynchronous (AJAX) requests. Each section may optionally support server-side searching and returns either a full section view or a list-only partial depending on the request type.

Traits

AuthorizesRequests
DispatchesJobs
ValidatesRequests

Trait JsonResponseTrait.

Provides standardized and safe error logging with UTF-8 encoding, sensitive data masking, and controlled stack traces.

Methods

JsonResponse
successResponse(array $data = [])

Return a 200 OK JSON response.

JsonResponse
createdResponse(array $data = [])

Return a 201 Created JSON response.

JsonResponse
acceptedResponse()

Return a 202 Accepted JSON response (request accepted for processing).

JsonResponse
noContentResponse()

Return a 204 No Content JSON response.

JsonResponse
resetContentResponse()

Return a 205 Reset Content JSON response.

JsonResponse
badRequestResponse(array $errors)

Return a 400 Bad Request JSON response.

JsonResponse
unauthorizedResponse(string $message = 'Não autorizado.')

Return a 401 Unauthorized JSON response.

JsonResponse
forbiddenResponse(string $message = 'Acesso negado.')

Return a 403 Forbidden JSON response.

JsonResponse
notFoundResponse(string $message = 'Recurso não encontrado.')

Return a 404 Not Found JSON response.

JsonResponse
conflictResponse(array $errors)

Return a 409 Conflict JSON response.

JsonResponse
validationErrorResponse(array $errors)

Return a 422 Unprocessable Entity JSON response for validation errors.

JsonResponse
tooManyRequestsResponse(string $message = 'Muitas requisições. Tente novamente mais tarde.')

Return a 429 Too Many Requests JSON response.

JsonResponse
internalErrorResponse(Throwable $e, string $message = 'Erro interno.')

Return a 500 Internal Server Error JSON response.

void
logError(string $message, Throwable $exception, array $context = [], string|null $channel = null)

Logs an error with consistent formatting and context.

array
sanitizeSensitiveData(array $data)

Masks common sensitive fields (e.g., passwords, tokens) in the given context array.

array
encodeStringsUtf8(array $data)

Recursively converts all string values to UTF-8.

string
getLimitedTrace(Throwable $exception, int $maxLines = 10)

Returns a string representation of the exception trace, limited to the given number of lines.

View
index()

Render the main settings container page.

View
genres(Request $request)

Render the genres settings section.

View
schoolClasses(Request $request)

Render the school classes settings section.

View
users(Request $request)

Render the users settings section.

View
config()

Render the general configuration settings section.

View
services()

Render the services settings section.

Details

protected JsonResponse successResponse(array $data = [])

Return a 200 OK JSON response.

Parameters

array $data

response payload

Return Value

JsonResponse

protected JsonResponse createdResponse(array $data = [])

Return a 201 Created JSON response.

Parameters

array $data

newly created resource data

Return Value

JsonResponse

protected JsonResponse acceptedResponse()

Return a 202 Accepted JSON response (request accepted for processing).

Return Value

JsonResponse

protected JsonResponse noContentResponse()

Return a 204 No Content JSON response.

Return Value

JsonResponse

protected JsonResponse resetContentResponse()

Return a 205 Reset Content JSON response.

Return Value

JsonResponse

protected JsonResponse badRequestResponse(array $errors)

Return a 400 Bad Request JSON response.

Parameters

array $errors

validation or request errors

Return Value

JsonResponse

protected JsonResponse unauthorizedResponse(string $message = 'Não autorizado.')

Return a 401 Unauthorized JSON response.

Parameters

string $message

optional error message

Return Value

JsonResponse

protected JsonResponse forbiddenResponse(string $message = 'Acesso negado.')

Return a 403 Forbidden JSON response.

Parameters

string $message

optional error message

Return Value

JsonResponse

protected JsonResponse notFoundResponse(string $message = 'Recurso não encontrado.')

Return a 404 Not Found JSON response.

Parameters

string $message

optional error message

Return Value

JsonResponse

protected JsonResponse conflictResponse(array $errors)

Return a 409 Conflict JSON response.

Parameters

array $errors

conflict details

Return Value

JsonResponse

protected JsonResponse validationErrorResponse(array $errors)

Return a 422 Unprocessable Entity JSON response for validation errors.

Parameters

array $errors

validation error details

Return Value

JsonResponse

protected JsonResponse tooManyRequestsResponse(string $message = 'Muitas requisições. Tente novamente mais tarde.')

Return a 429 Too Many Requests JSON response.

Parameters

string $message

optional rate limit message

Return Value

JsonResponse

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.

Parameters

Throwable $e

the thrown exception

string $message

optional user-friendly message

Return Value

JsonResponse

protected void logError(string $message, Throwable $exception, array $context = [], string|null $channel = null)

Logs an error with consistent formatting and context.

Parameters

string $message

descriptive error message

Throwable $exception

the thrown exception

array $context

additional context to include in the log

string|null $channel

Optional log channel (e.g., 'classes').

Return Value

void

protected array sanitizeSensitiveData(array $data)

Masks common sensitive fields (e.g., passwords, tokens) in the given context array.

Parameters

array $data

Return Value

array

protected array encodeStringsUtf8(array $data)

Recursively converts all string values to UTF-8.

Parameters

array $data

Return Value

array

protected string getLimitedTrace(Throwable $exception, int $maxLines = 10)

Returns a string representation of the exception trace, limited to the given number of lines.

Parameters

Throwable $exception
int $maxLines

Return Value

string

View index()

Render the main settings container page.

This view acts as the shell for all dynamically loaded settings sections (genres, classes, users, config).

Return Value

View

See also

resources/views/pages/settings/index.blade.php

View genres(Request $request)

Render the genres settings section.

Supports optional server-side searching by genre name or color hex value. When the request is made via AJAX, only the genres list partial is returned; otherwise, the full section view is rendered.

Parameters

Request $request

HTTP request containing optional search parameters.

Return Value

View

See also

resources/views/pages/settings/partials/genres.blade.php
resources/views/pages/settings/partials/genres-list.blade.php

View schoolClasses(Request $request)

Render the school classes settings section.

Supports optional searching by course name. Returns either the full section or a list-only partial when requested via AJAX.

Parameters

Request $request

HTTP request containing optional search parameters.

Return Value

View

See also

resources/views/pages/settings/partials/school-classes.blade.php
resources/views/pages/settings/partials/school-classes-list.blade.php

View users(Request $request)

Render the users settings section.

Supports optional searching by user name or hashed email value. For AJAX requests, only the users list partial is returned to allow dynamic list updates without reloading the entire section.

Parameters

Request $request

HTTP request containing optional search parameters.

Return Value

View

See also

resources/views/pages/settings/partials/users.blade.php
resources/views/pages/settings/partials/users-list.blade.php

View config()

Render the general configuration settings section.

Loads application configuration values stored in the settings table. This section does not support searching or AJAX list updates.

Return Value

View

See also

resources/views/pages/settings/partials/configs.blade.php

View services()

Render the services settings section.

Loads application services for download.

Return Value

View

See also

resources/views/pages/settings/partials/services.blade.php