Zend_Config Class Reference

Inheritance diagram for Zend_Config:

Public Member Functions
	__construct (array $array, $allowModifications=false)
	get ($name, $default=null)
	__get ($name)
	__set ($name, $value)
	__clone ()
	toArray ()
	__isset ($name)
	__unset ($name)
	count ()
	current ()
	key ()
	next ()
	rewind ()
	valid ()
	getSectionName ()
	areAllSectionsLoaded ()
	merge (Zend_Config $merge)
	setReadOnly ()
	readOnly ()
	getExtends ()
	setExtend ($extendingSection, $extendedSection=null)
	_loadFileErrorHandler ($errno, $errstr, $errfile, $errline)

Protected Member Functions
	_assertValidExtend ($extendingSection, $extendedSection)
	_arrayMergeRecursive ($firstArray, $secondArray)

Protected Attributes
	$_allowModifications
	$_index
	$_count
	$_data
	$_skipNextIteration
	$_loadedSection
	$_extends = array()
	$_loadFileErrorStr = null

Detailed Description

Definition at line 29 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(	array	$array,
			$allowModifications = false
	)

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.

Parameters

array	$array
boolean	$allowModifications

Returns

void

Definition at line 105 of file Config.php.

    {
        $this->_allowModifications = (boolean) $allowModifications;
        $this->_loadedSection = null;
        $this->_index = 0;
        $this->_data = array();
        foreach ($array as $key => $value) {
            if (is_array($value)) {
                $this->_data[$key] = new self($value, $this->_allowModifications);
            } else {
                $this->_data[$key] = $value;
            }
        }
        $this->_count = count($this->_data);
    }

Member Function Documentation

__clone()

__clone

(

)

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

Returns

void

Definition at line 179 of file Config.php.

    {
      $array = array();
      foreach ($this->_data as $key => $value) {
          if ($value instanceof Zend_Config) {
              $array[$key] = clone $value;
          } else {
              $array[$key] = $value;
          }
      }
      $this->_data = $array;
    }

__get()

__get

(

$name

)

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

Parameters

string

$name

Returns

mixed

Definition at line 143 of file Config.php.

    {
        return $this->get($name);
    }

__isset()

__isset

(

$name

)

Support isset() overloading on PHP 5.1

Parameters

string

$name

Returns

boolean

Definition at line 217 of file Config.php.

    {
        return isset($this->_data[$name]);
    }

__set()

__set	(		$name,
			$value
	)

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

Parameters

string	$name
mixed	$value

Exceptions

Zend_Config_Exception

Returns

void

See also

Zend_Config_Exception

Definition at line 157 of file Config.php.

    {
        if ($this->_allowModifications) {
            if (is_array($value)) {
                $this->_data[$name] = new self($value, true);
            } else {
                $this->_data[$name] = $value;
            }
            $this->_count = count($this->_data);
        } else {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception('Zend_Config is read only');
        }
    }

__unset()

__unset

(

$name

)

Support unset() overloading on PHP 5.1

Parameters

string

$name

Exceptions

Zend_Config_Exception

Returns

void

See also

Zend_Config_Exception

Definition at line 229 of file Config.php.

    {
        if ($this->_allowModifications) {
            unset($this->_data[$name]);
            $this->_count = count($this->_data);
            $this->_skipNextIteration = true;
        } else {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception('Zend_Config is read only');
        }

    }

_arrayMergeRecursive()

_arrayMergeRecursive (   $firstArray,   $secondArray  )

protected

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

Parameters

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

Returns

array

Definition at line 464 of file Config.php.

    {
        if (is_array($firstArray) && is_array($secondArray)) {
            foreach ($secondArray as $key => $value) {
                if (isset($firstArray[$key])) {
                    $firstArray[$key] = $this->_arrayMergeRecursive($firstArray[$key], $value);
                } else {
                    if($key === 0) {
                        $firstArray= array(0=>$this->_arrayMergeRecursive($firstArray, $value));
                    } else {
                        $firstArray[$key] = $value;
                    }
                }
            }
        } else {
            $firstArray = $secondArray;
        }

        return $firstArray;
    }

_assertValidExtend()

_assertValidExtend (   $extendingSection,   $extendedSection  )

protected

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

Parameters

string	$extendingSection
string	$extendedSection

Exceptions

Zend_Config_Exception

Returns

void

See also

Zend_Config_Exception

Definition at line 423 of file Config.php.

    {
        // detect circular section inheritance
        $extendedSectionCurrent = $extendedSection;
        while (array_key_exists($extendedSectionCurrent, $this->_extends)) {
            if ($this->_extends[$extendedSectionCurrent] == $extendingSection) {
                #require_once 'Zend/Config/Exception.php';
                throw new Zend_Config_Exception('Illegal circular inheritance detected');
            }
            $extendedSectionCurrent = $this->_extends[$extendedSectionCurrent];
        }
        // remember that this section extends another section
        $this->_extends[$extendingSection] = $extendedSection;
    }

_loadFileErrorHandler()

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

Handle any errors from simplexml_load_file or parse_ini_file

Parameters

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

Definition at line 447 of file Config.php.

    {
        if ($this->_loadFileErrorStr === null) {
            $this->_loadFileErrorStr = $errstr;
        } else {
            $this->_loadFileErrorStr .= (PHP_EOL . $errstr);
        }
    }

areAllSectionsLoaded()

areAllSectionsLoaded

(

)

Returns true if all sections were loaded

Returns

boolean

Definition at line 327 of file Config.php.

    {
        return $this->_loadedSection === null;
    }

count()

count

(

)

Defined by Countable interface

Returns

int

Definition at line 248 of file Config.php.

    {
        return $this->_count;
    }

current()

current

(

)

Defined by Iterator interface

Returns

mixed

Definition at line 258 of file Config.php.

    {
        $this->_skipNextIteration = false;
        return current($this->_data);
    }

get()

get	(		$name,
			$default = null
	)

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

Parameters

string	$name
mixed	$default

Returns

mixed

Definition at line 128 of file Config.php.

    {
        $result = $default;
        if (array_key_exists($name, $this->_data)) {
            $result = $this->_data[$name];
        }
        return $result;
    }

getExtends()

getExtends

(

)

Get the current extends

Returns

array

Definition at line 393 of file Config.php.

    {
        return $this->_extends;
    }

getSectionName()

getSectionName

(

)

Returns the section name(s) loaded.

Returns

mixed

Definition at line 314 of file Config.php.

    {
        if(is_array($this->_loadedSection) && count($this->_loadedSection) == 1) {
            $this->_loadedSection = $this->_loadedSection[0];
        }
        return $this->_loadedSection;
    }

key()

key

(

)

Defined by Iterator interface

Returns

mixed

Definition at line 269 of file Config.php.

    {
        return key($this->_data);
    }

merge()

merge

(

Zend_Config

$merge

)

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

Parameters

Zend_Config

$merge

Returns

Zend_Config

Definition at line 341 of file Config.php.

    {
        foreach($merge as $key => $item) {
            if(array_key_exists($key, $this->_data)) {
                if($item instanceof Zend_Config && $this->$key instanceof Zend_Config) {
                    $this->$key = $this->$key->merge(new Zend_Config($item->toArray(), !$this->readOnly()));
                } else {
                    $this->$key = $item;
                }
            } else {
                if($item instanceof Zend_Config) {
                    $this->$key = new Zend_Config($item->toArray(), !$this->readOnly());
                } else {
                    $this->$key = $item;
                }
            }
        }

        return $this;
    }

next()

next

(

)

Defined by Iterator interface

Definition at line 278 of file Config.php.

    {
        if ($this->_skipNextIteration) {
            $this->_skipNextIteration = false;
            return;
        }
        next($this->_data);
        $this->_index++;
    }

readOnly()

readOnly

(

)

Returns if this Zend_Config object is read only or not.

Returns

boolean

Definition at line 383 of file Config.php.

    {
        return !$this->_allowModifications;
    }

rewind()

rewind

(

)

Defined by Iterator interface

Definition at line 292 of file Config.php.

    {
        $this->_skipNextIteration = false;
        reset($this->_data);
        $this->_index = 0;
    }

setExtend()

setExtend	(		$extendingSection,
			$extendedSection = null
	)

Set an extend for Zend_Config_Writer

Parameters

string	$extendingSection
string	$extendedSection

Returns

void

Definition at line 405 of file Config.php.

    {
        if ($extendedSection === null && isset($this->_extends[$extendingSection])) {
            unset($this->_extends[$extendingSection]);
        } else if ($extendedSection !== null) {
            $this->_extends[$extendingSection] = $extendedSection;
        }
    }

setReadOnly()

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.

Definition at line 368 of file Config.php.

    {
        $this->_allowModifications = false;
        foreach ($this->_data as $key => $value) {
            if ($value instanceof Zend_Config) {
                $value->setReadOnly();
            }
        }
    }

toArray()

toArray

(

)

Return an associative array of the stored data.

Returns

array

Definition at line 197 of file Config.php.

    {
        $array = array();
        $data = $this->_data;
        foreach ($data as $key => $value) {
            if ($value instanceof Zend_Config) {
                $array[$key] = $value->toArray();
            } else {
                $array[$key] = $value;
            }
        }
        return $array;
    }

valid()

valid

(

)

Defined by Iterator interface

Returns

boolean

Definition at line 304 of file Config.php.

    {
        return $this->_index < $this->_count;
    }

Field Documentation

$_allowModifications

$_allowModifications

protected

Definition at line 36 of file Config.php.

$_count

$_count

protected

Definition at line 50 of file Config.php.

$_data

$_data

protected

Definition at line 57 of file Config.php.

$_extends

$_extends = array()

protected

Definition at line 82 of file Config.php.

$_index

$_index

protected

Definition at line 43 of file Config.php.

$_loadedSection

$_loadedSection

protected

Definition at line 74 of file Config.php.

$_loadFileErrorStr

$_loadFileErrorStr = null

protected

Definition at line 91 of file Config.php.

$_skipNextIteration

$_skipNextIteration

protected

Definition at line 65 of file Config.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Config.php