Zend_Config_Writer_Ini Class Reference

Inheritance diagram for Zend_Config_Writer_Ini:

Public Member Functions
	setNestSeparator ($separator)
	setRenderWithoutSections ($withoutSections=true)
	render ()
Public Member Functions inherited from Zend_Config_Writer_FileAbstract
	setFilename ($filename)
	setExclusiveLock ($exclusiveLock)
	write ($filename=null, Zend_Config $config=null, $exclusiveLock=null)
	render ()
Public Member Functions inherited from Zend_Config_Writer
	__construct (array $options=null)
	setConfig (Zend_Config $config)
	setOptions (array $options)
	write ()

Protected Member Functions
	_addBranch (Zend_Config $config, $parents=array())
	_prepareValue ($value)
	_sortRootElements (Zend_Config $config)

Protected Attributes
	$_nestSeparator = '.'
	$_renderWithoutSections = false
Protected Attributes inherited from Zend_Config_Writer_FileAbstract
	$_filename = null
	$_exclusiveLock = false
Protected Attributes inherited from Zend_Config_Writer
	$_skipOptions
	$_config = null

Detailed Description

Definition at line 33 of file Ini.php.

Member Function Documentation

_addBranch()

_addBranch ( Zend_Config  $config,   $parents = array()  )

protected

Add a branch to an INI string recursively

Parameters

Zend_Config

$config

Returns

void

Definition at line 124 of file Ini.php.

    {
        $iniString = '';

        foreach ($config as $key => $value) {
            $group = array_merge($parents, array($key));

            if ($value instanceof Zend_Config) {
                $iniString .= $this->_addBranch($value, $group);
            } else {
                $iniString .= implode($this->_nestSeparator, $group)
                           .  ' = '
                           .  $this->_prepareValue($value)
                           .  "\n";
            }
        }

        return $iniString;
    }

_prepareValue()

_prepareValue (   $value )

protected

Prepare a value for INI

Parameters

mixed

$value

Returns

string

See also

Zend_Config_Exception

Definition at line 150 of file Ini.php.

    {
        if (is_integer($value) || is_float($value)) {
            return $value;
        } elseif (is_bool($value)) {
            return ($value ? 'true' : 'false');
        } elseif (strpos($value, '"') === false) {
            return '"' . $value .  '"';
        } else {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception('Value can not contain double quotes "');
        }
    }

_sortRootElements()

_sortRootElements ( Zend_Config  $config )

protected

Root elements that are not assigned to any section needs to be on the top of config.

See also

http://framework.zend.com/issues/browse/ZF-6289

Parameters

Zend_Config

Returns

Zend_Config

Definition at line 173 of file Ini.php.

    {
        $configArray = $config->toArray();
        $sections = array();

        // remove sections from config array
        foreach ($configArray as $key => $value) {
            if (is_array($value)) {
                $sections[$key] = $value;
                unset($configArray[$key]);
            }
        }

        // readd sections to the end
        foreach ($sections as $key => $value) {
            $configArray[$key] = $value;
        }

        return new Zend_Config($configArray);
    }

render()

render

(

)

Render a Zend_Config into a INI config string.

Since

1.10

Returns

string

Definition at line 83 of file Ini.php.

    {
        $iniString   = '';
        $extends     = $this->_config->getExtends();
        $sectionName = $this->_config->getSectionName();

        if($this->_renderWithoutSections == true) {
            $iniString .= $this->_addBranch($this->_config);
        } else if (is_string($sectionName)) {
            $iniString .= '[' . $sectionName . ']' . "\n"
                       .  $this->_addBranch($this->_config)
                       .  "\n";
        } else {
            $config = $this->_sortRootElements($this->_config);
            foreach ($config as $sectionName => $data) {
                if (!($data instanceof Zend_Config)) {
                    $iniString .= $sectionName
                               .  ' = '
                               .  $this->_prepareValue($data)
                               .  "\n";
                } else {
                    if (isset($extends[$sectionName])) {
                        $sectionName .= ' : ' . $extends[$sectionName];
                    }

                    $iniString .= '[' . $sectionName . ']' . "\n"
                               .  $this->_addBranch($data)
                               .  "\n";
                }
            }
        }

        return $iniString;
    }

setNestSeparator()

setNestSeparator

(

$separator

)

Set the nest separator

Parameters

string

$filename

Returns

Zend_Config_Writer_Ini

Definition at line 55 of file Ini.php.

    {
        $this->_nestSeparator = $separator;

        return $this;
    }

setRenderWithoutSections()

setRenderWithoutSections

(

$withoutSections = true

)

Set if rendering should occour without sections or not.

If set to true, the INI file is rendered without sections completely into the global namespace of the INI file.

Parameters

bool

$withoutSections

Returns

Zend_Config_Writer_Ini

Definition at line 71 of file Ini.php.

    {
        $this->_renderWithoutSections = (bool)$withoutSections;
        return $this;
    }

Field Documentation

$_nestSeparator

$_nestSeparator = '.'

protected

Definition at line 40 of file Ini.php.

$_renderWithoutSections

$_renderWithoutSections = false

protected

Definition at line 47 of file Ini.php.

---

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

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