Config/Writer/Ini.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-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

Package: Zend\Config
Abstract File Writer
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

>VPropertyprotected\Zend_Config $_config = null
Default valuenullDetails
Type
\Zend_Config
Inherited_from
\Zend_Config_Writer::$$_config  
Inherited_from
\Zend_Config_Writer_FileAbstract::$$_config  
>VPropertyprotectedboolean $_exclusiveLock = false
inherited
Wether to exclusively lock the file or not
Inherited from: \Zend_Config_Writer_FileAbstract::$$_exclusiveLock
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Config_Writer_FileAbstract::$$_exclusiveLock  
>VPropertyprotectedstring $_filename = null
inherited
Filename to write to
Inherited from: \Zend_Config_Writer_FileAbstract::$$_filename
Default valuenullDetails
Type
string
Inherited_from
\Zend_Config_Writer_FileAbstract::$$_filename  
>VPropertyprotectedstring $_nestSeparator = '.'
String that separates nesting levels of configuration data identifiers
Default value'.'Details
Type
string
>VPropertyprotectedbool $_renderWithoutSections = false
If true the ini string is rendered in the global namespace without sections.
Default valuefalseDetails
Type
bool
>VPropertyprotectedarray $_skipOptions = array('options')
inherited
Option keys to skip when calling setOptions()
Inherited from: \Zend_Config_Writer::$$_skipOptions\Zend_Config_Writer_FileAbstract::$$_skipOptions
Default valuearray('options')Details
Type
array
Inherited_from
\Zend_Config_Writer::$$_skipOptions  
Inherited_from
\Zend_Config_Writer_FileAbstract::$$_skipOptions  

Methods

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

$options can only be passed as array or be omitted

Parameters
NameTypeDescription
$optionsnull | array
methodprotected_addBranch(\Zend_Config $config,  $parents = array()) : void

Add a branch to an INI string recursively

Parameters
NameTypeDescription
$config\Zend_Config
$parents
methodprotected_prepareValue(mixed $value) : string

Prepare a value for INI

Parameters
NameTypeDescription
$valuemixed
Returns
TypeDescription
string
methodprotected_sortRootElements(\Zend_Config $config) : \Zend_Config

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

Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Config
Details
See
\http://framework.zend.com/issues/browse/ZF-6289  
methodpublicrender() : string

Render a Zend_Config into a INI config string.

Returns
TypeDescription
string
Details
Since
1.10  
methodpublicsetConfig(\Zend_Config $config) : \Zend_Config_Writer
inherited

Set options via a Zend_Config instance

Inherited from: \Zend_Config_Writer::setConfig()\Zend_Config_Writer_FileAbstract::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Config_Writer
methodpublicsetExclusiveLock(boolean $exclusiveLock) : \Zend_Config_Writer_Array
inherited

Set wether to exclusively lock the file or not

Inherited from: \Zend_Config_Writer_FileAbstract::setExclusiveLock()
Parameters
NameTypeDescription
$exclusiveLockboolean
Returns
TypeDescription
\Zend_Config_Writer_Array
methodpublicsetFilename(string $filename) : \Zend_Config_Writer_Array
inherited

Set the target filename

Inherited from: \Zend_Config_Writer_FileAbstract::setFilename()
Parameters
NameTypeDescription
$filenamestring
Returns
TypeDescription
\Zend_Config_Writer_Array
methodpublicsetNestSeparator( $separator) : \Zend_Config_Writer_Ini

Set the nest separator

Parameters
NameTypeDescription
$separator
Returns
TypeDescription
\Zend_Config_Writer_Ini
methodpublicsetOptions(array $options) : \Zend_Config_Writer
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\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
NameTypeDescription
$withoutSectionsbool
Returns
TypeDescription
\Zend_Config_Writer_Ini
methodpublicwrite(string $filename = null, \Zend_Config $config = null, bool $exclusiveLock = null) : void
inherited

Write configuration to file.

Inherited from: \Zend_Config_Writer_FileAbstract::write()
Parameters
NameTypeDescription
$filenamestring
$config\Zend_Config
$exclusiveLockbool
Documentation was generated by phpDocumentor 2.0.0a12.