Config.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Config
version: $Id: Config.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Config

Description

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.

Zend_Config
jump to top

Implements
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Config
Properties: $_allowModifications; $_index; $_count; $_data; $_skipNextIteration; $_loadedSection; $_extends; $_loadFileErrorStr
Methods: __construct; get; __get; __set; __clone; toArray; __isset; __unset; count; current; key; next; rewind; valid; getSectionName; areAllSectionsLoaded; merge; setReadOnly; readOnly; getExtends; setExtend; _assertValidExtend; _loadFileErrorHandler; _arrayMergeRecursive

Description

Properties

$_allowModifications
jump to class

boolean $_allowModifications = ''

Whether in-memory modifications to configuration data are allowed

Details

$_allowModifications: boolean
visibility: protected
default
final: false
static: false

$_count
jump to class

integer $_count = ''

Number of elements in configuration data

Details

$_count: integer
visibility: protected
default
final: false
static: false

$_data
jump to class

array $_data = ''

Contains array of configuration data

Details

$_data: array
visibility: protected
default
final: false
static: false

$_extends
jump to class

array $_extends = 'array'

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

Details

$_extends: array
visibility: protected
default: array
final: false
static: false

$_index
jump to class

integer $_index = ''

Iteration index

Details

$_index: integer
visibility: protected
default
final: false
static: false

$_loadFileErrorStr
jump to class

string $_loadFileErrorStr = 'null'

Load file error string.

Is null if there was no error while file loading

Details

$_loadFileErrorStr: string
visibility: protected
default: null
final: false
static: false

$_loadedSection
jump to class

mixed $_loadedSection = ''

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.

Details

$_loadedSection: mixed
visibility: protected
default
final: false
static: false

$_skipNextIteration
jump to class

boolean $_skipNextIteration = ''

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

Details

$_skipNextIteration: boolean
visibility: protected
default
final: false
static: false

Methods

__clone
jump to class

__clone(
          
          )
        
        :
        void

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

Details

visibility: public
final: false
static: false

__construct
jump to class

__construct(
          array $array, boolean $allowModifications
              =
              false
          )
        
        :
        void

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.

Arguments

$array: array
$allowModifications: boolean

Details

visibility: public
final: false
static: false

__get
jump to class

__get(
          string $name
          )
        
        :
        mixed

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

Arguments

$name: string

Output

mixed

Details

visibility: public
final: false
static: false

__isset
jump to class

__isset(
          string $name
          )
        
        :
        boolean

Support isset() overloading on PHP 5.1

Arguments

$name: string

Output

boolean

Details

visibility: public
final: false
static: false

__set
jump to class

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

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

Arguments

$name: string
$value: mixed

Details

visibility: public
final: false
static: false
throws

__unset
jump to class

__unset(
          string $name
          )
        
        :
        void

Support unset() overloading on PHP 5.1

Arguments

$name: string

Details

visibility: public
final: false
static: false
throws

_arrayMergeRecursive
jump to class

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

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

Arguments

$firstArray: mixed
First array
$secondArray: mixed
Second array to merge into first array

Output

array

Details

visibility: protected
final: false
static: false

_assertValidExtend
jump to class

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

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

Arguments

$extendingSection: string
$extendedSection: string

Details

visibility: protected
final: false
static: false
throws

_loadFileErrorHandler
jump to class

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

Handle any errors from simplexml_load_file or parse_ini_file

Arguments

$errno: integer
$errstr: string
$errfile: string
$errline: integer

Details

visibility: protected
final: false
static: false

areAllSectionsLoaded
jump to class

areAllSectionsLoaded(
          
          )
        
        :
        boolean

Returns true if all sections were loaded

Output

boolean

Details

visibility: public
final: false
static: false

count
jump to class

Defined by Countable interface

Output

int

Details

visibility: public
final: false
static: false

current
jump to class

current(
          
          )
        
        :
        mixed

Defined by Iterator interface

Output

mixed

Details

visibility: public
final: false
static: false

get
jump to class

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

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

Arguments

$name: string
$default: mixed

Output

mixed

Details

visibility: public
final: false
static: false

getExtends
jump to class

getExtends(
          
          )
        
        :
        array

Get the current extends

Output

array

Details

visibility: public
final: false
static: false

getSectionName
jump to class

getSectionName(
          
          )
        
        :
        mixed

Returns the section name(s) loaded.

Output

mixed

Details

visibility: public
final: false
static: false

key
jump to class

Defined by Iterator interface

Output

mixed

Details

visibility: public
final: false
static: false

merge
jump to class

merge(
          Zend_Config $merge
          )
        
        :
        Zend_Config

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

Arguments

$merge: Zend_Config

Output

Zend_Config

Details

visibility: public
final: false
static: false

next
jump to class

Defined by Iterator interface

Details

visibility: public
final: false
static: false

readOnly
jump to class

readOnly(
          
          )
        
        :
        boolean

Returns if this Zend_Config object is read only or not.

Output

boolean

Details

visibility: public
final: false
static: false

rewind
jump to class

Defined by Iterator interface

Details

visibility: public
final: false
static: false

setExtend
jump to class

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

Set an extend for Zend_Config_Writer

Arguments

$extendingSection: string
$extendedSection: string

Details

visibility: public
final: false
static: false

setReadOnly
jump to class

setReadOnly(
          
          )
        
        :

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.

Details

visibility: public
final: false
static: false

toArray
jump to class

toArray(
          
          )
        
        :
        array

Return an associative array of the stored data.

Output

array

Details

visibility: public
final: false
static: false

valid
jump to class

valid(
          
          )
        
        :
        boolean

Defined by Iterator interface

Output

boolean

Details

visibility: public
final: false
static: false

API Documentation

Config.php

Description

Zend_Configjump to top

Description

Properties

$_allowModificationsjump to class

Details

$_countjump to class

Details

$_datajump to class

Details

$_extendsjump to class

Details

$_indexjump to class

Details

$_loadFileErrorStrjump to class

Details

$_loadedSectionjump to class

Details

$_skipNextIterationjump to class

Details

Methods

__clonejump to class

Details

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__issetjump to class

Arguments

Output

Details

__setjump to class

Arguments

Details

__unsetjump to class

Arguments

Details

_arrayMergeRecursivejump to class

Arguments

Output

Details

_assertValidExtendjump to class

Arguments

Details

_loadFileErrorHandlerjump to class

Arguments

Details

areAllSectionsLoadedjump to class

Output

Details

countjump to class

Output

Details

currentjump to class

Output

Details

getjump to class

Arguments

Output

Details

getExtendsjump to class

Output

Details

getSectionNamejump to class

Output

Details

keyjump to class

Output

Details

mergejump to class

Arguments

Output

Details

nextjump to class

Details

Zend_Config
jump to top

$_allowModifications
jump to class

$_count
jump to class

$_data
jump to class

$_extends
jump to class

$_index
jump to class

$_loadFileErrorStr
jump to class

$_loadedSection
jump to class

$_skipNextIteration
jump to class

__clone
jump to class

__construct
jump to class

__get
jump to class

__isset
jump to class

__set
jump to class

__unset
jump to class

_arrayMergeRecursive
jump to class

_assertValidExtend
jump to class

_loadFileErrorHandler
jump to class

areAllSectionsLoaded
jump to class

count
jump to class

current
jump to class

get
jump to class

getExtends
jump to class

getSectionName
jump to class

key
jump to class

merge
jump to class

next
jump to class

readOnly
jump to class

rewind
jump to class

setExtend
jump to class

setReadOnly
jump to class

toArray
jump to class

valid
jump to class