Class: IniConfigHandler

Source Location: /config/IniConfigHandler.class.php

Class Overview

ParameterHolder
   |
   --ConfigHandler
      |
      --IniConfigHandler

IniConfigHandler is a base class for .ini configuration handlers. This class provides a central location for parsing ini files and detecting required categories.

Author(s):

Sean Kerr (skerr@mojavi.org)

Version:

$Id: IniConfigHandler.class.php 506 2004-11-29 02:30:31Z seank $

Copyright:

Methods

parseIni

Child classes:

DatabaseConfigHandler: DatabaseConfigHandler allows you to setup database connections in a configuration file that will be created for you automatically upon first request.

RootConfigHandler: RootConfigHandler allows you to specify configuration handlers for the application or on a module level.

FilterConfigHandler: FilterConfigHandler allows you to register filters with the system.

ModuleConfigHandler: ModuleConfigHandler reads module configuration files to determine the status of a module.

ValidatorConfigHandler: ValidatorConfigHandler allows you to register validators with the system.

FactoryConfigHandler: FactoryConfigHandler allows you to specify which factory implementation the system will use.

AutoloadConfigHandler: AutoloadConfigHandler allows you to specify a list of classes that will automatically be included for you upon first use.

DefineConfigHandler: DefineConfigHandler allows you to turn ini categories and key/value pairs into defined PHP values.

Inherited Variables

Class: ParameterHolder

ParameterHolder::$parameters

Inherited Methods

Class: ConfigHandler

ConfigHandler::addReplacement(): Add a set of replacement values.
ConfigHandler::execute(): Execute this configuration handler.
ConfigHandler::initialize(): Initialize this ConfigHandler.
ConfigHandler::literalize(): Literalize a string value.
ConfigHandler::replaceConstants(): Replace constant identifiers in a string.
ConfigHandler::replacePath(): Replace a relative filesystem path with an absolute one.

Class: ParameterHolder

ParameterHolder::clearParameters(): Clear all parameters associated with this request.
ParameterHolder::getParameter(): Retrieve a parameter.
ParameterHolder::getParameterNames(): Retrieve an array of parameter names.
ParameterHolder::getParameters(): Retrieve an array of parameters.
ParameterHolder::hasParameter(): Indicates whether or not a parameter exists.
ParameterHolder::removeParameter(): Remove a parameter.
ParameterHolder::setParameter(): Set a parameter.
ParameterHolder::setParameterByRef(): Set a parameter by reference.
ParameterHolder::setParameters(): Set an array of parameters.
ParameterHolder::setParametersByRef(): Set an array of parameters by reference.

Class Details

[line 25]
IniConfigHandler is a base class for .ini configuration handlers. This class provides a central location for parsing ini files and detecting required categories.

Tags:

abstract:
version:	$Id: IniConfigHandler.class.php 506 2004-11-29 02:30:31Z seank $
since:	3.0.0
copyright:	(c) Sean Kerr, http://www.mojavi.org
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

Class Methods

method parseIni [line 47]

string &parseIni(
string
$config)

Parse an .ini configuration file.

Tags:

return:	A parsed .ini configuration.
access:	protected
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	ConfigurationException If a requested configuration file does not exist or is not readable.
throws:	ParseException If a requested configuration file is improperly formatted.

Parameters:

string

$config

An absolute filesystem path to a configuration file.

[ Top ]

Documentation generated on Tue, 21 Feb 2006 01:45:19 +0900 by phpDocumentor 1.3.0RC5