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

Class: Config_Container_PHPConstants

Source Location: /Config-1.10.12/Config/Container/PHPConstants.php

Class Overview

Config_Container
   |
   --Config_Container_PHPConstants

Config parser for PHP constant files


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods

Class: Config_Container

Config_Container::Config_Container()
Constructor
Config_Container::addItem()
Adds an item to this item.
Config_Container::countChildren()
Returns how many children this container has
Config_Container::createBlank()
Adds a blank line to this item.
Config_Container::createComment()
Adds a comment to this item.
Config_Container::createDirective()
Adds a directive to this item.
Config_Container::createItem()
Create a child for this item.
Config_Container::createSection()
Adds a section to this item.
Config_Container::directiveContent()
Return a child directive's content.
Config_Container::getAttribute()
Get one attribute value of this item
Config_Container::getAttributes()
Get this item's attributes.
Config_Container::getChild()
Returns the item parent object.
Config_Container::getContent()
Get this item's content.
Config_Container::getItem()
Tries to find the specified item(s) and returns the objects.
Config_Container::getItemIndex()
Returns the item index in its parent children array.
Config_Container::getItemPosition()
Returns the item rank in its parent children array according to other items with same type and name.
Config_Container::getName()
Get this item's name.
Config_Container::getParent()
Returns the item parent object.
Config_Container::getType()
Get this item's type.
Config_Container::isRoot()
Is this item root, in a config container object
Config_Container::removeItem()
Deletes an item (section, directive, comment...) from the current object
Config_Container::searchPath()
Finds a node using XPATH like format.
Config_Container::setAttributes()
Set this item's attributes.
Config_Container::setContent()
Set this item's content.
Config_Container::setDirective()
Set a children directive content.
Config_Container::setName()
Set this item's name.
Config_Container::setType()
Set this item's type.
Config_Container::toArray()
Returns a key/value pair array of the container and its children.
Config_Container::toString()
Call the toString methods in the container plugin
Config_Container::updateAttributes()
Set this item's attributes.
Config_Container::writeDatasrc()
Writes the configuration to a file

Class Details

[line 25]
Config parser for PHP constant files


[ Top ]


Class Variables

$options = array(
        'lowercase' => false
    )

[line 33]

Valid config options:
  • "lowercase" - boolean - config names are lowercased when reading them


Type:   array


[ Top ]



Method Detail

Config_Container_PHPConstants (Constructor)   [line 44]

Config_Container_PHPConstants Config_Container_PHPConstants( [string $options = array()])

Constructor
  • Access: public

Parameters:

string   $options     (optional)Options to be used by renderer

[ Top ]

parseDatasrc   [line 59]

mixed &parseDatasrc( string $datasrc, object &$obj)

Parses the data of the given configuration file
  • Return: PEAR_ERROR, if error occurs or true if ok
  • Access: public

Parameters:

string   $datasrc     Path to the configuration file
object   &$obj     Reference to a config object

[ Top ]

toString   [line 128]

string toString( object &$obj)

Returns a formatted string of the object
  • Access: public

Overrides Config_Container::toString() (Call the toString methods in the container plugin)

Parameters:

object   &$obj     Container object to be output as string

[ Top ]

writeDatasrc   [line 188]

mixed writeDatasrc( mixed $datasrc, string &$obj)

Writes the configuration to a file
  • Return: PEAR_Error on failure or boolean true if all went well
  • Access: public

Overrides Config_Container::writeDatasrc() (Writes the configuration to a file)

Parameters:

mixed   $datasrc     Info on datasource such as path to the file
string   &$obj     Configuration object to write

[ Top ]


Documentation generated on Fri, 24 Dec 2010 08:30:05 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.