MediaWiki  1.28.0
BatchRowUpdate Class Reference

Public Member Functions

 __construct (BatchRowIterator $reader, BatchRowWriter $writer, RowUpdateGenerator $generator)
 
 execute ()
 Runs the batch update process. More...
 
 setOutput (callable $output)
 Accepts a callable which will receive a single parameter containing string status updates. More...
 

Protected Member Functions

 output ($text)
 Write out a status update. More...
 

Protected Attributes

 $generator
 
 $output
 
 $reader
 
 $writer
 

Detailed Description

Definition at line 42 of file BatchRowUpdate.php.

Constructor & Destructor Documentation

BatchRowUpdate::__construct ( BatchRowIterator  $reader,
BatchRowWriter  $writer,
RowUpdateGenerator  $generator 
)
Parameters
BatchRowIterator$readerIterator that returns an array of database rows
BatchRowWriter$writerWriter capable of pushing row updates to the database
RowUpdateGenerator$generatorGenerates single row updates based on the rows content

Definition at line 74 of file BatchRowUpdate.php.

References $generator, $reader, $writer, output(), and writer.

Member Function Documentation

BatchRowUpdate::execute ( )

Runs the batch update process.

Definition at line 87 of file BatchRowUpdate.php.

References as, output(), and writer.

BatchRowUpdate::output (   $text)
protected

Write out a status update.

Parameters
string$textThe value to print

Definition at line 125 of file BatchRowUpdate.php.

Referenced by __construct(), execute(), and setOutput().

BatchRowUpdate::setOutput ( callable  $output)

Accepts a callable which will receive a single parameter containing string status updates.

Parameters
callable$outputA callback taking a single string parameter to output

Definition at line 116 of file BatchRowUpdate.php.

References $output, and output().

Member Data Documentation

BatchRowUpdate::$generator
protected

Definition at line 59 of file BatchRowUpdate.php.

Referenced by __construct().

BatchRowUpdate::$output
protected

Definition at line 64 of file BatchRowUpdate.php.

Referenced by setOutput().

BatchRowUpdate::$reader
protected

Definition at line 47 of file BatchRowUpdate.php.

Referenced by __construct().

BatchRowUpdate::$writer
protected

Definition at line 53 of file BatchRowUpdate.php.

Referenced by __construct().


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