MediaWiki master
MediaWiki\Export\DumpFilter Class Reference

Inherited by MediaWiki\Export\DumpLatestFilter, MediaWiki\Export\DumpNamespaceFilter, MediaWiki\Export\DumpNotalkFilter, and MediaWiki\Export\ExportProgressFilter.

Collaboration diagram for MediaWiki\Export\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 19 of file DumpFilter.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Export\DumpFilter::__construct ( & $sink)
Parameters
DumpOutput&$sink

Definition at line 35 of file DumpFilter.php.

References MediaWiki\Export\DumpFilter\$sink.

Member Function Documentation

◆ closeAndRename()

MediaWiki\Export\DumpFilter::closeAndRename ( $newname,
$open = false )
See also
DumpOutput::closeAndRename()
Parameters
string | string[]$newname
bool$open

Definition at line 105 of file DumpFilter.php.

◆ closeRenameAndReopen()

MediaWiki\Export\DumpFilter::closeRenameAndReopen ( $newname)
See also
DumpOutput::closeRenameAndReopen()
Parameters
string | string[]$newname

Definition at line 96 of file DumpFilter.php.

◆ getFilenames()

MediaWiki\Export\DumpFilter::getFilenames ( )
Returns
array

Definition at line 112 of file DumpFilter.php.

◆ pass()

MediaWiki\Export\DumpFilter::pass ( $page)
protected

Override for page-based filter types.

Parameters
\\stdClass | null$page
Returns
bool

Reimplemented in MediaWiki\Export\DumpNamespaceFilter, and MediaWiki\Export\DumpNotalkFilter.

Definition at line 121 of file DumpFilter.php.

Referenced by MediaWiki\Export\DumpFilter\writeOpenPage().

◆ writeClosePage()

MediaWiki\Export\DumpFilter::writeClosePage ( $string)
Parameters
string$string

Reimplemented in MediaWiki\Export\DumpLatestFilter, and MediaWiki\Export\ExportProgressFilter.

Definition at line 67 of file DumpFilter.php.

◆ writeCloseStream()

MediaWiki\Export\DumpFilter::writeCloseStream ( $string)
Parameters
string$string

Definition at line 49 of file DumpFilter.php.

◆ writeLogItem()

MediaWiki\Export\DumpFilter::writeLogItem ( $rev,
$string )
Parameters
\\stdClass$rev
string$string

Definition at line 88 of file DumpFilter.php.

◆ writeOpenPage()

MediaWiki\Export\DumpFilter::writeOpenPage ( $page,
$string )
Parameters
\\stdClass | null$page
string$string

Reimplemented in MediaWiki\Export\DumpLatestFilter.

Definition at line 57 of file DumpFilter.php.

References MediaWiki\Export\DumpFilter\pass().

◆ writeOpenStream()

MediaWiki\Export\DumpFilter::writeOpenStream ( $string)
Parameters
string$string

Definition at line 42 of file DumpFilter.php.

◆ writeRevision()

MediaWiki\Export\DumpFilter::writeRevision ( $rev,
$string )
Parameters
\\stdClass | null$rev
string$string

Reimplemented in MediaWiki\Export\DumpLatestFilter, and MediaWiki\Export\ExportProgressFilter.

Definition at line 78 of file DumpFilter.php.

Member Data Documentation

◆ $sendingThisPage

bool MediaWiki\Export\DumpFilter::$sendingThisPage
protected

Definition at line 30 of file DumpFilter.php.

◆ $sink

DumpOutput MediaWiki\Export\DumpFilter::$sink

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

Definition at line 25 of file DumpFilter.php.

Referenced by MediaWiki\Export\DumpFilter\__construct(), MediaWiki\Export\DumpNamespaceFilter\__construct(), and MediaWiki\Export\ExportProgressFilter\__construct().


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