Documentation

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.

Table of Contents

CI_VERSION  = '4.1.3'

The current version of CodeIgniter Framework

MIN_PHP_VERSION  = '7.3'

$benchmark  : Timer

Timer instance.

$cacheTTL  : int

Cache expiration time

$config  : App

Main application configuration

$controller  : string|Closure

Controller to use.

$method  : string

Controller method to invoke.

$output  : string

Output handler to use.

$path  : string

Request path to use.

$request  : Request|IncomingRequest|CLIRequest

Current request.

$response  : ResponseInterface

Current response.

$router  : Router

Router to use.

$startTime  : mixed

App startup time.

$totalTime  : float

Total app execution time

$useSafeOutput  : bool

Should the Response instance "pretend" to keep from setting headers/cookies/etc

__construct()  : mixed

Constructor.

cache()  : void

Tells the app that the final output should be cached.

cachePage()  : mixed

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

displayCache()  : bool|ResponseInterface

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

displayPerformanceMetrics()  : string

Replaces the memory_usage and elapsed_time tags.

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

Returns an array with our basic performance stats collected.

initialize()  : mixed

Handles some basic app and environment setup.

run()  : bool|RequestInterface|ResponseInterface|mixed

Launch the application!

setPath()  : $this

Allows the request path to be set from outside the class, instead of relying on CLIRequest or IncomingRequest for the path.

setRequest()  : $this

Sets a Request object to be used for this request.

spoofRequestMethod()  : mixed

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

storePreviousURL()  : mixed

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.

useSafeOutput()  : $this

Set our Response instance to "pretend" mode so that things like cookies and headers are not actually sent, allowing PHP 7.2+ to not complain when ini_set() function is used.

bootstrapEnvironment()  : mixed

Load any custom boot files based upon the current environment.

callExit()  : mixed

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

createController()  : mixed

Instantiates the controller class.

detectEnvironment()  : mixed

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

determinePath()  : mixed

Determines the path to use for us to try to route to, based on user input (setPath), or the CLI/IncomingRequest path.

display404errors()  : mixed

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

forceSecureAccess()  : mixed

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()  : mixed

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()  : mixed

Get our Request object, (either IncomingRequest or CLIRequest) and set the server protocol based on the information provided by the server.

getResponseObject()  : mixed

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

handleRequest()  : RequestInterface|ResponseInterface|mixed

Handles the main request logic and fires the controller.

initializeKint()  : mixed

Initializes Kint

resolvePlatformExtensions()  : void

Checks system for missing required PHP extensions.

runController()  : mixed

Runs the controller, allowing for _remap methods to function.

sendResponse()  : mixed

Sends the output of this request back to the client.

startBenchmark()  : mixed

Start the Benchmark

startController()  : mixed

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()  : 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.