EnglishRisolutoConfクラス - Risoluto - Simple Framework for PHP - Wiki - Risoluto - Simple Framew...

Return

Class reference：RisolutoConf class(risoluto_conf.php)

Outline

1. Class reference：RisolutoConf class(risoluto_conf.php)
   1. Abstruction of the class
   2. How to create class instance
   3. What this class depends on
   4. Contents of class
      1. Class variable
      2. Class method

Abstruction of the class

Risolute adopts Ini as a format for configuration file. This class loads the Ini formatted configuration file, then parse it to provide method to retrieve the information.

How to create class instance

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

What this class depends on

• None

Contents of class

Class variable

$arr_parsedconf

Scope	private(static)
Type	array
Purpose	Configuration information after parsing will be stored.

$bool_parsestatus

Scope	private(static)
Type	boolean
Purpose	Result if it was parsed (true: parsed / false: not parsed).

Class method

__construct()

Scope	public
Parameter	none
Return value	none
Purpose	Constructor of this class (no actual processing).

__clone()

Scope	public
Parameter	None
Return value	None
Type of return value	none
Purpose	Clone method of this class (no actual processing).

is_Parsed()

Scope	public
Parameter	none
Return value	Result of function execution (true: parsed / false: not parsed).
Type of return value	boolean
Purpose	Answer if the configration file used by this class was parsed or not.

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

parse()

Scope	public
Parameter	string $path pas for ini file
Return value	Result of function execution (true: normal termination / false: abnormal termination)
Type of return value	boolean
Purpose	After loading, parse the Ini file assigned by parameter. If it can not be parsed by any reason, return false.

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

get()

Scope	public
Parameter	string $section Section of searching target / string $key Key for searching target
Return value	Array applied for the section or value for key. If neither of them exists, it will be null.
Type of return value	string
Purpose	In case only section was assigned from ini file, all values in the section will be returned as an array. If a key was assigned, a value of the key will be retuned.

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

Return