DumpFilter Class Reference

Inheritance diagram for DumpFilter:

Collaboration diagram for DumpFilter:

Public Member Functions
	__construct (&$sink)
	closeAndRename ( $newname, $open=false)
	closeRenameAndReopen ( $newname)
	getFilenames ()
	writeClosePage ( $string)
	writeCloseStream ( $string)
	writeLogItem ( $rev, $string)
	writeOpenPage ( $page, $string)
	writeOpenStream ( $string)
	writeRevision ( $rev, $string)

Public Attributes
DumpOutput	$sink
	FIXME will need to be made protected whenever legacy code is updated.

Protected Member Functions
	pass ( $page)
	Override for page-based filter types.

Protected Attributes
bool	$sendingThisPage

Detailed Description

Definition at line 31 of file DumpFilter.php.

Constructor & Destructor Documentation

__construct()

DumpFilter::__construct

(

&

$sink

)

Parameters

DumpOutput

&$sink

Definition at line 47 of file DumpFilter.php.

References $sink.

Member Function Documentation

closeAndRename()

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

See also

DumpOutput::closeAndRename()

Parameters

string | string[]	$newname
bool	$open

Definition at line 117 of file DumpFilter.php.

closeRenameAndReopen()

DumpFilter::closeRenameAndReopen

(

$newname

)

See also

DumpOutput::closeRenameAndReopen()

Parameters

string | string[]

$newname

Definition at line 108 of file DumpFilter.php.

getFilenames()

DumpFilter::getFilenames

(

)

Returns

array

Definition at line 124 of file DumpFilter.php.

pass()

DumpFilter::pass (   $page )

protected

Override for page-based filter types.

Parameters

object

$page

Returns

bool

Reimplemented in DumpNamespaceFilter, and DumpNotalkFilter.

Definition at line 133 of file DumpFilter.php.

Referenced by writeOpenPage().

writeClosePage()

DumpFilter::writeClosePage

(

$string

)

Parameters

string

$string

Reimplemented in DumpLatestFilter, and ExportProgressFilter.

Definition at line 79 of file DumpFilter.php.

writeCloseStream()

DumpFilter::writeCloseStream

(

$string

)

Parameters

string

$string

Definition at line 61 of file DumpFilter.php.

writeLogItem()

DumpFilter::writeLogItem	(		$rev,
			$string
	)

Parameters

object	$rev
string	$string

Definition at line 100 of file DumpFilter.php.

writeOpenPage()

DumpFilter::writeOpenPage	(		$page,
			$string
	)

Parameters

object	$page
string	$string

Reimplemented in DumpLatestFilter.

Definition at line 69 of file DumpFilter.php.

References pass().

writeOpenStream()

DumpFilter::writeOpenStream

(

$string

)

Parameters

string

$string

Definition at line 54 of file DumpFilter.php.

writeRevision()

DumpFilter::writeRevision	(		$rev,
			$string
	)

Parameters

object	$rev
string	$string

Reimplemented in DumpLatestFilter, and ExportProgressFilter.

Definition at line 90 of file DumpFilter.php.

Member Data Documentation

$sendingThisPage

bool DumpFilter::$sendingThisPage

protected

Definition at line 42 of file DumpFilter.php.

$sink

DumpOutput DumpFilter::$sink

FIXME will need to be made protected whenever legacy code is updated.

Definition at line 37 of file DumpFilter.php.

Referenced by __construct(), DumpNamespaceFilter\__construct(), and ExportProgressFilter\__construct().

---

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

• includes/export/DumpFilter.php