MediaWiki  1.23.0
DumpFilter Class Reference

Dump output filter class. More...

Inheritance diagram for DumpFilter:
Collaboration diagram for DumpFilter:

Public Member Functions

 __construct (&$sink)
 
 closeAndRename ( $newname, $open=false)
 
 closeRenameAndReopen ( $newname)
 
 getFilenames ()
 
 pass ( $page)
 Override for page-based filter types. More...
 
 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. More...
 

Protected Attributes

bool $sendingThisPage
 

Detailed Description

Dump output filter class.

This just does output filtering and streaming; XML formatting is done higher up, so be careful in what you do.

Definition at line 1228 of file Export.php.

Constructor & Destructor Documentation

◆ __construct()

DumpFilter::__construct ( $sink)
Parameters
$sinkDumpOutput

Definition at line 1243 of file Export.php.

References $sink.

Member Function Documentation

◆ closeAndRename()

DumpFilter::closeAndRename (   $newname,
  $open = false 
)
Parameters
$newnamestring
$openbool

Definition at line 1311 of file Export.php.

◆ closeRenameAndReopen()

DumpFilter::closeRenameAndReopen (   $newname)
Parameters
$newnamestring

Definition at line 1303 of file Export.php.

◆ getFilenames()

DumpFilter::getFilenames ( )
Returns
array

Definition at line 1318 of file Export.php.

◆ pass()

DumpFilter::pass (   $page)

Override for page-based filter types.

Parameters
$page
Returns
bool

Reimplemented in DumpNamespaceFilter, and DumpNotalkFilter.

Definition at line 1327 of file Export.php.

Referenced by writeOpenPage().

◆ writeClosePage()

DumpFilter::writeClosePage (   $string)
Parameters
$stringstring

Reimplemented in DumpLatestFilter, and ExportProgressFilter.

Definition at line 1275 of file Export.php.

◆ writeCloseStream()

DumpFilter::writeCloseStream (   $string)
Parameters
$stringstring

Definition at line 1257 of file Export.php.

◆ writeLogItem()

DumpFilter::writeLogItem (   $rev,
  $string 
)
Parameters
$rev
$stringstring

Definition at line 1296 of file Export.php.

References $rev.

◆ writeOpenPage()

DumpFilter::writeOpenPage (   $page,
  $string 
)
Parameters
$page
$stringstring

Reimplemented in DumpLatestFilter.

Definition at line 1265 of file Export.php.

References pass().

◆ writeOpenStream()

DumpFilter::writeOpenStream (   $string)
Parameters
$stringstring

Definition at line 1250 of file Export.php.

◆ writeRevision()

DumpFilter::writeRevision (   $rev,
  $string 
)
Parameters
$rev
$stringstring

Reimplemented in DumpLatestFilter, and ExportProgressFilter.

Definition at line 1286 of file Export.php.

References $rev.

Member Data Documentation

◆ $sendingThisPage

bool DumpFilter::$sendingThisPage
protected

Definition at line 1238 of file Export.php.

◆ $sink

DumpOutput DumpFilter::$sink

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

Definition at line 1234 of file Export.php.

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


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