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

Class: Config

Source Location: /Config-1.0/Config.php

Class Overview


Config


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 43]
Config

This class allows for parsing and editing of configuration datasources. Do not use this class only to read datasources because of the overhead it creates to keep track of the configuration structure.



[ Top ]


Class Variables

$container =

[line 56]

Container object

Type:   object


[ Top ]

$datasrc =

[line 50]

Datasource Can be a file url, a dsn, an object...

Type:   mixed


[ Top ]



Method Detail

Config (Constructor)   [line 72]

mixed Config( string $container, [array $options = null])

Constructor Initializes a container and returns its root element.

Requires the type of data container. If the container needs special parameters upon initialization, set them in $options. The format and required content of object 'datasrc' depend on the chosen container.

  • Return: PEAR_Error on error or container root element
  • Access: public

Parameters:

string   $container     (optional)Container
array   $options     (optional)Array of options for the container

[ Top ]

isContainerRegistered   [line 95]

bool isContainerRegistered( string $container)

Returns true if container is registered
  • Access: public

Parameters:

string   $container     type of container

[ Top ]

parseConfig   [line 106]

mixed &parseConfig( mixed $datasrc)

Parses the datasource contents
  • Return: PEAR_Error on error or Config_Container object
  • Access: public

Parameters:

mixed   $datasrc     Datasource to work with

[ Top ]

writeConfig   [line 118]

mixed writeConfig( [mixed $datasrc = null])

Writes the container contents to datasource
  • Return: PEAR_Error on error or true if ok
  • Access: public

Parameters:

mixed   $datasrc     (optional)Datasource to write to

[ Top ]


Documentation generated on Fri, 30 Apr 2004 21:44:39 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.