RisolutoConfクラス(risoluto_conf.php) - Risoluto - Simple Framework for PHP - Wiki - Risoluto - S...

戻る

Up: Risolutoユーザ向けドキュメント

Prev: コントローラがセットするセッション一覧

Next: RisolutoCoreクラス(risoluto_core.php)

クラスリファレンス：RisolutoConfクラス(risoluto_conf.php)

Outline

1. クラスリファレンス：RisolutoConfクラス(risoluto_conf.php)
   1. クラスの概要
   2. クラスインスタンスの作成方法
   3. このクラスが依存しているもの
   4. クラスの内容
      1. クラス変数
      2. クラスメソッド

クラスの概要

Risolutoは、コンフィグファイルの形式としてIni形式を採用しています。このクラスでは、そのIni形式のコンフィグファイルを読み込んだ後パースし、情報の取得を行うためのメソッドを提供しています。

クラスインスタンスの作成方法

 require_once( RISOLUTO_FUNC . 'risoluto_conf.php' );
 
 $instance = new RisolutoConf();

このクラスが依存しているもの

• とくになし

クラスの内容

クラス変数

$arr_parsedconf

スコープ	private(static)
型	array
用途	パース後のコンフィグ情報が格納されます

$bool_parsestatus

スコープ	private(static)
型	boolean
用途	パースされたかどうかが格納されます（true: パース済み / false: 未パース）

クラスメソッド

__construct()

スコープ	public
引数	なし
戻り値	なし
用途	当該クラスのコンストラクタ（実処理はなし）

__clone()

スコープ	public
引数	なし
戻り値	なし
戻り値の型	なし
用途	当該クラスのクローンメソッド（実処理はなし）

is_Parsed()

スコープ	public
引数	なし
戻り値	ファンクション実行結果（ true：パース済み / false: 未パース ）
戻り値の型	boolean
用途	当該クラスで取り扱っているコンフィグファイルがパースされているかどうかを回答する

 $result = $instance->is_Parsed();
 
 var_dump( $result );

parse()

スコープ	public
引数	string $path iniファイルのパス
戻り値	ファンクション実行結果（ true：正常終了 / false: 異常終了 ）
戻り値の型	boolean
用途	引数で指定されたIniファイルを読み込みパースする。何らかの理由でパースができない場合は、falseを返却する。

 $result = $instance->parse( RISOLUTO_CONF . 'risoluto.ini' );
 
 var_dump( $result );

get()

スコープ	public
引数	string $section 検索対象のセクション / string $key 検索対象のキー
戻り値	セクションに対応する配列、またはキーに対応する値。 どちらも存在しない場合は null
戻り値の型	string
用途	パース済みiniファイルより、セクションのみが指定された場合はセクション内すべての値を配列として返却する。キーが指定された場合はキーが持つ値を返却する。

 $instance->parse( RISOLUTO_CONF . 'risoluto.ini' );
 $result = $instance->get( 'DBS', 'DEFAULT_DSN' );
 
 var_dump( $result );

Up: Risolutoユーザ向けドキュメント

Prev: コントローラがセットするセッション一覧

Next: RisolutoCoreクラス(risoluto_core.php)

戻る