DumpFileOutput Class Reference

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

Inheritance diagram for DumpFileOutput:

Collaboration diagram for DumpFileOutput:

List of all members.

Public Member Functions
	__construct ($file)
	checkRenameArgCount ($newname)
	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.
	renameOrException ($newname)
	write ($string)
	Override to write to a different stream type.
Public Attributes
	$filename
Protected Attributes
	$handle

---

Detailed Description

Stream outputter to send data to a file.

Definition at line 786 of file Export.php.

---

Constructor & Destructor Documentation

DumpFileOutput::__construct

(

$

file

)

Reimplemented in Dump7ZipOutput, DumpBZip2Output, and DumpGZipOutput.

Definition at line 789 of file Export.php.

References $file.

---

Member Function Documentation

DumpFileOutput::checkRenameArgCount

(

$

newname

)

Definition at line 808 of file Export.php.

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

Here is the caller graph for this function:

DumpFileOutput::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
$open	bool If true, a new file with the old filename will be opened again for writing (default: false)

Reimplemented from DumpOutput.

Reimplemented in Dump7ZipOutput, and DumpPipeOutput.

Definition at line 819 of file Export.php.

References checkRenameArgCount(), and renameOrException().

Referenced by closeRenameAndReopen().

Here is the call graph for this function:

Here is the caller graph for this function:

DumpFileOutput::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 from DumpOutput.

Reimplemented in DumpPipeOutput.

Definition at line 798 of file Export.php.

References closeAndRename().

Here is the call graph for this function:

DumpFileOutput::getFilenames

(

)

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

Reimplemented from DumpOutput.

Definition at line 830 of file Export.php.

DumpFileOutput::renameOrException

(

$

newname

)

Definition at line 802 of file Export.php.

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

Here is the caller graph for this function:

DumpFileOutput::write

(

$

string

)

Override to write to a different stream type.

Returns:

bool

Reimplemented from DumpOutput.

Definition at line 794 of file Export.php.

---

Member Data Documentation

DumpFileOutput::$filename

Reimplemented in DumpPipeOutput.

Definition at line 787 of file Export.php.

DumpFileOutput::$handle [protected]

Definition at line 787 of file Export.php.

---

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

• includes/Export.php