Zend_Config_Ini Class Reference

Inheritance diagram for Zend_Config_Ini:

Public Member Functions
	__construct ($filename, $section=null, $options=false)
Public Member Functions inherited from Zend_Config
	__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
	_parseIniFile ($filename)
	_loadIniFile ($filename)
	_processSection ($iniArray, $section, $config=array())
	_processKey ($config, $key, $value)
Protected Member Functions inherited from Zend_Config
	_assertValidExtend ($extendingSection, $extendedSection)
	_arrayMergeRecursive ($firstArray, $secondArray)

Protected Attributes
	$_nestSeparator = '.'
	$_sectionSeparator = ':'
	$_skipExtends = false
Protected Attributes inherited from Zend_Config
	$_allowModifications
	$_index
	$_count
	$_data
	$_skipNextIteration
	$_loadedSection
	$_extends = array()
	$_loadFileErrorStr = null

Detailed Description

Definition at line 35 of file Ini.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$filename,
			$section = null,
			$options = false
	)

Loads the section $section from the config file $filename for access facilitated by nested object properties.

If the section name contains a ":" then the section name to the right is loaded and included into the properties. Note that the keys in this $section will override any keys of the same name in the sections that have been included via ":".

If the $section is null, then all sections in the ini file are loaded.

If any key includes a ".", then this will act as a separator to create a sub-property.

example ini file: [all] db.connection = database hostname = live

[staging : all] hostname = staging

after calling $data = new Zend_Config_Ini($file, 'staging'); then $data->hostname === "staging" $data->db->connection === "database"

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 three configuration directives that may be set. For example:

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

Parameters

string	$filename
mixed	$section
boolean | array	$options

Exceptions

Zend_Config_Exception

Returns

void

See also

Zend_Config_Exception

Zend_Config_Exception

Definition at line 101 of file Ini.php.

    {
        if (empty($filename)) {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception('Filename is not set');
        }

        $allowModifications = false;
        if (is_bool($options)) {
            $allowModifications = $options;
        } elseif (is_array($options)) {
            if (isset($options['allowModifications'])) {
                $allowModifications = (bool) $options['allowModifications'];
            }
            if (isset($options['nestSeparator'])) {
                $this->_nestSeparator = (string) $options['nestSeparator'];
            }
            if (isset($options['skipExtends'])) {
                $this->_skipExtends = (bool) $options['skipExtends'];
            }
        }

        $iniArray = $this->_loadIniFile($filename);

        if (null === $section) {
            // Load entire file
            $dataArray = array();
            foreach ($iniArray as $sectionName => $sectionData) {
                if(!is_array($sectionData)) {
                    $dataArray = $this->_arrayMergeRecursive($dataArray, $this->_processKey(array(), $sectionName, $sectionData));
                } else {
                    $dataArray[$sectionName] = $this->_processSection($iniArray, $sectionName);
                }
            }
            parent::__construct($dataArray, $allowModifications);
        } else {
            // Load one or more sections
            if (!is_array($section)) {
                $section = array($section);
            }
            $dataArray = array();
            foreach ($section as $sectionName) {
                if (!isset($iniArray[$sectionName])) {
                    #require_once 'Zend/Config/Exception.php';
                    throw new Zend_Config_Exception("Section '$sectionName' cannot be found in $filename");
                }
                $dataArray = $this->_arrayMergeRecursive($this->_processSection($iniArray, $sectionName), $dataArray);

            }
            parent::__construct($dataArray, $allowModifications);
        }

        $this->_loadedSection = $section;
    }

Member Function Documentation

_loadIniFile()

_loadIniFile (   $filename )

protected

Load the ini file and preprocess the section separator (':' in the section name (that is used for section extension) so that the resultant array has the correct section names and the extension information is stored in a sub-key called ';extends'. We use ';extends' as this can never be a valid key name in an INI file that has been loaded using parse_ini_file().

Parameters

string

$filename

Exceptions

Zend_Config_Exception

Returns

array

See also

Zend_Config_Exception

Definition at line 200 of file Ini.php.

    {
        $loaded = $this->_parseIniFile($filename);
        $iniArray = array();
        foreach ($loaded as $key => $data)
        {
            $pieces = explode($this->_sectionSeparator, $key);
            $thisSection = trim($pieces[0]);
            switch (count($pieces)) {
                case 1:
                    $iniArray[$thisSection] = $data;
                    break;

                case 2:
                    $extendedSection = trim($pieces[1]);
                    $iniArray[$thisSection] = array_merge(array(';extends'=>$extendedSection), $data);
                    break;

                default:
                    #require_once 'Zend/Config/Exception.php';
                    throw new Zend_Config_Exception("Section '$thisSection' may not extend multiple sections in $filename");
            }
        }

        return $iniArray;
    }

_parseIniFile()

_parseIniFile (   $filename )

protected

Load the INI file from disk using parse_ini_file(). Use a private error handler to convert any loading errors into a Zend_Config_Exception

Parameters

string

$filename

Exceptions

Zend_Config_Exception

Returns

array

See also

Zend_Config_Exception

Definition at line 170 of file Ini.php.

    {
        set_error_handler(array($this, '_loadFileErrorHandler'));
        $iniArray = parse_ini_file($filename, true); // Warnings and errors are suppressed
        restore_error_handler();

        // Check if there was a error while loading file
        if ($this->_loadFileErrorStr !== null) {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception($this->_loadFileErrorStr);
        }

        return $iniArray;
    }

_processKey()

_processKey (   $config,   $key,   $value  )

protected

Assign the key's value to the property list. Handles the nest separator for sub-properties.

Parameters

array	$config
string	$key
string	$value

Exceptions

Zend_Config_Exception

Returns

array

See also

Zend_Config_Exception

Zend_Config_Exception

Definition at line 277 of file Ini.php.

    {
        if (strpos($key, $this->_nestSeparator) !== false) {
            $pieces = explode($this->_nestSeparator, $key, 2);
            if (strlen($pieces[0]) && strlen($pieces[1])) {
                if (!isset($config[$pieces[0]])) {
                    if ($pieces[0] === '0' && !empty($config)) {
                        // convert the current values in $config into an array
                        $config = array($pieces[0] => $config);
                    } else {
                        $config[$pieces[0]] = array();
                    }
                } elseif (!is_array($config[$pieces[0]])) {
                    #require_once 'Zend/Config/Exception.php';
                    throw new Zend_Config_Exception("Cannot create sub-key for '{$pieces[0]}' as key already exists");
                }
                $config[$pieces[0]] = $this->_processKey($config[$pieces[0]], $pieces[1], $value);
            } else {
                #require_once 'Zend/Config/Exception.php';
                throw new Zend_Config_Exception("Invalid key '$key'");
            }
        } else {
            $config[$key] = $value;
        }
        return $config;
    }

_processSection()

_processSection (   $iniArray,   $section,   $config = array()  )

protected

Process each element in the section and handle the ";extends" inheritance key. Passes control to _processKey() to handle the nest separator sub-property syntax that may be used within the key name.

Parameters

array	$iniArray
string	$section
array	$config

Exceptions

Zend_Config_Exception

Returns

array

See also

Zend_Config_Exception

Definition at line 241 of file Ini.php.

    {
        $thisSection = $iniArray[$section];

        foreach ($thisSection as $key => $value) {
            if (strtolower($key) == ';extends') {
                if (isset($iniArray[$value])) {
                    $this->_assertValidExtend($section, $value);

                    if (!$this->_skipExtends) {
                        $config = $this->_processSection($iniArray, $value, $config);
                    }
                } else {
                    #require_once 'Zend/Config/Exception.php';
                    throw new Zend_Config_Exception("Parent section '$section' cannot be found");
                }
            } else {
                $config = $this->_processKey($config, $key, $value);
            }
        }
        return $config;
    }

Field Documentation

$_nestSeparator

$_nestSeparator = '.'

protected

Definition at line 42 of file Ini.php.

$_sectionSeparator

$_sectionSeparator = ':'

protected

Definition at line 49 of file Ini.php.

$_skipExtends

$_skipExtends = false

protected

Definition at line 56 of file Ini.php.

---

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

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