Neuron-PHP

ProblemType : string

in package

• Neuron
• Core
• ProblemDetails

Standard problem type URIs for common API errors.

Tags

example

// Use standard problem type for validation errors
$problem = new ProblemDetails(
    type: ProblemType::VALIDATION_ERROR->value,
    title: 'Validation Failed',
    status: 400,
    detail: 'The email field is required'
);

// Or use the enum directly with type hinting
public function createProblem(ProblemType $type): ProblemDetails {
    return match($type) {
        ProblemType::VALIDATION_ERROR => new ProblemDetails(...),
        ProblemType::NOT_FOUND => new ProblemDetails(...),
        // ...
    };
}

Table of Contents

Cases

AUTHENTICATION_REQUIRED  = '/errors/authentication'

Authentication required - The request requires authentication.

BAD_REQUEST  = '/errors/bad-request'

Bad request - The request is malformed or invalid.

CONFLICT  = '/errors/conflict'

Conflict - The request conflicts with current state.

INTERNAL_ERROR  = '/errors/internal'

Internal server error - An unexpected error occurred.

METHOD_NOT_ALLOWED  = '/errors/method-not-allowed'

Method not allowed - HTTP method not supported for this endpoint.

NOT_FOUND  = '/errors/not-found'

Resource not found - The requested resource does not exist.

PAYLOAD_TOO_LARGE  = '/errors/payload-too-large'

Payload too large - Request body exceeds size limits.

PERMISSION_DENIED  = '/errors/authorization'

Permission denied - Authenticated user lacks required permissions.

RATE_LIMIT_EXCEEDED  = '/errors/rate-limit'

Rate limit exceeded - Too many requests from this client.

REQUEST_TIMEOUT  = '/errors/timeout'

Request timeout - The request took too long to process.

SERVICE_UNAVAILABLE  = '/errors/service-unavailable'

Service unavailable - The service is temporarily unavailable.

UNSUPPORTED_MEDIA_TYPE  = '/errors/unsupported-media-type'

Unsupported media type - Request content type not supported.

VALIDATION_ERROR  = '/errors/validation'

Validation error - Request data failed validation rules.

Methods

getDefaultTitle()  : string

Get the default title for this problem type.

getRecommendedStatus()  : int

Get the recommended HTTP status code for this problem type.

toProblemDetails()  : ProblemDetails

Create a ProblemDetails instance from this type.