Class: DatabaseConfigHandler

Source Location: /config/DatabaseConfigHandler.class.php

Class Overview

ParameterHolder
   |
   --ConfigHandler
      |
      --IniConfigHandler
         |
         --DatabaseConfigHandler

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

Author(s):

Sean Kerr (skerr@mojavi.org)

Version:

$Id: DatabaseConfigHandler.class.php 646 2004-12-10 14:41:41Z seank $

Copyright:

Methods

execute

Inherited Variables

Class: ParameterHolder

ParameterHolder::$parameters

Inherited Methods

Class: IniConfigHandler

IniConfigHandler::parseIni(): Parse an .ini configuration file.

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]
DatabaseConfigHandler allows you to setup database connections in a configuration file that will be created for you automatically upon first request.

Tags:

version:	$Id: DatabaseConfigHandler.class.php 646 2004-12-10 14:41:41Z seank $
since:	3.0.0
copyright:	(c) Sean Kerr, http://www.mojavi.org
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

Class Methods

method execute [line 47]

string &execute(
string
$config)

Execute this configuration handler.

Tags:

return:	Data to be written to a cache file.
access:	public
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.

Overrides ConfigHandler::execute() (Execute this configuration handler.)

Parameters:

string

$config

An absolute filesystem path to a configuration file.

[ Top ]

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