API Documentation

Zend/Config/Writer/FileAbstract.php

Show: inherited
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  
Package
Writer  

\Zend_Config_Writer_FileAbstract

Package: Zend\package

Abstract File Writer

Parent(s)
\Zend_Config_Writer
Children
\Zend_Config_Writer_Array
\Zend_Config_Writer_Yaml
\Zend_Config_Writer_Json
\Zend_Config_Writer_Xml
\Zend_Config_Writer_Ini
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id: FileAbstract.php 24594 2012-01-05 21:27:01Z matthew $  

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

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.  
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
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.15.1.