phpDocumentor » \Zend_Config

XML Adapter for Zend_Config

category	Zend
package	Zend_Config
copyright	Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License

Methods

Deep clone of this instance to ensure that nested Zend_Configs are also cloned.

__clone() : void

Inherited

inherited_from	\Zend_Config::__clone()

Loads the section $section from the config file (or string $xml for access facilitated by nested object properties.

__construct(string $xml, mixed $section, boolean $options) : void

Sections are defined in the XML as children of the root element. In order to extend another section, a section defines the "extends" attribute having a value of the section name from which the extending section inherits values. Note that the keys in $section will override any keys of the same name in the sections that have been included via "extends".

Parameters

$xml

string

XML file or string to process

$section

mixed

Section to process

$options

boolean

Whether modifiacations are allowed at runtime

Exceptions

`\Zend_Config_Exception`	When xml is not set or cannot be loaded
`\Zend_Config_Exception`	When section $sectionName cannot be found in $xml

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

__get(string $name) : mixed

Inherited

inherited_from	\Zend_Config::__get()

Parameters

$name

string

Returns

mixed

Support isset() overloading on PHP 5.1

__isset(string $name) : boolean

Inherited

inherited_from	\Zend_Config::__isset()

Parameters

$name

string

Returns

boolean

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

__set(string $name, mixed $value) : void

Inherited

inherited_from	\Zend_Config::__set()

Parameters

$name

string

$value

mixed

Exceptions

`\Zend_Config_Exception`

Support unset() overloading on PHP 5.1

__unset(string $name) : void

Inherited

inherited_from	\Zend_Config::__unset()

Parameters

$name

string

Exceptions

`\Zend_Config_Exception`

Returns true if all sections were loaded

areAllSectionsLoaded() : boolean

Inherited

inherited_from	\Zend_Config::areAllSectionsLoaded()

Returns

boolean

Defined by Countable interface

count() : int

Inherited

inherited_from	\Zend_Config::count()

Returns

int

Defined by Iterator interface

current() : mixed

Inherited

inherited_from	\Zend_Config::current()

Returns

mixed

Retrieve a value and return $default if there is no element set.

get(string $name, mixed $default) : mixed

Inherited

inherited_from	\Zend_Config::get()

Parameters

$name

string

$default

mixed

Returns

mixed

Get the current extends

getExtends() : array

Inherited

inherited_from	\Zend_Config::getExtends()

Returns

array

Returns the section name(s) loaded.

getSectionName() : mixed

Inherited

inherited_from	\Zend_Config::getSectionName()

Returns

mixed

Defined by Iterator interface

key() : mixed

Inherited

inherited_from	\Zend_Config::key()

Returns

mixed

Merge another Zend_Config with this one. The items in $merge will override the same named items in the current config.

merge(Zend_Config $merge) : \Zend_Config

Inherited

inherited_from	\Zend_Config::merge()

Parameters

$merge

\Zend_Config

Returns

\Zend_Config

Defined by Iterator interface

next()

Inherited

inherited_from	\Zend_Config::next()

Returns if this Zend_Config object is read only or not.

readOnly() : boolean

Inherited

inherited_from	\Zend_Config::readOnly()

Returns

boolean

Defined by Iterator interface

rewind()

Inherited

inherited_from	\Zend_Config::rewind()

Set an extend for Zend_Config_Writer

setExtend(string $extendingSection, string $extendedSection) : void

Inherited

inherited_from	\Zend_Config::setExtend()

Parameters

$extendingSection

string

$extendedSection

string

Prevent any more modifications being made to this instance. Useful after merge() has been used to merge multiple Zend_Config objects into one object which should then not be modified again.

setReadOnly()

Inherited

inherited_from	\Zend_Config::setReadOnly()

Return an associative array of the stored data.

toArray() : array

Inherited

inherited_from	\Zend_Config::toArray()

Returns

array

Defined by Iterator interface

valid() : boolean

Inherited

inherited_from	\Zend_Config::valid()

Returns

boolean

Merge two arrays recursively, overwriting keys of the same name in $firstArray with the value in $secondArray.

_arrayMergeRecursive(mixed $firstArray, mixed $secondArray) : array

Parameters

$firstArray

mixed

First array

$secondArray

mixed

Second array to merge into first array

Returns

array

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

_assertValidExtend(string $extendingSection, string $extendedSection) : void

Inherited

inherited_from	\Zend_Config::_assertValidExtend()

Parameters

$extendingSection

string

$extendedSection

string

Exceptions

`\Zend_Config_Exception`

Handle any errors from simplexml_load_file or parse_ini_file

_loadFileErrorHandler(integer $errno, string $errstr, string $errfile, integer $errline)

Inherited

inherited_from	\Zend_Config::_loadFileErrorHandler()

Parameters

$errno

integer

$errstr

string

$errfile

string

$errline

integer

Helper function to process each element in the section and handle the "extends" inheritance attribute.

_processExtends(SimpleXMLElement $element, string $section, array $config) : array

Parameters

$element

\SimpleXMLElement

XML Element to process

$section

string

Section to process

$config

array

Configuration which was parsed yet

Exceptions

`\Zend_Config_Exception`	When $section cannot be found

Returns

array

Returns a string or an associative and possibly multidimensional array from a SimpleXMLElement.

_toArray(SimpleXMLElement $xmlObject) : array | string

Parameters

$xmlObject

\SimpleXMLElement

Convert a SimpleXMLElement into an array

Returns

arraystring

Properties

Whether in-memory modifications to configuration data are allowed

$_allowModifications : boolean

Inherited

inherited_from	\Zend_Config::$$_allowModifications

Number of elements in configuration data

$_count : integer

Inherited

inherited_from	\Zend_Config::$$_count

Contains array of configuration data

$_data : array

Inherited

inherited_from	\Zend_Config::$$_data

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

$_extends : array

Inherited

inherited_from	\Zend_Config::$$_extends

Iteration index

$_index : integer

Inherited

inherited_from	\Zend_Config::$$_index

Load file error string.

$_loadFileErrorStr : string

Inherited

Is null if there was no error while file loading

inherited_from	\Zend_Config::$$_loadFileErrorStr

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.

$_loadedSection : mixed

Inherited

inherited_from	\Zend_Config::$$_loadedSection

Wether to skip extends or not

$_skipExtends : boolean

Used when unsetting values during iteration to ensure we do not skip the next element

$_skipNextIteration : boolean

Inherited

inherited_from	\Zend_Config::$$_skipNextIteration

Constants

XML namespace for ZF-related tags and attributes

XML_NAMESPACE