MediaWiki  master
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
 closeAndRename ( $newname, $open=false)
 Close the old file, and move it to a specified name. More...
 
 closeRenameAndReopen ( $newname)
 Close the old file, move it to a specified name, and reopen new file with the old name. More...
 
 getFilenames ()
 Returns the name of the file or files which are being written to, if there are any. More...
 
 write ( $string)
 Override to write to a different stream type. More...
 
 writeClosePage ( $string)
 
 writeCloseStream ( $string)
 
 writeLogItem ( $rev, $string)
 
 writeOpenPage ( $page, $string)
 
 writeOpenStream ( $string)
 
 writeRevision ( $rev, $string)
 

Protected Attributes

string $filename
 
resource false $handle = false
 

Detailed Description

Definition at line 29 of file DumpFileOutput.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 38 of file DumpFileOutput.php.

References $file.

Member Function Documentation

◆ checkRenameArgCount()

DumpFileOutput::checkRenameArgCount (   $newname)
Parameters
string|string[]$newname
Returns
string
Exceptions
MWException

Definition at line 83 of file DumpFileOutput.php.

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

◆ closeAndRename()

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

Definition at line 98 of file DumpFileOutput.php.

References checkRenameArgCount(), and renameOrException().

Referenced by closeRenameAndReopen().

◆ closeRenameAndReopen()

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

Definition at line 64 of file DumpFileOutput.php.

References closeAndRename().

◆ getFilenames()

DumpFileOutput::getFilenames ( )
Returns
string|null

Definition at line 115 of file DumpFileOutput.php.

References $filename.

◆ renameOrException()

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

Definition at line 72 of file DumpFileOutput.php.

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

◆ write()

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

Definition at line 57 of file DumpFileOutput.php.

◆ writeCloseStream()

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

Definition at line 46 of file DumpFileOutput.php.

Member Data Documentation

◆ $filename

string DumpFileOutput::$filename
protected

Definition at line 33 of file DumpFileOutput.php.

Referenced by getFilenames().

◆ $handle

resource false DumpFileOutput::$handle = false
protected

Definition at line 31 of file DumpFileOutput.php.


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