CodeIgniter v3.0.0 API
\

\CI_Config

Config Class

This class contains functions that enable config files to be managed

Summary

Methods
Properties
Constants
__construct()
load()
item()
slash_item()
site_url()
base_url()
set_item()
$config
$is_loaded
$_config_paths
No constants found
_uri_string()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$config

$config : array

List of all loaded config values

Type

array

$is_loaded

$is_loaded : array

List of all loaded config files

Type

array

$_config_paths

$_config_paths : array

List of paths to search when trying to load a config file.

Type

array

Methods

__construct()

__construct() : void

Class constructor

Sets the $config data from the primary config.php file as a class variable.

load()

load(string  $file = '', boolean  $use_sections = FALSE, boolean  $fail_gracefully = FALSE) : boolean

Load Config File

Parameters

string $file

Configuration file name
boolean $use_sections

Whether configuration values should be loaded into their own section
boolean $fail_gracefully

Whether to just return FALSE or display an error message

Returns

boolean —

TRUE if the file was loaded correctly or FALSE on failure

item()

item(string  $item, string  $index = '') : string|null

Fetch a config file item

Parameters

string $item

Config item name
string $index

Index name

Returns

string|null —

The configuration item or NULL if the item doesn't exist

slash_item()

slash_item(string  $item) : string|null

Fetch a config file item with slash appended (if not empty)

Parameters

string $item

Config item name

Returns

string|null —

The configuration item or NULL if the item doesn't exist

site_url()

site_url(string|array<mixed,string>  $uri = '', string  $protocol = NULL) : string

Site URL

Returns base_url . index_page [. uri_string]

Parameters

string|array<mixed,string> $uri

URI string or an array of segments
string $protocol

Returns

string

base_url()

base_url(string|array<mixed,string>  $uri = '', string  $protocol = NULL) : string

Base URL

Returns base_url [. uri_string]

Parameters

string|array<mixed,string> $uri

URI string or an array of segments
string $protocol

Returns

string

set_item()

set_item(string  $item, string  $value) : void

Set a config file item

Parameters

string $item

Config item key
string $value

Config item value

_uri_string()

_uri_string(string|array<mixed,string>  $uri) : string

Build URI string

Parameters

string|array<mixed,string> $uri

URI string or an array of segments

Returns

string