MediaWiki  1.23.14
DumpFileOutput Class Reference

Stream outputter to send data to a file. More...

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)
 

Public Attributes

 $filename
 

Protected Attributes

 $handle = false
 

Detailed Description

Stream outputter to send data to a file.

Definition at line 981 of file Export.php.

Constructor & Destructor Documentation

◆ __construct()

DumpFileOutput::__construct (   $file)
Parameters
$file

Reimplemented in Dump7ZipOutput, DumpBZip2Output, DumpGZipOutput, and DumpDBZip2Output.

Definition at line 987 of file Export.php.

References $file.

Member Function Documentation

◆ checkRenameArgCount()

DumpFileOutput::checkRenameArgCount (   $newname)
Parameters
$newnamearray
Returns
mixed
Exceptions
MWException

Definition at line 1032 of file Export.php.

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

◆ closeAndRename()

DumpFileOutput::closeAndRename (   $newname,
  $open = false 
)
Parameters
$newnamemixed
$openbool

Reimplemented from DumpOutput.

Reimplemented in Dump7ZipOutput, and DumpPipeOutput.

Definition at line 1047 of file Export.php.

References checkRenameArgCount(), and renameOrException().

Referenced by closeRenameAndReopen().

◆ closeRenameAndReopen()

DumpFileOutput::closeRenameAndReopen (   $newname)
Parameters
$newname

Reimplemented from DumpOutput.

Reimplemented in DumpPipeOutput.

Definition at line 1013 of file Export.php.

References closeAndRename().

◆ getFilenames()

DumpFileOutput::getFilenames ( )
Returns
string|null

Reimplemented from DumpOutput.

Definition at line 1064 of file Export.php.

References $filename.

◆ renameOrException()

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

Definition at line 1021 of file Export.php.

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

◆ write()

DumpFileOutput::write (   $string)
Parameters
$stringstring

Reimplemented from DumpOutput.

Definition at line 1006 of file Export.php.

◆ writeCloseStream()

DumpFileOutput::writeCloseStream (   $string)
Parameters
$stringstring

Reimplemented from DumpOutput.

Reimplemented in DumpPipeOutput.

Definition at line 995 of file Export.php.

Member Data Documentation

◆ $filename

DumpFileOutput::$filename

Definition at line 982 of file Export.php.

Referenced by getFilenames().

◆ $handle

DumpFileOutput::$handle = false
protected

Definition at line 982 of file Export.php.


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