Class IniConfig

Ini file configuration engine.

Since IniConfig uses parse_ini_file underneath, you should be aware that this class shares the same behavior, especially with regards to boolean and null values.

In addition to the native parse_ini_file features, IniConfig also allows you to create nested array structures through usage of . delimited names. This allows you to create nested arrays structures in an ini config file. For example:

db.password = secret would turn into ['db' => ['password' => 'secret']]

You can nest properties as deeply as needed using .'s. In addition to using . you can use standard ini section notation to create nested structures:

[section]
key = value

Once loaded into Configure, the above would be accessed using:

`Configure::read('section.key');

You can also use . separated values in section names to create more deeply nested structures.

IniConfig also manipulates how the special ini values of 'yes', 'no', 'on', 'off', 'null' are handled. These values will be converted to their boolean equivalents.

Cake\Core\Configure\Engine\IniConfig implements Cake\Core\Configure\ConfigEngineInterface uses Cake\Core\Configure\FileConfigTrait
Namespace: Cake\Core\Configure\Engine
See: https://secure.php.net/parse_ini_file
Location: Core/Configure/Engine/IniConfig.php

Properties summary

  • $_extension protected
    string
    File extension.
  • $_section protected
    string|null
    The section to read, if null all sections will be read.

Inherited Properties

Method Summary

  • __construct() public

    Build and construct a new ini file parser. The parser can be used to read ini files that are on the filesystem.

  • parses nested values out of keys.
  • _value() protected
    Converts a value into the ini equivalent
  • dump() public
    Dumps the state of Configure data into an ini formatted string.
  • read() public
    Read an ini file and return the results as an array.

Method Detail

__construct()source public 

__construct( string|null $path null , string|null $section null )

Build and construct a new ini file parser. The parser can be used to read ini files that are on the filesystem.

Parameters

string|null $path optional null
Path to load ini config files from. Defaults to CONFIG.
string|null $section optional null

Only get one section, leave null to parse and fetch all sections in the ini file.

_parseNestedValues()source protected 

_parseNestedValues( array $values )

parses nested values out of keys.

Parameters

array $values
Values to be exploded.

Returns

array
Array of values exploded

_value()source protected 

_value( mixed $value )

Converts a value into the ini equivalent

Parameters

mixed $value
Value to export.

Returns

string
String value for ini file.

dump()source public 

dump( string $key , array $data )

Dumps the state of Configure data into an ini formatted string.

Parameters

string $key

The identifier to write to. If the key has a . it will be treated as a plugin prefix.

array $data
The data to convert to ini file.

Returns

boolean
Success.

Implementation of

Cake\Core\Configure\ConfigEngineInterface::dump()

read()source public 

read( string $key )

Read an ini file and return the results as an array.

Parameters

string $key

The identifier to read from. If the key has a . it will be treated as a plugin prefix. The chosen file must be on the engine's path.

Returns

array
Parsed configuration values.

Throws

Cake\Core\Exception\Exception

when files don't exist. Or when files contain '..' as this could lead to abusive reads.


Implementation of

Cake\Core\Configure\ConfigEngineInterface::read()

Methods used from Cake\Core\Configure\FileConfigTrait

_getFilePath()source protected 

_getFilePath( string $key , boolean $checkExists false )

Get file path

Parameters

string $key

The identifier to write to. If the key has a . it will be treated as a plugin prefix.

boolean $checkExists optional false
Whether to check if file exists. Defaults to false.

Returns

string
Full file path

Throws

Cake\Core\Exception\Exception

When files don't exist or when files contain '..' as this could lead to abusive reads.


Properties detail

$_extensionsource

protected string

File extension.

'.ini'

$_sectionsource

protected string|null

The section to read, if null all sections will be read.

© 2005–2018 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.5/class-Cake.Core.Configure.Engine.IniConfig.html