Config/Writer/Ini.php
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: Ini.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Config_Writer_Ini
- Parent(s)
- \Zend_Config_Writer_FileAbstract < \Zend_Config_Writer
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: FileAbstract.php 24593 2012-01-05 20:35:02Z matthew $
Properties


\Zend_Config $_config = null
null
Details- Type
- \Zend_Config
- Inherited_from
- \Zend_Config_Writer::$$_config
- Inherited_from
- \Zend_Config_Writer_FileAbstract::$$_config


boolean $_exclusiveLock = false
false
Details- Type
- boolean
- Inherited_from
- \Zend_Config_Writer_FileAbstract::$$_exclusiveLock


string $_filename = null
null
Details- Type
- string
- Inherited_from
- \Zend_Config_Writer_FileAbstract::$$_filename


string $_nestSeparator = '.'
'.'
Details- Type
- string


bool $_renderWithoutSections = false
false
Details- Type
- bool


array $_skipOptions = array('options')
array('options')
Details- Type
- array
- Inherited_from
- \Zend_Config_Writer::$$_skipOptions
- Inherited_from
- \Zend_Config_Writer_FileAbstract::$$_skipOptions
Methods


__construct(null | array $options = null) : void
Create a new adapter
Inherited from: \Zend_Config_Writer::__construct()\Zend_Config_Writer_FileAbstract::__construct()$options can only be passed as array or be omitted
Name | Type | Description |
---|---|---|
$options | null | array |


_addBranch(\Zend_Config $config, $parents = array()) : void
Add a branch to an INI string recursively
Name | Type | Description |
---|---|---|
$config | \Zend_Config | |
$parents |


_prepareValue(mixed $value) : string
Prepare a value for INI
Name | Type | Description |
---|---|---|
$value | mixed |
Type | Description |
---|---|
string |


_sortRootElements(\Zend_Config $config) : \Zend_Config
Root elements that are not assigned to any section needs to be on the top of config.
Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Config |
- See
- \http://framework.zend.com/issues/browse/ZF-6289


render() : string
Render a Zend_Config into a INI config string.
Type | Description |
---|---|
string |
- Since
- 1.10


setConfig(\Zend_Config $config) : \Zend_Config_Writer
Set options via a Zend_Config instance
Inherited from: \Zend_Config_Writer::setConfig()\Zend_Config_Writer_FileAbstract::setConfig()Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Config_Writer |


setExclusiveLock(boolean $exclusiveLock) : \Zend_Config_Writer_Array
Set wether to exclusively lock the file or not
Inherited from: \Zend_Config_Writer_FileAbstract::setExclusiveLock()Name | Type | Description |
---|---|---|
$exclusiveLock | boolean |
Type | Description |
---|---|
\Zend_Config_Writer_Array |


setFilename(string $filename) : \Zend_Config_Writer_Array
Name | Type | Description |
---|---|---|
$filename | string |
Type | Description |
---|---|
\Zend_Config_Writer_Array |


setNestSeparator( $separator) : \Zend_Config_Writer_Ini
Set the nest separator
Name | Type | Description |
---|---|---|
$separator |
Type | Description |
---|---|
\Zend_Config_Writer_Ini |


setOptions(array $options) : \Zend_Config_Writer
Set options via an array
Inherited from: \Zend_Config_Writer::setOptions()\Zend_Config_Writer_FileAbstract::setOptions()Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Config_Writer |


setRenderWithoutSections(bool $withoutSections = true) : \Zend_Config_Writer_Ini
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.
Name | Type | Description |
---|---|---|
$withoutSections | bool |
Type | Description |
---|---|
\Zend_Config_Writer_Ini |


write(string $filename = null, \Zend_Config $config = null, bool $exclusiveLock = null) : void
Name | Type | Description |
---|---|---|
$filename | string | |
$config | \Zend_Config | |
$exclusiveLock | bool |