Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 24
0.00% covered (danger)
0.00%
0 / 8
CRAP
0.00% covered (danger)
0.00%
0 / 1
DumpFileOutput
0.00% covered (danger)
0.00%
0 / 24
0.00% covered (danger)
0.00%
0 / 8
240
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 writeCloseStream
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 write
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 closeRenameAndReopen
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 renameOrException
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
6
 checkRenameArgCount
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
12
 closeAndRename
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
20
 getFilenames
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2/**
3 * Stream outputter to send data to a file.
4 *
5 * Copyright © 2003, 2005, 2006 Brooke Vibber <bvibber@wikimedia.org>
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 */
29class DumpFileOutput extends DumpOutput {
30    /** @var resource|false */
31    protected $handle = false;
32    /** @var string */
33    protected $filename;
34
35    /**
36     * @param string $file
37     */
38    public function __construct( $file ) {
39        $this->handle = fopen( $file, "wt" );
40        $this->filename = $file;
41    }
42
43    /**
44     * @param string $string
45     */
46    public function writeCloseStream( $string ) {
47        parent::writeCloseStream( $string );
48        if ( $this->handle ) {
49            fclose( $this->handle );
50            $this->handle = false;
51        }
52    }
53
54    /**
55     * @param string $string
56     */
57    public function write( $string ) {
58        fputs( $this->handle, $string );
59    }
60
61    /**
62     * @inheritDoc
63     */
64    public function closeRenameAndReopen( $newname ) {
65        $this->closeAndRename( $newname, true );
66    }
67
68    /**
69     * @param string $newname
70     */
71    protected function renameOrException( $newname ) {
72        if ( !rename( $this->filename, $newname ) ) {
73            throw new RuntimeException( __METHOD__ . ": rename of file {$this->filename} to $newname failed\n" );
74        }
75    }
76
77    /**
78     * @param string|string[] $newname
79     * @return string
80     * @throws MWException
81     */
82    protected function checkRenameArgCount( $newname ) {
83        if ( is_array( $newname ) ) {
84            if ( count( $newname ) > 1 ) {
85                throw new MWException( __METHOD__ . ": passed multiple arguments for rename of single file\n" );
86            }
87            $newname = $newname[0];
88        }
89        return $newname;
90    }
91
92    /**
93     * @inheritDoc
94     */
95    public 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    public function getFilenames() {
113        return $this->filename;
114    }
115}