phpDocumentor openbiz.bin
[ class tree: openbiz.bin ] [ index: openbiz.bin ] [ all elements ]

Class: Configuration

Source Location: /Configuration.php

Class Configuration

Class Overview

Configuration class Configuration management class that has help methods to get data from config.xml

Located in /Configuration.php [line 24]



		
				Author(s):
		
		
		
Information Tags:
Version:  2.3 2009-06-01

Methods

[ Top ]
Method Summary
Configuration   __construct()   Read Config.xml into a internal array.
array   GetDatabaseInfo()   Returns the database info from <DataSource> defined in Config.xml as an array.
array   GetThemeInfo()   Returns the <ThemeSource> defined in Config.xml as an array.
string|false   GetThemePath()   Get Path of Theme that defined on Config.xml

[ Top ]
Methods
Constructor __construct  [line 43]

  Configuration __construct( )

Read Config.xml into a internal array.


API Tags:
Access:  public


[ Top ]
GetDatabaseInfo  [line 61]

  array GetDatabaseInfo( [string $dbName = null]  )

Returns the database info from <DataSource> defined in Config.xml as an array.

Returned array is a 2D map. (DBName1 => ["Name"], ["Driver"], ["Server"], ["DBName"], ["User"], {"Password"]) (DBName2 => ["Name"], ["Driver"], ["Server"], ["DBName"], ["User"], {"Password"]) (...) If DBName is given, returns the record only related to the given DBName, otherwise returns all records

Parameters:
string   $dbName: 

API Tags:
Return:  database information
Access:  public


[ Top ]
GetThemeInfo  [line 114]

  array GetThemeInfo( [string $themeName = null]  )

Returns the <ThemeSource> defined in Config.xml as an array.

Returned array is a 2D map. (themeName1 => ["Name"], ["Description"], ["Path"], ["Author"], ["AuthorEmail"], {"ReleaseDate"]) (themeName2 => ["Name"], ["Description"], ["Path"], ["Author"], ["AuthorEmail"], {"ReleaseDate"]) (...) If $themeName is given, returns the record only related to the given $themeName, otherwise returns all records

Parameters:
string   $themeName: 

API Tags:
Return:  theme information
Access:  public


[ Top ]
GetThemePath  [line 165]

  string|false GetThemePath( [string $themeName = null]  )

Get Path of Theme that defined on Config.xml

Parameters:
string   $themeName: 

API Tags:
Return:  path of theme or false if theme source not configured
Static:  
Access:  public


[ Top ]

Documentation generated on Tue, 22 Dec 2009 03:02:45 -0800 by phpDocumentor 1.3.0RC3