API Documentation

Config/Writer/FileAbstract.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  
package
Writer  

\Zend_Config_Writer_FileAbstract

Abstract File Writer

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

Properties

Propertyprotectedboolean  $_exclusiveLock= 'false'

Wether to exclusively lock the file or not

Default valuefalseDetails
Type
boolean
Propertyprotectedstring  $_filename= 'null'

Filename to write to

Default valuenullDetails
Type
string

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
methodpublicrender( ) : string

Render a Zend_Config into a config file string.

Returns
Type Description
string
Details
since
1.10  
todo
For 2.0 this should be redone into an abstract method.  
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

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

Set the target filename

Parameters
Name Type Description
$filename string
Returns
Type Description
\Zend_Config_Writer_Array
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
methodpublicwrite( string $filename = null, \Zend_Config $config = null, bool $exclusiveLock = null ) : void

Write configuration to file.

Parameters
Name Type Description
$filename string
$config \Zend_Config
$exclusiveLock bool
Documentation was generated by DocBlox 0.13.3.