DumpPipeOutput Class Reference

Inherits DumpFileOutput.

Inherited by Dump7ZipOutput, DumpBZip2Output, DumpDBZip2Output, DumpGZipOutput, and DumpLBZip2Output.

Collaboration diagram for DumpPipeOutput:

Public Member Functions
	__construct ( $command, $file=null)
	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 string | string[] $newname 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)
	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 string | string[] $newname File name. May be a string or an array with one element
	startCommand ( $command)
	writeCloseStream ( $string)
Public Member Functions inherited from DumpFileOutput
	__construct ( $file)
	getFilenames ()
	write ( $string)
Public Member Functions inherited from DumpOutput
	writeClosePage ( $string)
	writeLogItem ( $rev, $string)
	writeOpenPage ( $page, $string)
	writeOpenStream ( $string)
	writeRevision ( $rev, $string)

Protected Attributes
string	$command
string null	$filename
resource false	$procOpenResource = false
Protected Attributes inherited from DumpFileOutput
string	$filename
resource false	$handle = false

Additional Inherited Members
Protected Member Functions inherited from DumpFileOutput
	checkRenameArgCount ( $newname)
	renameOrException ( $newname)

Detailed Description

Definition at line 33 of file DumpPipeOutput.php.

Constructor & Destructor Documentation

__construct()

DumpPipeOutput::__construct	(		$command,
			$file = null )

Parameters

string	$command
string | null	$file

Reimplemented in Dump7ZipOutput.

Definition at line 45 of file DumpPipeOutput.php.

References $command, $file, and startCommand().

Member Function Documentation

closeAndRename()

DumpPipeOutput::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

string | string[]	$newname	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 from DumpFileOutput.

Reimplemented in Dump7ZipOutput.

Definition at line 88 of file DumpPipeOutput.php.

References $command, DumpFileOutput\checkRenameArgCount(), DumpFileOutput\renameOrException(), and startCommand().

Referenced by closeRenameAndReopen().

closeRenameAndReopen()

DumpPipeOutput::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

string | string[]

$newname

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

Reimplemented from DumpFileOutput.

Definition at line 81 of file DumpPipeOutput.php.

References closeAndRename().

startCommand()

DumpPipeOutput::startCommand

(

$command

)

Parameters

string

$command

Definition at line 69 of file DumpPipeOutput.php.

References $command.

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

writeCloseStream()

DumpPipeOutput::writeCloseStream

(

$string

)

Parameters

string

$string

Reimplemented from DumpFileOutput.

Definition at line 58 of file DumpPipeOutput.php.

Member Data Documentation

$command

string DumpPipeOutput::$command

protected

Definition at line 35 of file DumpPipeOutput.php.

Referenced by __construct(), Dump7ZipOutput\__construct(), Dump7ZipOutput\closeAndRename(), closeAndRename(), and startCommand().

$filename

string null DumpPipeOutput::$filename

protected

Definition at line 37 of file DumpPipeOutput.php.

$procOpenResource

resource false DumpPipeOutput::$procOpenResource = false

protected

Definition at line 39 of file DumpPipeOutput.php.

---

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

• includes/export/DumpPipeOutput.php