Neuron-PHP

ApiResponseTrait

Trait providing RFC 9457 Problem Details response methods for API controllers.

Tags

example

class UserApiController extends Base {
    use ApiResponseTrait;

    public function create(Request $request): string {
        $errors = $this->validator->validate($request->getData());

        if ($errors) {
            // Use the trait method for validation errors
            return $this->validationProblem($errors);
        }

        try {
            $user = $this->userService->create($data);
            return $this->renderJson(HttpResponseStatus::CREATED, ['data' => $user]);
        } catch (Exception $e) {
            // Use generic problem response
            return $this->problemResponse(
                ProblemType::INTERNAL_ERROR,
                detail: 'An error occurred while creating the user'
            );
        }
    }
}

Table of Contents

Methods

authenticationProblem()  : string

Create an authentication required error response.

badRequestProblem()  : string

Create a bad request error response.

conflictProblem()  : string

Create a conflict error response.

internalErrorProblem()  : string

Create an internal error response.

methodNotAllowedProblem()  : string

Create a method not allowed error response.

notFoundProblem()  : string

Create a not found error response.

permissionProblem()  : string

Create a permission denied error response.

problemDetailsResponse()  : string

Create a problem response from a ProblemDetails instance.

problemResponse()  : string

Create a problem response using individual parameters.

rateLimitProblem()  : string

Create a rate limit exceeded error response.

serviceUnavailableProblem()  : string

Create a service unavailable error response.

unsupportedMediaTypeProblem()  : string

Create an unsupported media type error response.

validationProblem()  : string

Create a validation error response.