App
extends BaseConfig
in package
Table of Contents
Properties
- $allowedHostnames : array<int, string>
- Allowed Hostnames in the Site URL other than the hostname in the baseURL.
- $appTimezone : string
- -------------------------------------------------------------------------- Application Timezone --------------------------------------------------------------------------
- $baseURL : string
- -------------------------------------------------------------------------- Base Site URL --------------------------------------------------------------------------
- $charset : string
- -------------------------------------------------------------------------- Default Character Set --------------------------------------------------------------------------
- $CSPEnabled : bool
- -------------------------------------------------------------------------- Content Security Policy --------------------------------------------------------------------------
- $defaultLocale : string
- -------------------------------------------------------------------------- Default Locale --------------------------------------------------------------------------
- $forceGlobalSecureRequests : bool
- -------------------------------------------------------------------------- Force Global Secure Requests --------------------------------------------------------------------------
- $indexPage : string
- -------------------------------------------------------------------------- Index File --------------------------------------------------------------------------
- $negotiateLocale : bool
- -------------------------------------------------------------------------- Negotiate Locale --------------------------------------------------------------------------
- $permittedURIChars : string
- $proxyIPs : array<string, string>
- -------------------------------------------------------------------------- Reverse Proxy IPs --------------------------------------------------------------------------
- $supportedLocales : array<int, string>
- -------------------------------------------------------------------------- Supported Locales --------------------------------------------------------------------------
- $uriProtocol : string
- -------------------------------------------------------------------------- URI PROTOCOL --------------------------------------------------------------------------
Properties
$allowedHostnames
Allowed Hostnames in the Site URL other than the hostname in the baseURL.
public
array<int, string>
$allowedHostnames
= []
If you want to accept multiple Hostnames, set this.
E.g., When your site URL ($baseURL) is 'http://example.com/', and your site also accepts 'http://media.example.com/' and 'http://accounts.example.com/': ['media.example.com', 'accounts.example.com']
$appTimezone
-------------------------------------------------------------------------- Application Timezone --------------------------------------------------------------------------
public
string
$appTimezone
= 'UTC'
The default timezone that will be used in your application to display dates with the date helper, and can be retrieved through app_timezone()
Tags
$baseURL
-------------------------------------------------------------------------- Base Site URL --------------------------------------------------------------------------
public
string
$baseURL
= 'http://localhost:8080/'
URL to your CodeIgniter root. Typically, this will be your base URL, WITH a trailing slash:
E.g., http://example.com/
$charset
-------------------------------------------------------------------------- Default Character Set --------------------------------------------------------------------------
public
string
$charset
= 'UTF-8'
This determines which character set is used by default in various methods that require a character set to be provided.
Tags
$CSPEnabled
-------------------------------------------------------------------------- Content Security Policy --------------------------------------------------------------------------
public
bool
$CSPEnabled
= false
Enables the Response's Content Secure Policy to restrict the sources that
can be used for images, scripts, CSS files, audio, video, etc. If enabled,
the Response object will populate default values for the policy from the
ContentSecurityPolicy.php file. Controllers can always add to those
restrictions at run time.
For a better understanding of CSP, see these documents:
Tags
$defaultLocale
-------------------------------------------------------------------------- Default Locale --------------------------------------------------------------------------
public
string
$defaultLocale
= 'fr'
The Locale roughly represents the language and location that your visitor is viewing the site from. It affects the language strings and other strings (like currency markers, numbers, etc), that your program should run under for this request.
$forceGlobalSecureRequests
-------------------------------------------------------------------------- Force Global Secure Requests --------------------------------------------------------------------------
public
bool
$forceGlobalSecureRequests
= false
If true, this will force every request made to this application to be made via a secure connection (HTTPS). If the incoming request is not secure, the user will be redirected to a secure version of the page and the HTTP Strict Transport Security (HSTS) header will be set.
$indexPage
-------------------------------------------------------------------------- Index File --------------------------------------------------------------------------
public
string
$indexPage
= 'index.php'
Typically, this will be your index.php file, unless you've renamed it to
something else. If you have configured your web server to remove this file
from your site URIs, set this variable to an empty string.
$negotiateLocale
-------------------------------------------------------------------------- Negotiate Locale --------------------------------------------------------------------------
public
bool
$negotiateLocale
= false
If true, the current Request object will automatically determine the language to use based on the value of the Accept-Language header.
If false, no automatic detection will be performed.
$permittedURIChars
public
string
$permittedURIChars
= 'a-z 0-9~%.:_\-'
$proxyIPs
-------------------------------------------------------------------------- Reverse Proxy IPs --------------------------------------------------------------------------
public
array<string, string>
$proxyIPs
= []
If your server is behind a reverse proxy, you must whitelist the proxy IP addresses from which CodeIgniter should trust headers such as X-Forwarded-For or Client-IP in order to properly identify the visitor's IP address.
You need to set a proxy IP address or IP address with subnets and the HTTP header for the client IP address.
Here are some examples: [ '10.0.1.200' => 'X-Forwarded-For', '192.168.5.0/24' => 'X-Real-IP', ]
$supportedLocales
-------------------------------------------------------------------------- Supported Locales --------------------------------------------------------------------------
public
array<int, string>
$supportedLocales
= ['en']
If $negotiateLocale is true, this array lists the locales supported by the application in descending order of priority. If no match is found, the first locale will be used.
IncomingRequest::setLocale() also uses this list.
$uriProtocol
-------------------------------------------------------------------------- URI PROTOCOL --------------------------------------------------------------------------
public
string
$uriProtocol
= 'REQUEST_URI'
This item determines which server global should be used to retrieve the URI string. The default setting of 'REQUEST_URI' works for most servers. If your links do not seem to work, try one of the other delicious flavors:
'REQUEST_URI': Uses $_SERVER['REQUEST_URI'] 'QUERY_STRING': Uses $_SERVER['QUERY_STRING'] 'PATH_INFO': Uses $_SERVER['PATH_INFO']
WARNING: If you set this to 'PATH_INFO', URIs will always be URL-decoded!