wiki.techinc.nl/includes/DeferredUpdates.php
Chad Horohoe 22b599e06c Refactor deferrable updates into classes & interfaces, also add helper method for the most common use case:
$wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, "sometable" );

I kept b/c with $wgDeferredUpdateList for now, but seeing as only 3 exts in svn use it (FileSearch, FlaggedRevs and WikiScripts), I'd like to deprecate it pretty soon :)
2011-09-10 06:50:30 +00:00

83 lines
2 KiB
PHP

<?php
/**
* Interface that deferrable updates should implement. Basically required so we
* can validate input on DeferredUpdates::addUpdate()
*/
interface DeferrableUpdate {
/**
* Perform the actual work
*/
function doUpdate();
}
/**
* Class for mananging the deferred updates.
*/
class DeferredUpdates {
/**
* Store of updates to be deferred until the end of the request.
*/
private static $updates = array();
/**
* Add an update to the deferred list
* @param $update DeferrableUpdate Some object that implements doUpdate()
*/
public static function addUpdate( DeferrableUpdate $update ) {
array_push( self::$updates, $update );
}
/**
* HTMLCacheUpdates are the most common deferred update people use. This
* is a shortcut method for that.
* @see HTMLCacheUpdate::__construct()
*/
public static function addHTMLCacheUpdate( $title, $table ) {
self::addUpdate( new HTMLCacheUpdate( $title, $table ) );
}
/**
* Do any deferred updates and clear the list
*
* @param $commit String: set to 'commit' to commit after every update to
* prevent lock contention
*/
public static function doUpdates( $commit = '' ) {
global $wgDeferredUpdateList;
wfProfileIn( __METHOD__ );
$updates = array_merge( $wgDeferredUpdateList, self::$updates );
// No need to get master connections in case of empty updates array
if ( !count( $updates ) ) {
wfProfileOut( __METHOD__ );
return;
}
$doCommit = $commit == 'commit';
if ( $doCommit ) {
$dbw = wfGetDB( DB_MASTER );
}
foreach ( $updates as $update ) {
$update->doUpdate();
if ( $doCommit && $dbw->trxLevel() ) {
$dbw->commit();
}
}
self::clearPendingUpdates();
wfProfileOut( __METHOD__ );
}
/**
* Clear all pending updates without performing them. Generally, you don't
* want or need to call this. Unit tests need it though.
*/
public static function clearPendingUpdates() {
global $wgDeferredUpdateList;
$wgDeferredUpdateList = self::$updates = array();
}
}