API Documentation

Config/Writer/Ini.php

Zend Framework

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Config  
version
$Id: Ini.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Config_Writer_Ini

Abstract File Writer

Extends from
\Zend_Config_Writer_FileAbstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Config  
version
$Id: FileAbstract.php 23775 2011-03-01 17:25:24Z ralph $  

Properties

Propertyprotectedstring  $_nestSeparator= '.'

String that separates nesting levels of configuration data identifiers

Default value.Details
Type
string
Propertyprotectedbool  $_renderWithoutSections= 'false'

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

Default valuefalseDetails
Type
bool

Methods

methodpublic__construct( null|array $options = null ) : void

Create a new adapter

Inherited from: \Zend_Config_Writer::__construct()

$options can only be passed as array or be omitted

Parameters
Name Type Description
$options null|array
methodprotected_addBranch( \Zend_Config $config,  $parents = array ) : void

Add a branch to an INI string recursively

Parameters
Name Type Description
$config \Zend_Config
$parents
methodprotected_prepareValue( mixed $value ) : string

Prepare a value for INI

Parameters
Name Type Description
$value mixed
Returns
Type Description
string
methodprotected_sortRootElements(  $config ) : \Zend_Config

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

Parameters
Name Type Description
$config Zend_Config
Returns
Type Description
\Zend_Config
Details
see
\http://framework.zend.com/issues/browse/ZF-6289  
methodpublicrender( ) : string

Render a Zend_Config into a INI config string.

Returns
Type Description
string
Details
since
1.10  
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Config_Writer

Set options via a Zend_Config instance

Inherited from: \Zend_Config_Writer::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Config_Writer
methodpublicsetExclusiveLock( boolean $exclusiveLock ) : \Zend_Config_Writer_Array

Set wether to exclusively lock the file or not

Inherited from: \Zend_Config_Writer_FileAbstract::setExclusiveLock()
Parameters
Name Type Description
$exclusiveLock boolean
Returns
Type Description
\Zend_Config_Writer_Array
methodpublicsetFilename( string $filename ) : \Zend_Config_Writer_Array

Set the target filename

Inherited from: \Zend_Config_Writer_FileAbstract::setFilename()
Parameters
Name Type Description
$filename string
Returns
Type Description
\Zend_Config_Writer_Array
methodpublicsetNestSeparator(  $separator ) : \Zend_Config_Writer_Ini

Set the nest separator

Parameters
Name Type Description
$separator
Returns
Type Description
\Zend_Config_Writer_Ini
methodpublicsetOptions( array $options ) : \Zend_Config_Writer

Set options via an array

Inherited from: \Zend_Config_Writer::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Config_Writer
methodpublicsetRenderWithoutSections( 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.

Parameters
Name Type Description
$withoutSections bool
Returns
Type Description
\Zend_Config_Writer_Ini
methodpublicwrite( string $filename = null, \Zend_Config $config = null, bool $exclusiveLock = null ) : void

Write configuration to file.

Inherited from: \Zend_Config_Writer_FileAbstract::write()
Parameters
Name Type Description
$filename string
$config \Zend_Config
$exclusiveLock bool
Documentation was generated by DocBlox 0.13.3.