mojavi
[ class tree: mojavi ] [ index: mojavi ] [ all elements ]

Class: DefineConfigHandler

Source Location: /config/DefineConfigHandler.class.php

Class Overview

ParameterHolder
   |
   --ConfigHandler
      |
      --IniConfigHandler
         |
         --DefineConfigHandler

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


Author(s):

  • Sean Kerr (skerr@mojavi.org)

Version:

  • $Id: DefineConfigHandler.class.php 744 2005-01-07 17:28:15Z seank $

Copyright:

Methods


Inherited Variables

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 28]
DefineConfigHandler allows you to turn ini categories and key/value pairs into defined PHP values.

Optional initialization parameters:

  • prefix - The text prepended to all defined constant names.




Tags:

version:  $Id: DefineConfigHandler.class.php 744 2005-01-07 17:28:15Z 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 50]

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:15 +0900 by phpDocumentor 1.3.0RC5