Base class for output stream; prints to stdout or buffer or wherever. More...
Public Member Functions | |
| closeAndRename ($newname, $open=false) | |
| Close the old file, and move it to a specified name. | |
| closeRenameAndReopen ($newname) | |
| Close the old file, move it to a specified name, and reopen new file with the old name. | |
| getFilenames () | |
| Returns the name of the file or files which are being written to, if there are any. | |
| write ($string) | |
| Override to write to a different stream type. | |
| 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 877 of file Export.php.
Member Function Documentation
| 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:
-
$newname mixed File name. May be a string or an array with one element bool $open If 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 950 of file Export.php.
| 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:
-
$newname mixed File name. May be a string or an array with one element
Reimplemented in DumpPipeOutput, and DumpFileOutput.
Definition at line 940 of file Export.php.
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 958 of file Export.php.
| DumpOutput::write | ( | $ | string | ) |
Override to write to a different stream type.
- Parameters:
-
$string string
- Returns:
- bool
Reimplemented in DumpFileOutput.
Definition at line 929 of file Export.php.
| DumpOutput::writeClosePage | ( | $ | string | ) |
- Parameters:
-
$string string
Definition at line 904 of file Export.php.
| DumpOutput::writeCloseStream | ( | $ | string | ) |
- Parameters:
-
$string string
Reimplemented in DumpPipeOutput, and DumpFileOutput.
Definition at line 889 of file Export.php.
| DumpOutput::writeLogItem | ( | $ | rev, |
| $ | string | ||
| ) |
- Parameters:
-
$rev $string string
Definition at line 920 of file Export.php.
| DumpOutput::writeOpenPage | ( | $ | page, |
| $ | string | ||
| ) |
- Parameters:
-
$page $string string
Definition at line 897 of file Export.php.
| DumpOutput::writeOpenStream | ( | $ | string | ) |
- Parameters:
-
$string string
Definition at line 882 of file Export.php.
| DumpOutput::writeRevision | ( | $ | rev, |
| $ | string | ||
| ) |
- Parameters:
-
$rev $string string
Definition at line 912 of file Export.php.
The documentation for this class was generated from the following file:
- includes/Export.php
