CodeIgniter v4.5 API

CodeIgniter

in package

• Application

This class is the core of the framework, and will analyse the request, route it to a controller, and send back the response.

Tags

see

CodeIgniterTest

Table of Contents

Constants

CI_VERSION  = '4.5.5'

The current version of CodeIgniter Framework

Properties

$benchmark  : Timer

Timer instance.

$bufferLevel  : int

Application output buffering level

$cacheTTL  : int

Cache expiration time

$config  : App

Main application configuration

$context  : string|null

Context web: Invoked by HTTP request php-cli: Invoked by CLI via `php public/index.php`

$controller  : (callable|string)|string|null

Controller to use.

$enableFilters  : bool

Whether to enable Control Filters.

$method  : string

Controller method to invoke.

$output  : string

Output handler to use.

$pageCache  : ResponseCache

Web Page Caching

$request  : CLIRequest|IncomingRequest|null

Current request.

$response  : ResponseInterface

Current response.

$returnResponse  : bool

Whether to return Response object or send response.

$router  : Router

Router to use.

$startTime  : float|null

App startup time.

$totalTime  : float

Total app execution time

Methods

__construct()  : mixed

Constructor.

cache()  : void

Tells the app that the final output should be cached.

cachePage()  : bool

Caches the full response from the current request. Used for full-page caching for very high performance.

disableFilters()  : void

Disables Controller Filters.

displayCache()  : false|ResponseInterface

Determines if a response has been cached for the given URI.

displayPerformanceMetrics()  : string

Replaces the elapsed_time and memory_usage tag.

getPerformanceStats()  : array<string|int, mixed>

Returns an array with our basic performance stats collected.

initialize()  : void

Handles some basic app and environment setup.

run()  : ResponseInterface|void

Launch the application!

setContext()  : $this

Sets the app context.

spoofRequestMethod()  : void

Modifies the Request Object to use a different method if a POST variable called _method is found.

storePreviousURL()  : void

If we have a session object to use, store the current URI as the previous URI. This is called just prior to sending the response to the client, and will make it available next request.

bootstrapEnvironment()  : void

Load any custom boot files based upon the current environment.

callExit()  : void

Exits the application, setting the exit code for CLI-based applications that might be watching.

createController()  : Controller

Instantiates the controller class.

detectEnvironment()  : void

You can load different configurations depending on your current environment. Setting the environment also influences things like logging and error reporting.

determinePath()  : string

Determines the path to use for us to try to route to, based on the CLI/IncomingRequest path.

display404errors()  : ResponseInterface|void

Displays a 404 Page Not Found error. If set, will try to call the 404Override controller/method that was set in routing config.

forceSecureAccess()  : void

Force Secure Site Access? If the config value 'forceGlobalSecureRequests' is true, will enforce that all requests to this site are made through HTTPS. Will redirect the user to the current page with HTTPS, as well as set the HTTP Strict Transport Security header for those browsers that support it.

gatherOutput()  : void

Gathers the script output from the buffer, replaces some execution time tag in the output and displays the debug toolbar, if required.

generateCacheName()  : string

Generates the cache name to use for our full-page caching.

getRequestObject()  : void

Get our Request object, (either IncomingRequest or CLIRequest).

getResponseObject()  : void

Get our Response object, and set some default values, including the HTTP protocol version and a default successful response.

handleRequest()  : ResponseInterface

Handles the main request logic and fires the controller.

initializeKint()  : void

Initializes Kint

outputBufferingEnd()  : string

outputBufferingStart()  : void

resolvePlatformExtensions()  : void

Checks system for missing required PHP extensions.

runController()  : false|ResponseInterface|string|void

Runs the controller, allowing for _remap methods to function.

sendResponse()  : void

Sends the output of this request back to the client.

startBenchmark()  : void

Start the Benchmark

startController()  : ResponseInterface|string|void

Now that everything has been setup, this method attempts to run the controller method and make the script go. If it's not able to, will show the appropriate Page Not Found error.

tryToRouteIt()  : array<int, string>|string|null

Try to Route It - As it sounds like, works with the router to match a route against the current URI. If the route is a "redirect route", will also handle the redirect.

autoloadKint()  : void

configureKint()  : void

isPhpCli()  : bool

Invoked via php-cli command?

isWeb()  : bool

Web access?

runRequiredAfterFilters()  : void

Run required after filters.

runRequiredBeforeFilters()  : ResponseInterface|null

Run required before filters.