Class Zend_Config

Description

Implements interfaces:

  • Countable (internal interface)
  • Iterator (internal interface)

  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Config.php (line 35)


	
			
Direct descendents
Class Description
 class Zend_Config_Ini
 class Zend_Config_Xml
Variable Summary
 integer $_count
 array $_data
 array $_extends
 integer $_index
Method Summary
 Zend_Config __construct (array $array, [boolean $allowModifications = false])
 array asArray ()
 int count ()
 mixed current ()
 mixed getSectionName ()
 mixed key ()
 void next ()
 void rewind ()
 boolean valid ()
 void _assertValidExtend (string $extendingSection, string $extendedSection)
 boolean _isValidKeyName (string $key)
 mixed __get (string $name)
 boolean __isset (string $name)
 void __set (string $name, mixed $value)
Variables
boolean $_allowModifications (line 42)

Whether in-memory modifications to configuration data are allowed

  • access: protected
integer $_count (line 56)

Number of elements in configuration data

  • access: protected
array $_data (line 63)

Contains array of configuration data

  • access: protected
array $_extends = array() (line 81)

This is used to track section inheritance. The keys are names of sections that extend other sections, and the values are the extended sections.

  • access: protected
integer $_index (line 49)

Iteration index

  • access: protected
mixed $_loadedSection (line 73)

Contains which config file sections were loaded. This is null if all sections were loaded, a string name if one section is loaded and an array of string names if multiple sections were loaded.

  • access: protected
Methods
Constructor __construct (line 95)

Zend_Config provides a property based interface to an array. The data are read-only unless $allowModifications is set to true on construction.

Zend_Config also implements Countable and Iterator to facilitate easy access to the data.

  • access: public
  • throws: Zend_Config_Exception
Zend_Config __construct (array $array, [boolean $allowModifications = false])
  • array $array
  • boolean $allowModifications

Redefined in descendants as:
areAllSectionsLoaded (line 267)

Returns true if all sections were loaded

  • access: public
boolean areAllSectionsLoaded ()
asArray (line 168)

Return an associative array of the stored data.

  • access: public
array asArray ()
count (line 197)

Defined by Countable interface

  • access: public
int count ()

Implementation of:
Countable::count
current (line 207)

Defined by Iterator interface

  • access: public
mixed current ()

Implementation of:
Iterator::current
getSectionName (line 257)

Returns the section name(s) loaded.

  • access: public
mixed getSectionName ()
key (line 217)

Defined by Iterator interface

  • access: public
mixed key ()

Implementation of:
Iterator::key
next (line 226)

Defined by Iterator interface

  • access: public
void next ()

Implementation of:
Iterator::next
rewind (line 236)

Defined by Iterator interface

  • access: public
void rewind ()

Implementation of:
Iterator::rewind
valid (line 247)

Defined by Iterator interface

  • access: public
boolean valid ()

Implementation of:
Iterator::valid
_assertValidExtend (line 280)

Throws an exception if $extendingSection may not extend $extendedSection, and tracks the section extension if it is valid.

  • access: protected
  • throws: Zend_Config_Exception
void _assertValidExtend (string $extendingSection, string $extendedSection)
  • string $extendingSection
  • string $extendedSection
_isValidKeyName (line 121)

Ensure that the key is a valid PHP property name

  • access: protected
boolean _isValidKeyName (string $key)
  • string $key
__get (line 132)

Magic function so that $obj->value will work.

  • access: public
mixed __get (string $name)
  • string $name
__isset (line 187)

Support isset() overloading on PHP 5.1

  • access: protected
boolean __isset (string $name)
  • string $name
__set (line 149)

Only allow setting of a property if $allowModifications was set to true on construction. Otherwise, throw an exception.

  • access: public
  • throws: Zend_Config_Exception
void __set (string $name, mixed $value)
  • string $name
  • mixed $value

Documentation generated on Wed, 21 Feb 2007 11:46:21 -0800 by phpDocumentor 1.3.1