Config/Xml.php

Show: PublicProtectedPrivateinherited
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

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

>VConstant  XML_NAMESPACE = 'http://framework.zend.com/xml/zend-config-xml/1.0/'
XML namespace for ZF-related tags and attributes

Properties

>VPropertyprotectedboolean $_allowModifications
inherited
Whether in-memory modifications to configuration data are allowed
Inherited from: \Zend_Config::$$_allowModifications
Details
Type
boolean
Inherited_from
\Zend_Config::$$_allowModifications  
>VPropertyprotectedinteger $_count
inherited
Number of elements in configuration data
Inherited from: \Zend_Config::$$_count
Details
Type
integer
Inherited_from
\Zend_Config::$$_count  
>VPropertyprotectedarray $_data
inherited
Contains array of configuration data
Inherited from: \Zend_Config::$$_data
Details
Type
array
Inherited_from
\Zend_Config::$$_data  
>VPropertyprotectedarray $_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  
>VPropertyprotectedinteger $_index
inherited
Iteration index
Inherited from: \Zend_Config::$$_index
Details
Type
integer
Inherited_from
\Zend_Config::$$_index  
>VPropertyprotectedstring $_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  
>VPropertyprotectedmixed $_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  
>VPropertyprotectedboolean $_skipExtends = false
Whether to skip extends or not
Default valuefalseDetails
Type
boolean
>VPropertyprotectedboolean $_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

methodpublic__clone() : void
inherited

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

Inherited from: \Zend_Config::__clone()
methodpublic__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
NameTypeDescription
$xmlstring

XML file or string to process

$sectionmixed

Section to process

$optionsarray | boolean
Throws
ExceptionDescription
\Zend_Config_ExceptionWhen xml is not set or cannot be loaded
\Zend_Config_ExceptionWhen section $sectionName cannot be found in $xml
methodpublic__get(string $name) : mixed
inherited

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

Inherited from: \Zend_Config::__get()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
mixed
methodpublic__isset(string $name) : boolean
inherited

Support isset() overloading on PHP 5.1

Inherited from: \Zend_Config::__isset()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
boolean
methodpublic__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
NameTypeDescription
$namestring
$valuemixed
Throws
ExceptionDescription
\Zend_Config_Exception
methodpublic__unset(string $name) : void
inherited

Support unset() overloading on PHP 5.1

Inherited from: \Zend_Config::__unset()
Parameters
NameTypeDescription
$namestring
Throws
ExceptionDescription
\Zend_Config_Exception
methodprotected_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
NameTypeDescription
$firstArraymixed

First array

$secondArraymixed

Second array to merge into first array

Returns
TypeDescription
array
methodprotected_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
NameTypeDescription
$extendingSectionstring
$extendedSectionstring
Throws
ExceptionDescription
\Zend_Config_Exception
methodprotected_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
NameTypeDescription
$errnointeger
$errstrstring
$errfilestring
$errlineinteger
methodprotected_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
NameTypeDescription
$element\SimpleXMLElement

XML Element to process

$sectionstring

Section to process

$configarray

Configuration which was parsed yet

Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Config_ExceptionWhen $section cannot be found
methodprotected_toArray(\SimpleXMLElement $xmlObject) : array | string

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

Parameters
NameTypeDescription
$xmlObject\SimpleXMLElement

Convert a SimpleXMLElement into an array

Returns
TypeDescription
array | string
methodpublicareAllSectionsLoaded() : boolean
inherited

Returns true if all sections were loaded

Inherited from: \Zend_Config::areAllSectionsLoaded()
Returns
TypeDescription
boolean
methodpubliccount() : int
inherited

Defined by Countable interface

Inherited from: \Zend_Config::count()
Returns
TypeDescription
int
methodpubliccurrent() : mixed
inherited

Defined by Iterator interface

Inherited from: \Zend_Config::current()
Returns
TypeDescription
mixed
methodpublicget(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
NameTypeDescription
$namestring
$defaultmixed
Returns
TypeDescription
mixed
methodpublicgetExtends() : array
inherited

Get the current extends

Inherited from: \Zend_Config::getExtends()
Returns
TypeDescription
array
methodpublicgetSectionName() : mixed
inherited

Returns the section name(s) loaded.

Inherited from: \Zend_Config::getSectionName()
Returns
TypeDescription
mixed
methodpublickey() : mixed
inherited

Defined by Iterator interface

Inherited from: \Zend_Config::key()
Returns
TypeDescription
mixed
methodpublicmerge(\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
NameTypeDescription
$merge\Zend_Config
Returns
TypeDescription
\Zend_Config
methodpublicnext() : void
inherited

Defined by Iterator interface

Inherited from: \Zend_Config::next()
methodpublicreadOnly() : boolean
inherited

Returns if this Zend_Config object is read only or not.

Inherited from: \Zend_Config::readOnly()
Returns
TypeDescription
boolean
methodpublicrewind() : void
inherited

Defined by Iterator interface

Inherited from: \Zend_Config::rewind()
methodpublicsetExtend(string $extendingSection, string $extendedSection = null) : void
inherited

Set an extend for Zend_Config_Writer

Inherited from: \Zend_Config::setExtend()
Parameters
NameTypeDescription
$extendingSectionstring
$extendedSectionstring
methodpublicsetReadOnly() : 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.

methodpublictoArray() : array
inherited

Return an associative array of the stored data.

Inherited from: \Zend_Config::toArray()
Returns
TypeDescription
array
methodpublicvalid() : boolean
inherited

Defined by Iterator interface

Inherited from: \Zend_Config::valid()
Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.