Config/Xml.php

Show:

inherited

Classes
- \Zend_Config_Xml

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Config
Version: $Id: Xml.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Config_Xml
jump to top

Package: Zend\Config

XML Adapter for Zend_Config

Parent(s): \Zend_Config
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                XML_NAMESPACE
                = 'http://framework.zend.com/xml/zend-config-xml/1.0/'

XML namespace for ZF-related tags and attributes

Properties

boolean $_allowModifications

inherited

Whether in-memory modifications to configuration data are allowed

Inherited from: \Zend_Config::$$_allowModifications

Details

Type: boolean
Inherited_from: \Zend_Config::$$_allowModifications

integer $_count

inherited

Number of elements in configuration data

Inherited from: \Zend_Config::$$_count

Details

Type: integer
Inherited_from: \Zend_Config::$$_count

array $_data

inherited

Contains array of configuration data

Inherited from: \Zend_Config::$$_data

Details

Type: array
Inherited_from: \Zend_Config::$$_data

array $_extends = array()

inherited

This is used to track section inheritance.

Inherited from: \Zend_Config::$$_extends

The keys are names of sections that extend other sections, and the values are the extended sections.

Default valuearray()Details

Type: array
Inherited_from: \Zend_Config::$$_extends

integer $_index

inherited

Iteration index

Inherited from: \Zend_Config::$$_index

Details

Type: integer
Inherited_from: \Zend_Config::$$_index

string $_loadFileErrorStr = null

inherited

Load file error string.

Inherited from: \Zend_Config::$$_loadFileErrorStr

Is null if there was no error while file loading

Default valuenullDetails

Type: string
Inherited_from: \Zend_Config::$$_loadFileErrorStr

mixed $_loadedSection

inherited

Contains which config file sections were loaded.

Inherited from: \Zend_Config::$$_loadedSection

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.

Details

Type: mixed
Inherited_from: \Zend_Config::$$_loadedSection

boolean $_skipExtends = false

Whether to skip extends or not

Default valuefalseDetails

Type: boolean

boolean $_skipNextIteration

inherited

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

Inherited from: \Zend_Config::$$_skipNextIteration

Details

Type: boolean
Inherited_from: \Zend_Config::$$_skipNextIteration

Methods

__clone() : void

inherited

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

Inherited from: \Zend_Config::__clone()

__construct(string $xml, mixed $section = null, array | boolean $options = false) : void

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

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".

The $options parameter may be provided as either a boolean or an array. If provided as a boolean, this sets the $allowModifications option of Zend_Config. If provided as an array, there are two configuration directives that may be set. For example:

$options = array( 'allowModifications' => false, 'skipExtends' => false );

Parameters

Name	Type	Description
$xml	string	XML file or string to process
$section	mixed	Section to process
$options	array \| boolean

Throws

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

__get(string $name) : mixed

inherited

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

Inherited from: \Zend_Config::__get()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

__isset(string $name) : boolean

inherited

Support isset() overloading on PHP 5.1

Inherited from: \Zend_Config::__isset()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

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

inherited

Only allow setting of a property if $allowModifications was set to true on construction.

Inherited from: \Zend_Config::__set()

Otherwise, throw an exception.

Parameters

Name	Type	Description
$name	string
$value	mixed

Throws

Exception	Description
\Zend_Config_Exception

__unset(string $name) : void

inherited

Support unset() overloading on PHP 5.1

Inherited from: \Zend_Config::__unset()

Parameters

Name	Type	Description
$name	string

Throws

Exception	Description
\Zend_Config_Exception

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

inherited

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

Inherited from: \Zend_Config::_arrayMergeRecursive()

Parameters

Name	Type	Description
$firstArray	mixed	First array
$secondArray	mixed	Second array to merge into first array

Returns

Type	Description
array

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

inherited

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

Inherited from: \Zend_Config::_assertValidExtend()

Parameters

Name	Type	Description
$extendingSection	string
$extendedSection	string

Throws

Exception	Description
\Zend_Config_Exception

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

inherited

Handle any errors from simplexml_load_file or parse_ini_file

Inherited from: \Zend_Config::_loadFileErrorHandler()

Parameters

Name	Type	Description
$errno	integer
$errstr	string
$errfile	string
$errline	integer

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

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

Parameters

Name	Type	Description
$element	\SimpleXMLElement	XML Element to process
$section	string	Section to process
$config	array	Configuration which was parsed yet

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Config_Exception	When $section cannot be found

_toArray(\SimpleXMLElement $xmlObject) : array | string

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

Parameters

Name	Type	Description
$xmlObject	\SimpleXMLElement	Convert a SimpleXMLElement into an array

Returns

Type	Description
array \| string

areAllSectionsLoaded() : boolean

inherited

Returns true if all sections were loaded

Inherited from: \Zend_Config::areAllSectionsLoaded()

Returns

Type	Description
boolean

count() : int

inherited

Defined by Countable interface

Inherited from: \Zend_Config::count()

Returns

Type	Description
int

current() : mixed

inherited

Defined by Iterator interface

Inherited from: \Zend_Config::current()

Returns

Type	Description
mixed

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

inherited

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

Inherited from: \Zend_Config::get()

Parameters

Name	Type	Description
$name	string
$default	mixed

Returns

Type	Description
mixed

getExtends() : array

inherited

Get the current extends

Inherited from: \Zend_Config::getExtends()

Returns

Type	Description
array

getSectionName() : mixed

inherited

Returns the section name(s) loaded.

Inherited from: \Zend_Config::getSectionName()

Returns

Type	Description
mixed

key() : mixed

inherited

Defined by Iterator interface

Inherited from: \Zend_Config::key()

Returns

Type	Description
mixed

merge(\Zend_Config $merge) : \Zend_Config

inherited

Merge another Zend_Config with this one.

Inherited from: \Zend_Config::merge()

The items in $merge will override the same named items in the current config.

Parameters

Name	Type	Description
$merge	\Zend_Config

Returns

Type	Description
\Zend_Config

next() : void

inherited

Defined by Iterator interface

Inherited from: \Zend_Config::next()

readOnly() : boolean

inherited

Returns if this Zend_Config object is read only or not.

Inherited from: \Zend_Config::readOnly()

Returns

Type	Description
boolean

rewind() : void

inherited

Defined by Iterator interface

Inherited from: \Zend_Config::rewind()

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

inherited

Set an extend for Zend_Config_Writer

Inherited from: \Zend_Config::setExtend()

Parameters

Name	Type	Description
$extendingSection	string
$extendedSection	string

setReadOnly() : void

inherited

Prevent any more modifications being made to this instance.

Inherited from: \Zend_Config::setReadOnly()

Useful after merge() has been used to merge multiple Zend_Config objects into one object which should then not be modified again.

toArray() : array

inherited

Return an associative array of the stored data.

Inherited from: \Zend_Config::toArray()

Returns

Type	Description
array

valid() : boolean

inherited

Defined by Iterator interface

Inherited from: \Zend_Config::valid()

Returns

Type	Description
boolean

Config/Xml.php

\Zend_Config_Xmljump to top

Constants

Properties

Methods

\Zend_Config_Xml
jump to top