MediaWiki REL1_31
DumpFileOutput Class Reference
Inheritance diagram for DumpFileOutput:
Collaboration diagram for DumpFileOutput:

Public Member Functions

 __construct ( $file)
 
 checkRenameArgCount ( $newname)
 
 closeAndRename ( $newname, $open=false)
 
 closeRenameAndReopen ( $newname)
 
 getFilenames ()
 
 renameOrException ( $newname)
 
 write ( $string)
 
 writeCloseStream ( $string)
 
- Public Member Functions inherited from DumpOutput
 writeClosePage ( $string)
 
 writeLogItem ( $rev, $string)
 
 writeOpenPage ( $page, $string)
 
 writeOpenStream ( $string)
 
 writeRevision ( $rev, $string)
 

Protected Attributes

 $filename
 
 $handle = false
 

Detailed Description

Definition at line 29 of file DumpFileOutput.php.

Constructor & Destructor Documentation

◆ __construct()

DumpFileOutput::__construct ( $file)
Parameters
string$file

Reimplemented in DumpBZip2Output, DumpDBZip2Output, and DumpGZipOutput.

Definition at line 35 of file DumpFileOutput.php.

Member Function Documentation

◆ checkRenameArgCount()

DumpFileOutput::checkRenameArgCount ( $newname)
Parameters
array$newname
Returns
string
Exceptions
MWException

Definition at line 80 of file DumpFileOutput.php.

Referenced by Dump7ZipOutput\closeAndRename(), closeAndRename(), and DumpPipeOutput\closeAndRename().

◆ closeAndRename()

DumpFileOutput::closeAndRename ( $newname,
$open = false )
Parameters
string$newname
bool$open

Reimplemented from DumpOutput.

Reimplemented in Dump7ZipOutput, and DumpPipeOutput.

Definition at line 95 of file DumpFileOutput.php.

References checkRenameArgCount(), and renameOrException().

Referenced by closeRenameAndReopen().

◆ closeRenameAndReopen()

DumpFileOutput::closeRenameAndReopen ( $newname)
Parameters
string$newname

Reimplemented from DumpOutput.

Reimplemented in DumpPipeOutput.

Definition at line 61 of file DumpFileOutput.php.

References closeAndRename().

◆ getFilenames()

DumpFileOutput::getFilenames ( )
Returns
string|null

Reimplemented from DumpOutput.

Definition at line 112 of file DumpFileOutput.php.

References $filename.

◆ renameOrException()

DumpFileOutput::renameOrException ( $newname)
Parameters
string$newname
Exceptions
MWException

Definition at line 69 of file DumpFileOutput.php.

Referenced by Dump7ZipOutput\closeAndRename(), closeAndRename(), and DumpPipeOutput\closeAndRename().

◆ write()

DumpFileOutput::write ( $string)
Parameters
string$string

Reimplemented from DumpOutput.

Definition at line 54 of file DumpFileOutput.php.

◆ writeCloseStream()

DumpFileOutput::writeCloseStream ( $string)
Parameters
string$string

Reimplemented from DumpOutput.

Reimplemented in DumpPipeOutput.

Definition at line 43 of file DumpFileOutput.php.

Member Data Documentation

◆ $filename

DumpFileOutput::$filename
protected

Definition at line 30 of file DumpFileOutput.php.

Referenced by getFilenames().

◆ $handle

DumpFileOutput::$handle = false
protected

Definition at line 30 of file DumpFileOutput.php.


The documentation for this class was generated from the following file: