README

retrinko/ini

解析和编写 ini 文件的库。

提供的特性超过原生 PHP ini 解析器

• 抛出异常而不是 PHP 错误。
• 更好的类型支持。
• 部分继承。

注意：此解析器不允许孤儿项（定义在部分之外的项）。

安装

使用以下命令安装最新版本

$ composer require retrinko/ini

基本用法

读取 ini 内容

注意!!：请注意 .local.ini 文件。如果您尝试加载名为 [ whateverYouWants ].ini 的文件，并且同一路径下存在名为 [ whateverYouWants ].local.ini 的文件，则两个文件的将合并内容。如果两个文件中定义了相同的键，则 [ whateverYouWants ].local.ini 中定义的值将覆盖 [ whateverYouWants ].ini 中定义的值。

Ini 文件内容（sample.ini）

[default]
key1 = default value1
key2 = default value2

; A section inherits default section
[A : default]
key1 = A value1 ; overrides default section key1 item
key3 = A value3 ; add new item

; B section inherits A section
[B : A]
key1 = B value1 ; overrides A section key1 item
key3 = B value3 ; overrides A section key3 item
; Simple array
A[] = a
A[] = b
; Assoc. array
B[one] = 1
B[two] = 2
; Bool values
boolTrue = true
boolFalse = false
boolYes = yes
boolNo = no
boolOn = on
boolOff = off
boolNone = none
intVal = 3
floatVal = 5.7

读取 ini 文件的 PHP 示例代码（sample.ini）

use Retrinko\Ini\IniFile;

try
{
    // Load ini file
    $iniFile = IniFile::load((__DIR__ . '/sample.ini'));

    // Read "key1" value from "default" section
    $key1 = $iniFile->get('default', 'key1');
    
    // Read "key1" value from "A" section
    $key1 = $iniFile->get('A', 'key1');
    
    // Read "key1" value from "B" section
    $key1 = $iniFile->get('B', 'key1');
    
    // Read "boolYes" value from "B" section
    $boolYes = $iniFile->get('B', 'boolYes');
    
    // Get ini file contents as array
    $array = $iniFile->toArray();
}
catch (\Exception $e)
{
    printf('Exception! %s'.PHP_EOL, $e->getMessage());
}

写入 ini 内容

写入 ini 文件的 PHP 示例代码

use Retrinko\Ini\IniFile;
use Retrinko\Ini\IniSection;

try
{
    // Create new IniFile instance
    $iniFile = new IniFile();

    // Create section "base"
    $section = new IniSection('base');
    // Add items to section "base"
    $section->set('hello', 'world');
    $section->set('colors', ['red', 'green']);
    $section->set('rgb', ['red'=>'AA0000', 'green'=>'00AA00']);
    $section->set('width', 25);
    $section->set('height', 50.33);
    $section->set('bool', true);
    $section->set('nullValue', null);
    // Add section "base" to ini file
    $iniFile->addSection($section);

    // Add child section "child"
    $childSection = new IniSection('child', $section);
    // Add items to section "child"
    $childSection->set('height', 20);
    $childSection->set('width', 20);
    // Add section "child" to ini file
    $iniFile->addSection($childSection);

    // Add item values to sections
    $iniFile->set('base', 'new-item', 'value');
    $iniFile->set('child', 'last-item', 'last');

    // Save to file
    $iniFile->save(__DIR__.'/test.ini');

}
catch (\Exception $e)
{
    printf('Exception! %s'.PHP_EOL, $e->getMessage());
}