FileAbstract.class.php
3.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?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.Util.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@Util.com so we can send you a copy immediately.
*
* @category Util
* @package Util_Common_Config
* @package Writer
* @copyright Copyright (c) 2005-2010 Util Technologies USA Inc. (http://www.Util.com)
* @license http://framework.Util.com/license/new-bsd New BSD License
*/
// require_once "Util/Config/Writer.php";
/**
* Abstract File Writer
*
* @category Util
* @package Util_package
* @copyright Copyright (c) 2005-2010 Util Technologies USA Inc. (http://www.Zend.com)
* @license http://framework.Zend.com/license/new-bsd New BSD License
* @version $Id: FileAbstract.class.php 20096 2010-01-06 02:05:09Z bkarwin $
*/
class Util_Common_Config_Writer_FileAbstract extends Util_Common_Config_Writer
{
/**
* Filename to write to
*
* @var string
*/
protected $_filename = null;
/**
* Wether to exclusively lock the file or not
*
* @var boolean
*/
protected $_exclusiveLock = false;
/**
* Set the target filename
*
* @param string $filename
* @return Util_Common_Config_Writer_Array
*/
public function setFilename($filename)
{
$this->_filename = $filename;
return $this;
}
/**
* Set wether to exclusively lock the file or not
*
* @param boolean $exclusiveLock
* @return Util_Common_Config_Writer_Array
*/
public function setExclusiveLock($exclusiveLock)
{
$this->_exclusiveLock = $exclusiveLock;
return $this;
}
/**
* Write configuration to file.
*
* @param string $filename
* @param Util_Common_Config $config
* @param bool $exclusiveLock
* @return void
*/
public function write($filename = null, Util_Common_Config $config = null, $exclusiveLock = null)
{
if ($filename !== null) {
$this->setFilename($filename);
}
if ($config !== null) {
$this->setConfig($config);
}
if ($exclusiveLock !== null) {
$this->setExclusiveLock($exclusiveLock);
}
if ($this->_filename === null) {
// require_once 'Util/Config/Exception.php';
throw new Util_Common_Config_Exception('No filename was set');
}
if ($this->_config === null) {
// require_once 'Util/Config/Exception.php';
throw new Util_Common_Config_Exception('No config was set');
}
$configString = $this->render();
$flags = 0;
if ($this->_exclusiveLock) {
$flags |= LOCK_EX;
}
$result = @file_put_contents($this->_filename, $configString, $flags);
if ($result === false) {
// require_once 'Util/Config/Exception.php';
throw new Util_Common_Config_Exception('Could not write to file "' . $this->_filename . '"');
}
}
/**
* Render a Util_Common_Config into a config file string.
*
* @since 1.10
* @todo For 2.0 this should be redone into an abstract method.
* @return string
*/
public function render()
{
return "";
}
}