1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Stream outputter to send data to a file. |
4
|
|
|
* |
5
|
|
|
* Copyright © 2003, 2005, 2006 Brion Vibber <[email protected]> |
6
|
|
|
* https://www.mediawiki.org/ |
7
|
|
|
* |
8
|
|
|
* This program is free software; you can redistribute it and/or modify |
9
|
|
|
* it under the terms of the GNU General Public License as published by |
10
|
|
|
* the Free Software Foundation; either version 2 of the License, or |
11
|
|
|
* (at your option) any later version. |
12
|
|
|
* |
13
|
|
|
* This program is distributed in the hope that it will be useful, |
14
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
15
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16
|
|
|
* GNU General Public License for more details. |
17
|
|
|
* |
18
|
|
|
* You should have received a copy of the GNU General Public License along |
19
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc., |
20
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
21
|
|
|
* http://www.gnu.org/copyleft/gpl.html |
22
|
|
|
* |
23
|
|
|
* @file |
24
|
|
|
*/ |
25
|
|
|
|
26
|
|
|
/** |
27
|
|
|
* @ingroup Dump |
28
|
|
|
*/ |
29
|
|
|
class DumpFileOutput extends DumpOutput { |
30
|
|
|
protected $handle = false, $filename; |
|
|
|
|
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* @param string $file |
34
|
|
|
*/ |
35
|
|
|
function __construct( $file ) { |
36
|
|
|
$this->handle = fopen( $file, "wt" ); |
|
|
|
|
37
|
|
|
$this->filename = $file; |
38
|
|
|
} |
39
|
|
|
|
40
|
|
|
/** |
41
|
|
|
* @param string $string |
42
|
|
|
*/ |
43
|
|
|
function writeCloseStream( $string ) { |
44
|
|
|
parent::writeCloseStream( $string ); |
45
|
|
|
if ( $this->handle ) { |
46
|
|
|
fclose( $this->handle ); |
47
|
|
|
$this->handle = false; |
48
|
|
|
} |
49
|
|
|
} |
50
|
|
|
|
51
|
|
|
/** |
52
|
|
|
* @param string $string |
53
|
|
|
*/ |
54
|
|
|
function write( $string ) { |
55
|
|
|
fputs( $this->handle, $string ); |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* @param string $newname |
60
|
|
|
*/ |
61
|
|
|
function closeRenameAndReopen( $newname ) { |
62
|
|
|
$this->closeAndRename( $newname, true ); |
63
|
|
|
} |
64
|
|
|
|
65
|
|
|
/** |
66
|
|
|
* @param string $newname |
67
|
|
|
* @throws MWException |
68
|
|
|
*/ |
69
|
|
|
function renameOrException( $newname ) { |
70
|
|
|
if ( !rename( $this->filename, $newname ) ) { |
71
|
|
|
throw new MWException( __METHOD__ . ": rename of file {$this->filename} to $newname failed\n" ); |
72
|
|
|
} |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
/** |
76
|
|
|
* @param array $newname |
77
|
|
|
* @return string |
78
|
|
|
* @throws MWException |
79
|
|
|
*/ |
80
|
|
|
function checkRenameArgCount( $newname ) { |
81
|
|
|
if ( is_array( $newname ) ) { |
82
|
|
|
if ( count( $newname ) > 1 ) { |
83
|
|
|
throw new MWException( __METHOD__ . ": passed multiple arguments for rename of single file\n" ); |
84
|
|
|
} else { |
85
|
|
|
$newname = $newname[0]; |
86
|
|
|
} |
87
|
|
|
} |
88
|
|
|
return $newname; |
89
|
|
|
} |
90
|
|
|
|
91
|
|
|
/** |
92
|
|
|
* @param string $newname |
93
|
|
|
* @param bool $open |
94
|
|
|
*/ |
95
|
|
|
function closeAndRename( $newname, $open = false ) { |
96
|
|
|
$newname = $this->checkRenameArgCount( $newname ); |
97
|
|
|
if ( $newname ) { |
98
|
|
|
if ( $this->handle ) { |
99
|
|
|
fclose( $this->handle ); |
100
|
|
|
$this->handle = false; |
101
|
|
|
} |
102
|
|
|
$this->renameOrException( $newname ); |
103
|
|
|
if ( $open ) { |
104
|
|
|
$this->handle = fopen( $this->filename, "wt" ); |
|
|
|
|
105
|
|
|
} |
106
|
|
|
} |
107
|
|
|
} |
108
|
|
|
|
109
|
|
|
/** |
110
|
|
|
* @return string|null |
111
|
|
|
*/ |
112
|
|
|
function getFilenames() { |
113
|
|
|
return $this->filename; |
114
|
|
|
} |
115
|
|
|
} |
116
|
|
|
|
Only declaring a single property per statement allows you to later on add doc comments more easily.
It is also recommended by PSR2, so it is a common style that many people expect.