Docs For Class Config

array getBlocks(
string
$block)

returns the name of all childblocks

The implementation returns the name of all childblocks in the given block as a array. If a childblock contains also childblocks the value of the block have to be also a array containing all grandchild-blocks

Return: returns a array containing all values, or a PEAR_Error, if fails
See: Config_Container::getValues()
Access: public

Parameters:

string $block — block path

[ Top ]

mixed getValue(
string
$block, string
$key, [string
$default = ""])

returns the value of the key in the given block

The implementation returns the value of the key in the given block. If the key or the block not exist the implementation should return the default-value and create the block with the key and the default-value.

Return: type depends of the value
See: Config_Container::getValues()
Access: public

Parameters:

string	`$block`	—	block path
string	`$key`	—	key
string	`$default`	—	default-value

[ Top ]

array getValues(
string
$block)

returns all key-value-pairs of the given block

The implementation should returns only the pairs of the given block, no names of subblocks. Blocks should be looks like this "/rootblock/child_block/grandchild_block/..." Take care of the leading slash - this is a "root"-slash according to the "root"-dir under Unix. If a config data source contains no blocks or using of blocks makes no sense the implementation have to support at least the root-slash.

Return: returns a hash containing all values, but a PEAR_Error if fails
Access: public

Parameters:

string $block — block path

[ Top ]

mixed parseInput(
[string
$datasrc = ""], [array
$feature = array()])

parses the input of the given data source

The format and required content of $datasrc depends of the implementation. If the implemention requires additional data, for example a comment char, it have to deliver in a hash as second argument.

Return: returns a PEAR_ERROR, if error occurs
Access: public

Overridden in child classes as:

Config_Container_db::parseInput(): parses the input of the given data source

Config_Container_IniFile::parseInput(): parses the input of the given data source

Config_Container_phpIniFile::parseInput(): parses the input of the given data source

Config_Container_wddx::parseInput(): parses the input of the given data source

Config_Container_xml::parseInput(): parses the input of the given data source

Parameters:

string	`$datasrc`	—	Name of the datasource to parse
array	`$feature`	—	Contains a hash of features depending on the implentation

[ Top ]

void setFeatures(
array
$requested, array
$allowed)

Imports the requested datafields as object variables if allowed

Parameters:

array	`$requested`	—	List of fields to be imported as object variables
array	`$allowed`	—	List of allowed datafields

[ Top ]

mixed setValue(
string
$block, string
$key, string
$value)

sets the value of the key in the given block

The implementation sets the value of the key in the given block and returns value. If the key or the block not exist, the implementation should create the block with the key and the value.

Return: type depends on $value
See: Config_Container::getValue()
Access: public

Parameters:

string	`$block`	—	block path
string	`$key`	—	key
string	`$value`	—	value to set

[ Top ]

mixed writeInput(
[string
$datasrc = ""], [boolean
$preserve = true])

writes the data to the given data source or if not given to the datasource of parseInput

See parseInput for $datasrc. If the second argument $preserve is true, the implementation should try to preserve the original format and data of the source except changed or added values. This mean to preserve for example comments in files or so.

Return: returns PEAR_Error, if fails
See: Config_Container::parseInput()
Access: public

Overridden in child classes as:

Config_Container_db::writeInput(): writes the data to the given data source or if not given to the datasource of parseInput If $datasrc was a array, the last file will used.

Config_Container_IniFile::writeInput(): writes the data to the given data source or if not given to the datasource of parseInput If $datasrc was a array, the last file will used.

Config_Container_phpIniFile::writeInput(): Relay for writeInput in Config_Container_IniFile::writeInput(); uses the wonderfull trick of $this being inherited on static method calls

Config_Container_wddx::writeInput(): writes the data to the given data source or if not given to the datasource of parseInput If $datasrc was a array, the last file will used.

Parameters:

string	`$datasrc`	—	Name of the datasource to parse
boolean	`$preserve`	—	preserving behavior

[ Top ]

Class: Config_Container

Class Overview

Author(s):

Version:

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

getBlocks [line 109]

Parameters:

getValue [line 129]

Parameters:

getValues [line 90]

Parameters:

parseInput [line 49]

Parameters:

setFeatures [line 163]

Parameters:

setValue [line 150]

Parameters:

writeInput [line 69]

Parameters: