Abstract File Writer

category Zend
package Zend_Config
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Config_Writer_FileAbstract

 Methods

Create a new adapter

__construct(null|array $options = null
Inherited

$options can only be passed as array or be omitted

Parameters

$options

nullarray

Render a Zend_Config into a INI config string.

render() : string
since 1.10
inherited_from \Zend_Config_Writer_FileAbstract::render()

Returns

string

Render a Zend_Config into a config file string.

render() : string
Inherited
since 1.10
todo For 2.0 this should be redone into an abstract method.

Returns

string

Set options via a Zend_Config instance

setConfig(\Zend_Config $config) : \Zend_Config_Writer
Inherited

Parameters

$config

\Zend_Config

Returns

\Zend_Config_Writer

Set wether to exclusively lock the file or not

setExclusiveLock(boolean $exclusiveLock) : \Zend_Config_Writer_Array
Inherited

Parameters

$exclusiveLock

boolean

Returns

\Zend_Config_Writer_Array

Set the target filename

setFilename(string $filename) : \Zend_Config_Writer_Array
Inherited

Parameters

$filename

string

Returns

\Zend_Config_Writer_Array

Set the nest separator

setNestSeparator($separator) : \Zend_Config_Writer_Ini

Parameters

$separator

Returns

\Zend_Config_Writer_Ini

Set options via an array

setOptions(array $options) : \Zend_Config_Writer
Inherited

Parameters

$options

array

Returns

\Zend_Config_Writer

Set if rendering should occour without sections or not.

setRenderWithoutSections(boolean $withoutSections = true) : \Zend_Config_Writer_Ini

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

Parameters

$withoutSections

boolean

Returns

\Zend_Config_Writer_Ini

Write a Zend_Config object to it's target

write() : void
Inherited

Add a branch to an INI string recursively

_addBranch(\Zend_Config $config, $parents = array()) : void

Parameters

$config

\Zend_Config

$parents

Prepare a value for INI

_prepareValue(mixed $value) : string

Parameters

$value

mixed

Returns

string

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

_sortRootElements(\Zend_Config $config) : \Zend_Config
see

Parameters

$config

Returns

\Zend_Config

 Properties

 

Config object to write

$_config : \Zend_Config

Default

null
 

Wether to exclusively lock the file or not

$_exclusiveLock : boolean

Default

false
 

Filename to write to

$_filename : string

Default

null
 

String that separates nesting levels of configuration data identifiers

$_nestSeparator : string

Default

'.'
 

If true the ini string is rendered in the global namespace without sections.

$_renderWithoutSections : boolean

Default

false
 

Option keys to skip when calling setOptions()

$_skipOptions : array

Default

array('options')