\CodeIgniter\DebugExceptions

respond()

respond(array|string|null  $data = null, integer  $status = null, string  $message = '') : mixed

Provides a single, simple method to return an API response, formatted to match the requested format, with proper content-type and status code.

Parameters

Returns

fail()

fail(string|array  $messages, integer|null  $status = 400, string|null  $code = null, string  $customMessage = '') : mixed

Used for generic failures that no custom methods exist for.

Parameters

Returns

respondCreated()

respondCreated(mixed  $data = null, string  $message = '') : mixed

Used after successfully creating a new resource.

Parameters

Returns

respondDeleted()

respondDeleted(mixed  $data = null, string  $message = '') : mixed

Used after a resource has been successfully deleted.

Parameters

Returns

respondNoContent()

respondNoContent(string  $message = 'No Content') : mixed

Used after a command has been successfully executed but there is no meaningful reply to send back to the client.

Parameters

Returns

failUnauthorized()

failUnauthorized(string  $description = 'Unauthorized', string  $code = null, string  $message = '') : mixed

Used when the client is either didn't send authorization information, or had bad authorization credentials. User is encouraged to try again with the proper information.

Parameters

Returns

failForbidden()

failForbidden(string  $description = 'Forbidden', string  $code = null, string  $message = '') : mixed

Used when access is always denied to this resource and no amount of trying again will help.

Parameters

Returns

failNotFound()

failNotFound(string  $description = 'Not Found', string  $code = null, string  $message = '') : mixed

Used when a specified resource cannot be found.

Parameters

Returns

failValidationError()

failValidationError(string  $description = 'Bad Request', string  $code = null, string  $message = '') : mixed

Used when the data provided by the client cannot be validated.

Parameters

Returns

failResourceExists()

failResourceExists(string  $description = 'Conflict', string  $code = null, string  $message = '') : mixed

Use when trying to create a new resource and it already exists.

Parameters

Returns

failResourceGone()

failResourceGone(string  $description = 'Gone', string  $code = null, string  $message = '') : mixed

Use when a resource was previously deleted. This is different than Not Found, because here we know the data previously existed, but is now gone, where Not Found means we simply cannot find any information about it.

Parameters

Returns

failTooManyRequests()

failTooManyRequests(string  $description = 'Too Many Requests', string  $code = null, string  $message = '') : mixed

Used when the user has made too many requests for the resource recently.

Parameters

Returns

failServerError()

failServerError(string  $description = 'Internal Server Error', string|null  $code = null, string  $message = '') : \CodeIgniter\HTTP\Response

Used when there is a server error.

Parameters

Returns

The value of the Response's send() method.

__construct()

__construct(\Config\Exceptions  $config, \CodeIgniter\HTTP\IncomingRequest  $request, \CodeIgniter\HTTP\Response  $response) 

Constructor.

Parameters

initialize()

initialize() 

Responsible for registering the error, exception and shutdown handling of our application.

exceptionHandler()

exceptionHandler(\Throwable  $exception) 

Catches any uncaught errors and exceptions, including most Fatal errors (Yay PHP7!). Will log the error, display it if display_errors is on, and fire an event that allows custom actions to be taken at this point.

Parameters

errorHandler()

errorHandler(integer  $severity, string  $message, string|null  $file = null, integer|null  $line = null, null  $context = null) 

Even in PHP7, some errors make it through to the errorHandler, so convert these to Exceptions and let the exception handler log it and display it.

This seems to be primarily when a user triggers it with trigger_error().

Parameters

Throws

\ErrorException

shutdownHandler()

shutdownHandler() 

Checks to see if any errors have happened during shutdown that need to be caught and handle them.

cleanPath()

cleanPath(string  $file) : string

Clean Path

This makes nicer looking paths for the error output.

Parameters

Returns

describeMemory()

describeMemory(  $bytes) : string

Describes memory usage in real-world units. Intended for use with memory_get_usage, etc.

Parameters

Returns

highlightFile()

highlightFile(string  $file, integer  $lineNumber, integer  $lines = 15) : boolean|string

Creates a syntax-highlighted version of a PHP file.

Parameters

Returns

format()

format(string|array|null  $data = null) : string|null

Handles formatting a response. Currently makes some heavy assumptions and needs updating! :)

Parameters

Returns

determineView()

determineView(\Throwable  $exception, string  $template_path) : string

Determines the view to display based on the exception thrown, whether an HTTP or CLI request, etc.

Parameters

Returns

The path and filename of the view file to use

render()

render(\Throwable  $exception, integer  $statusCode) 

Given an exception and status code will display the error to the client.

Parameters

collectVars()

collectVars(\Throwable  $exception, integer  $statusCode) : array

Gathers the variables that will be made available to the view.

Parameters

Returns

determineCodes()

determineCodes(\Throwable  $exception) : array

Determines the HTTP status code and the exit status code for this request.

Parameters

Returns