MediaWiki  1.23.2
DumpOutput Class Reference

Base class for output stream; prints to stdout or buffer or wherever. More...

Inheritance diagram for DumpOutput:

Public Member Functions

 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)
 

Detailed Description

Base class for output stream; prints to stdout or buffer or wherever.

Definition at line 890 of file Export.php.

Member Function Documentation

◆ closeAndRename()

DumpOutput::closeAndRename (   $newname,
  $open = false 
)

Close the old file, and move it to a specified name.

Use this for the last piece of a file written out at specified checkpoints (e.g. every n hours).

Parameters
$newnamemixed File name. May be a string or an array with one element
bool$openIf true, a new file with the old filename will be opened again for writing (default: false)

Reimplemented in Dump7ZipOutput, DumpPipeOutput, and DumpFileOutput.

Definition at line 964 of file Export.php.

◆ closeRenameAndReopen()

DumpOutput::closeRenameAndReopen (   $newname)

Close the old file, move it to a specified name, and reopen new file with the old name.

Use this for writing out a file in multiple pieces at specified checkpoints (e.g. every n hours).

Parameters
$newnamemixed File name. May be a string or an array with one element

Reimplemented in DumpPipeOutput, and DumpFileOutput.

Definition at line 953 of file Export.php.

◆ getFilenames()

DumpOutput::getFilenames ( )

Returns the name of the file or files which are being written to, if there are any.

Returns
null

Reimplemented in DumpFileOutput.

Definition at line 972 of file Export.php.

◆ write()

DumpOutput::write (   $string)

Override to write to a different stream type.

Parameters
$stringstring
Returns
bool

Reimplemented in DumpFileOutput.

Definition at line 942 of file Export.php.

Referenced by writeClosePage(), writeCloseStream(), writeLogItem(), writeOpenPage(), writeOpenStream(), and writeRevision().

◆ writeClosePage()

DumpOutput::writeClosePage (   $string)
Parameters
$stringstring

Definition at line 917 of file Export.php.

References write().

◆ writeCloseStream()

DumpOutput::writeCloseStream (   $string)
Parameters
$stringstring

Reimplemented in DumpPipeOutput, and DumpFileOutput.

Definition at line 902 of file Export.php.

References write().

◆ writeLogItem()

DumpOutput::writeLogItem (   $rev,
  $string 
)
Parameters
$rev
$stringstring

Definition at line 933 of file Export.php.

References write().

◆ writeOpenPage()

DumpOutput::writeOpenPage (   $page,
  $string 
)
Parameters
$page
$stringstring

Definition at line 910 of file Export.php.

References write().

◆ writeOpenStream()

DumpOutput::writeOpenStream (   $string)
Parameters
$stringstring

Definition at line 895 of file Export.php.

References write().

◆ writeRevision()

DumpOutput::writeRevision (   $rev,
  $string 
)
Parameters
$rev
$stringstring

Definition at line 925 of file Export.php.

References write().


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