[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcConfigurationFileReader

ezcConfigurationFileReader class provides the functionality for reading file based configuration formats. [source]

Parents

ezcConfigurationReader
   |
   --ezcConfigurationFileReader

Descendents

Child Class	Description
ezcConfigurationIniReader	ezcConfigurationIniReader provides functionality for reading INI files into ezcConfiguration objects.
ezcConfigurationArrayReader	This class provides functionality for reading files containing specific PHP arrays into ezcConfiguration objects.

Member Variables

protected ezcConfiguration	$config = false Contains the configuration object that was read from the file with load().
protected string	$location = '' The current location of the config, this is either the path on the filesystem or a PHP stream prefix.
protected string	$name = '' The base name of the configuration file, the suffix will be appended to this to find the real filename.
protected array	$options = array() Current options for the reader.
protected string	$path = '' The path to the file which will contain the serialized configuration data.

Method Summary

public ezcConfigurationFileReader	__construct( [$path = null] ) Constructs the reader object.
public bool	configExists( ) Returns true if the configuration exists.
public ezcConfiguration	getConfig( ) Returns the current configuration object.
public string	getLocation( ) Returns the current location string.
public string	getName( ) Returns the current name for the configuration to be read.
public array	getOptions( ) Returns the current options for the reader.
public int	getTimestamp( ) Returns the last modified timestamp.
public void	init( $location, $name, [$options = array()] ) Initializes the reader with a location and a name. These values determine where the configuration will be serialized.
protected void	parseLocationPath( $path, $suffix ) Parses a the path $path and sets the location and name properties on this object.
public void	setOptions( $configurationData ) Sets the options $configurationData.

Inherited Methods

From ezcConfigurationReader :

public abstract bool	ezcConfigurationReader::configExists() Checks if the configuration exists.
public abstract ezcConfiguration	ezcConfigurationReader::getConfig() Returns the current configuration object.
public abstract string	ezcConfigurationReader::getLocation() Returns the current location string.
public abstract string	ezcConfigurationReader::getName() Returns the name of the configuration to be written.
public abstract array	ezcConfigurationReader::getOptions() Returns the options for the reader.
protected abstract string	ezcConfigurationReader::getSuffix() Returns the suffix used in the storage filename.
public abstract mixed	ezcConfigurationReader::getTimestamp() Returns the last modified timestamp.
public abstract void	ezcConfigurationReader::init() Initializes the reader with a $location and a $name.
public abstract ezcConfiguration	ezcConfigurationReader::load() Loads the current config object.
public abstract void	ezcConfigurationReader::setOptions() Sets the options $options for the reader.
public abstract ezcConfigurationValidationResult	ezcConfigurationReader::validate() Validates the configuration.

Methods

__construct

Parameters

Name	Type	Description
$path	string

configExists

Redefinition of

Method	Description
ezcConfigurationReader::configExists()	Checks if the configuration exists.

getConfig

Redefinition of

Method	Description
ezcConfigurationReader::getConfig()	Returns the current configuration object.

getLocation

Redefinition of

Method	Description
ezcConfigurationReader::getLocation()	Returns the current location string.

getName

Redefinition of

Method	Description
ezcConfigurationReader::getName()	Returns the name of the configuration to be written.

getOptions

Redefinition of

Method	Description
ezcConfigurationReader::getOptions()	Returns the options for the reader.

getTimestamp

Redefinition of

Method	Description
ezcConfigurationReader::getTimestamp()	Returns the last modified timestamp.

init

Parameters

Name	Type	Description
$location	string	The main placement for the configuration. It is up to the specific reader to interpret this value. This can for instance be used to determine the directory location for an INI file.
$name	string	The name for the configuration. It is up to the specific reader to interpret this value. This can for instance be the basename for the INI file, so a value of 'site' would create a file with name 'site.ini'.
$options	array	An associative array of options for the reader. Which options to use is determined by the specific reader class.

Redefinition of

Method	Description
ezcConfigurationReader::init()	Initializes the reader with a $location and a $name.

parseLocationPath

Parameters

Name	Type	Description
$path	string
$suffix	string

Throws

Class	Description
ezcConfigurationException	if the configuration file has the wrong suffix.

See also:

ezcConfigurationFileWriter::parseLocationPath() which is the same code. It is duplicated to prevent complex OO hacks..

setOptions

Parameters

Name	Type	Description
$configurationData	array(string=>mixed)

Throws

Class	Description
ezcBaseSettingNotFoundException	if you try to set a non existent setting.
ezcBaseSettingValueException	if you specify a value out of range for a setting.

Redefinition of

Method	Description
ezcConfigurationReader::setOptions()	Sets the options $options for the reader.