« 目次

Movable Type オブジェクト・リファレンス

MT::ConfigMgr

概要


use MT::ConfigMgr;
my $cfg = MT::ConfigMgr->instance;

$cfg->read_config('/path/to/mt-config.cgi')
    or die $cfg->errstr;

解説

MT::ConfigMgrは、Movable Typeの環境設定ファイル(mt-config.cgi)を管理するシングルトン・クラスで、そのファイル中の環境変数へのアクセスを可能にします。

利用方法

MT::ConfigMgr->instance

MT::ConfigMgrのシングルトン・オブジェクトを返します。このオブジェクトを取得する際には、必ずnewではなくinstanceを呼び出すよう注意してください。newを呼び出すとMT::ConfigMgrオブジェクトを新規に生成することになってしまい、意図した動作が行われません。必要なのは、mt-config.cgiの内容を読み込んで初期化された既存のMT::ConfigMgrオブジェクトだからです。この初期化を行うのがMT::newです。

$cfg->read_config($file)

$fileに指定したパスにある環境設定ファイルを読み込み、そのファイルに書かれた設定項目で$cfgオブジェクトを初期化します。成功した場合にはtrueを返し、失敗するとundefを返します。エラー発生時には、$cfg->errstrを呼び出すとエラー・メッセージが取得できます。

$cfg->define($directive [, %arg ])

設定項目$directiveを有効な環境変数として定義します。新規環境変数の定義は環境設定を読み込む前に行います。そうしないと読み込みは失敗します。

環境設定ファイルの設定項目

mt-config.cgiでは次の環境変数が指定可能です。項目に対する値を取得するには、次の例のように、その項目名を*メソッドとして$cfgオブジェクトから呼び出します。

$cfg->CGIPath

設定項目の値を設定する場合も同様の方法で行いますが、指定したい値をメソッドの引数として渡します。

$cfg->CGIPath('http://www.foo.com/mt/');

環境変数の一覧は、マニュアルの環境設定ファイルの設定の項を参照してください。


Copyright © 2001-2006 Six Apart, Ltd. All Rights Reserved.