Config/Writer/FileAbstract.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  
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 24593 2012-01-05 20:35:02Z matthew $  

Properties

>VPropertyprotected\Zend_Config $_config = null
inherited
Config object to write
Inherited from: \Zend_Config_Writer::$$_config
Default valuenullDetails
Type
\Zend_Config
Inherited_from
\Zend_Config_Writer::$$_config  
>VPropertyprotectedboolean $_exclusiveLock = false
Wether to exclusively lock the file or not
Default valuefalseDetails
Type
boolean
>VPropertyprotectedstring $_filename = null
Filename to write to
Default valuenullDetails
Type
string
>VPropertyprotectedarray $_skipOptions = array('options')
inherited
Option keys to skip when calling setOptions()
Inherited from: \Zend_Config_Writer::$$_skipOptions
Default valuearray('options')Details
Type
array
Inherited_from
\Zend_Config_Writer::$$_skipOptions  

Methods

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

Create a new adapter

Inherited from: \Zend_Config_Writer::__construct()

$options can only be passed as array or be omitted

Parameters
NameTypeDescription
$optionsnull | array
methodpublicrender() : string

Render a Zend_Config into a config file string.

Returns
TypeDescription
string
Details
Since
1.10  
Todo
For 2.0 this should be redone into an abstract method.  
methodpublicsetConfig(\Zend_Config $config) : \Zend_Config_Writer
inherited

Set options via a Zend_Config instance

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

Set wether to exclusively lock the file or not

Parameters
NameTypeDescription
$exclusiveLockboolean
Returns
TypeDescription
\Zend_Config_Writer_Array
methodpublicsetFilename(string $filename) : \Zend_Config_Writer_Array

Set the target filename

Parameters
NameTypeDescription
$filenamestring
Returns
TypeDescription
\Zend_Config_Writer_Array
methodpublicsetOptions(array $options) : \Zend_Config_Writer
inherited

Set options via an array

Inherited from: \Zend_Config_Writer::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Config_Writer
methodpublicwrite(string $filename = null, \Zend_Config $config = null, bool $exclusiveLock = null) : void

Write configuration to file.

Parameters
NameTypeDescription
$filenamestring
$config\Zend_Config
$exclusiveLockbool
Documentation was generated by phpDocumentor 2.0.0a12.