\ConfigApp

Class BaseConfig

Not intended to be used on its own, this class will attempt to automatically populate the child class' properties with values from the environment.

These can be set within the .env file.

Summary

Methods

Properties

Constants

__construct()

$registrars
$baseURL
$indexPage
$uriProtocol
$defaultLocale
$negotiateLocale
$supportedLocales
$appTimezone
$charset
$forceGlobalSecureRequests
$sessionDriver
$sessionCookieName
$sessionExpiration
$sessionSavePath
$sessionMatchIP
$sessionTimeToUpdate
$sessionRegenerateDestroy
$cookiePrefix
$cookieDomain
$cookiePath
$cookieSecure
$cookieHTTPOnly
$proxyIPs
$CSRFTokenName
$CSRFCookieName
$CSRFExpire
$CSRFRegenerate
$CSRFRedirect
$CSPEnabled
$salt

No constants found

initEnvValue()
getEnvValue()
registerProperties()

$didDiscovery
$moduleConfig

N/A

No private methods found

No private properties found

N/A

File: src/Core/Config/App.php
Package: Default
Class hierarchy: \CodeIgniter\Config\BaseConfig

\Config\App

Properties

$registrars

$registrars : array

An optional array of classes that will act as Registrars for rapidly setting config class properties.

Type

array

$baseURL

$baseURL :

Type

$indexPage

$indexPage :

Type

$uriProtocol

$uriProtocol :

Type

$defaultLocale

$defaultLocale :

Type

$negotiateLocale

$negotiateLocale :

Type

$supportedLocales

$supportedLocales :

Type

$appTimezone

$appTimezone :

Type

$charset

$charset :

Type

$forceGlobalSecureRequests

$forceGlobalSecureRequests :

Type

$sessionDriver

$sessionDriver :

Type

$sessionCookieName

$sessionCookieName :

Type

$sessionExpiration

$sessionExpiration :

Type

$sessionSavePath

$sessionSavePath :

Type

$sessionMatchIP

$sessionMatchIP :

Type

$sessionTimeToUpdate

$sessionTimeToUpdate :

Type

$sessionRegenerateDestroy

$sessionRegenerateDestroy :

Type

$cookiePrefix

$cookiePrefix :

Type

$cookieDomain

$cookieDomain :

Type

$cookiePath

$cookiePath :

Type

$cookieSecure

$cookieSecure :

Type

$cookieHTTPOnly

$cookieHTTPOnly :

Type

$proxyIPs

$proxyIPs :

Type

$CSRFTokenName

$CSRFTokenName :

Type

$CSRFCookieName

$CSRFCookieName :

Type

$CSRFExpire

$CSRFExpire :

Type

$CSRFRegenerate

$CSRFRegenerate :

Type

$CSRFRedirect

$CSRFRedirect :

Type

$CSPEnabled

$CSPEnabled :

Type

$salt

$salt :

Type

$didDiscovery

$didDiscovery : boolean

Has module discovery happened yet?

Type

boolean

$moduleConfig

$moduleConfig : \CodeIgniter\Config\type

The modules configuration.

Type

\CodeIgniter\Config\type

Methods

__construct()

__construct()

Will attempt to get environment variables with names that match the properties of the child class.

The "shortPrefix" is the lowercase-only config class name.

initEnvValue()

initEnvValue(  $property, string  $name, string  $prefix, string  $shortPrefix) : mixed

Initialization an environment-specific configuration setting

Parameters

	$property
string	$name
string	$prefix
string	$shortPrefix

Returns

mixed

getEnvValue()

getEnvValue(string  $property, string  $prefix, string  $shortPrefix) : mixed

Retrieve an environment-specific configuration setting

Parameters

string	$property
string	$prefix
string	$shortPrefix

Returns

mixed

registerProperties()

registerProperties()

Provides external libraries a simple way to register one or more options into a config file.

Throws

\ReflectionException