Config-Tiny-2.14 > Config::Tiny
Config-Tiny-2.14

名前

Config::Tiny - Read/Write .ini style files with as little code as possible

Config::Tiny - 必要最小限のコードで .ini形式のファイルの読み書き

概要

    # In your configuration file
    rootproperty=blah

    [section]
    one=twp
    three= four
    Foo =Bar
    empty=

    # In your program
    use Config::Tiny;

    # Create a config
    my $Config = Config::Tiny->new;

    # Open the config
    $Config = Config::Tiny->read( 'file.conf' );

    # Reading properties
    my $rootproperty = $Config->{_}->{rootproperty};
    my $one = $Config->{section}->{one};
    my $Foo = $Config->{section}->{Foo};

    # Changing data
    $Config->{newsection} = { this => 'that' }; # Add a section
    $Config->{section}->{Foo} = 'Not Bar!';     # Change a value
    delete $Config->{_};                        # Delete a value or section

    # Save a config
    $Config->write( 'file.conf' );
    # コンフィグファイル
    rootproperty=blah

    [section]
    one=twp
    three= four
    Foo =Bar
    empty=

    # プログラム
    use Config::Tiny;

    # コンフィグの作成
    my $Config = Config::Tiny->new;

    # コンフィグファイルのオープン
    $Config = Config::Tiny->read( 'file.conf' );

    # プロパティの読み取り
    my $rootproperty = $Config->{_}->{rootproperty};
    my $one = $Config->{section}->{one};
    my $Foo = $Config->{section}->{Foo};

    # データの変更
    $Config->{newsection} = { this => 'that' }; # セクションの追加
    $Config->{section}->{Foo} = 'Not Bar!';     # 値の変更
    delete $Config->{_};                        # 値 or セクションの削除

    # コンフィグの保存
    $Config->write( 'file.conf' );

説明

Config::Tiny is a perl class to read and write .ini style configuration files with as little code as possible, reducing load time and memory overhead. Most of the time it is accepted that Perl applications use a lot of memory and modules. The ::Tiny family of modules is specifically intended to provide an ultralight alternative to the standard modules.

This module is primarily for reading human written files, and anything we write shouldn't need to have documentation/comments. If you need something with more power move up to Config::Simple, Config::General or one of the many other Config:: modules. To rephrase, Config::Tiny does not preserve your comments, whitespace, or the order of your config file.

Config::Tinyは .ini形式のコンフィグファイルを, 必要最小限のコード, ロード時間, メモリ消費量で読み書きするための, Perlクラスです. 多くの場合 Perlアプリケーションは多くのメモリとモジュールを利用することが, 許容されます. モジュールの::Tinyとつくものは特別で, 標準的なモジュールの超軽量版の代替として, 利用することを意図しています.

このモジュールは, 人間の書いたファイルの読み取りを第一とし, ドキュメントやコメントなど必要ないものは保持しません. より強力なものが必要であれば, Config::Simple, Config::General, その他多くの Config::モジュールを利用してください. 言い換えると, Config::Tinyはコンフィグファイル中のコメント, 空白, 順番を保持しません.

CONFIGURATION FILE SYNTAX

Files are the same format as for windows .ini files. For example:

        [section]
        var1=value1
        var2=value2

If a property is outside of a section at the beginning of a file, it will be assigned to the "root section", available at $Config->{_}.

Lines starting with '#' or ';' are considered comments and ignored, as are blank lines.

When writing back to the config file, all comments, custom whitespace, and the ordering of your config file elements is discarded. If you need to keep the human elements of a config when writing back, upgrade to something better, this module is not for you.

Windowsで使われる .iniファイルと同じ形式のファイルです. 例えば:

        [section]
        var1=value1
        var2=value2

もしプロパティがファイルの先頭のセクションの外側にあれば, それは"root section"に割り当てられ, $Config->{_}で参照することができます.

'#'もしくは ';'で開始する行はコメントとし, 空行同様に無視します.

コンフィグファイルを書き出す場合, すべてのコメント, 空白, コンフィグファイルの要素の順番は無視されます. もし書き出す場合にそれらの要素を保持する必要があるのであれば, このモジュールはふさわしくないので, より良いものを使ってください.

メソッド

new

The constructor new creates and returns an empty Config::Tiny object.

read $filename

The read constructor reads a config file, and returns a new Config::Tiny object containing the properties in the file.

Returns the object on success, or undef on error.

When read fails, Config::Tiny sets an error message internally you can recover via Config::Tiny->errstr. Although in some cases a failed read will also set the operating system error variable $!, not all errors do and you should not rely on using the $! variable.

read_string $string;

The read_string method takes as argument the contents of a config file as a string and returns the Config::Tiny object for it.

write $filename

The write method generates the file content for the properties, and writes it to disk to the filename specified.

Returns true on success or undef on error.

write_string

Generates the file content for the object and returns it as a string.

errstr

When an error occurs, you can retrieve the error message either from the $Config::Tiny::errstr variable, or using the errstr() method.

new

newコンストラクタは, 空の Config::Tinyオブジェクトを返します.

read $filename

readコンストラクタはコンフィグファイルの内容を読み取り, ファイルのプロパティの内容を保持する, 新しい Config::Tinyオブジェクトを返します.

成功した場合はオブジェクトが, 失敗した場合は undefが返ります.

readに失敗した場合, Config::Tinyはエラーメッセージを内部的に保存し, Config::Tiny->errstrから復帰できるようにします. readの失敗のうちいくつかについては, OSエラー変数 $!にもエラー内容がセットされますが, すべてのエラーについてではないので, $!変数に依存すべきではありません.

read_string $string;

read_stringメソッドは, コンフィグファイルの内容を文字列として受け取り, それをConfig::Tinyオブジェクトにしたものを返します.

write $filename

writeメソッドはプロパティからファイル内容を生成し, 指定されたファイルに書き出します.

成功した場合は真, 失敗した場合は undefが返ります.

write_string

オブジェクトからファイル内容を生成し, 文字列として返します.

errstr

エラーが発生した場合, エラーメッセージを $Config::Tiny::errstr変数か, errstr()メソッドを利用することで取得することができます.

CAVEATS

Unsupported Section Headers

Some edge cases in section headers are not support, and additionally may not be detected when writing the config file.

Specifically, section headers with leading whitespace, trailing whitespace, or newlines anywhere in the section header, will not be written correctly to the file and may cause file corruption.

未サポートのセクションヘッダ

セクションヘッダのエッジケースでサポートされないものがあり, それらはコンフィグファイルの書き出しの場合に検知することができません.

特に, セクションヘッダが空白で始まっている, 末尾に空白がある, 改行が含まれるという場合は, ファイルに正しく書き出せず, ファイル内容を破壊する原因となってしまいます.

サポート

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Config-Tiny

For other issues, or commercial enhancement or support, contact the author.

バグは以下の CPANバグトラッカを使ってレポートしてください.

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Config-Tiny

他の問題, 商用での促進, サポートについては作者に連絡を取ってください.

作者

Adam Kennedy <adamk@cpan.org>

ACKNOWLEGEMENTS

Thanks to Sherzod Ruzmetov <sherzodr@cpan.org> for Config::Simple, which inspired this module by being not quite "simple" enough for me :)

SEE ALSO

Config::Simple, Config::General, ali.as

コピーライト

Copyright 2002 - 2011 Adam Kennedy.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.