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)
 

Public Attributes

 $filename
 

Protected Attributes

 $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 35 of file DumpFileOutput.php.

References $file.

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(), DumpPipeOutput\closeAndRename(), and closeAndRename().

◆ closeAndRename()

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

Definition at line 95 of file DumpFileOutput.php.

References checkRenameArgCount(), and renameOrException().

Referenced by closeRenameAndReopen().

◆ closeRenameAndReopen()

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

Definition at line 61 of file DumpFileOutput.php.

References closeAndRename().

◆ getFilenames()

DumpFileOutput::getFilenames ( )
Returns
string|null

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(), DumpPipeOutput\closeAndRename(), and closeAndRename().

◆ write()

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

Definition at line 54 of file DumpFileOutput.php.

◆ writeCloseStream()

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

Definition at line 43 of file DumpFileOutput.php.

Member Data Documentation

◆ $filename

DumpFileOutput::$filename

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: