DeferredUpdates Class Reference

Class for managing the deferred updates. More...

List of all members.

Static Public Member Functions
static	addCallableUpdate ($callable)
	Add a callable update.
static	addHTMLCacheUpdate ($title, $table)
	HTMLCacheUpdates are the most common deferred update people use.
static	addUpdate (DeferrableUpdate $update)
	Add an update to the deferred list.
static	clearPendingUpdates ()
	Clear all pending updates without performing them.
static	doUpdates ($commit= '')
	Do any deferred updates and clear the list.
Static Private Attributes
static	$updates = array()
	Store of updates to be deferred until the end of the request.

---

Detailed Description

Class for managing the deferred updates.

Since:

1.19

Definition at line 41 of file DeferredUpdates.php.

---

Member Function Documentation

static DeferredUpdates::addCallableUpdate

(

$

callable

)

[static]

Add a callable update.

In a lot of cases, we just need a callback/closure, defining a new DeferrableUpdate object is not necessary

See also:

MWCallableUpdate::__construct()

Parameters:

callable

$callable

Definition at line 72 of file DeferredUpdates.php.

References addUpdate().

static DeferredUpdates::addHTMLCacheUpdate	(	$	title,
		$	table
	)		[static]

HTMLCacheUpdates are the most common deferred update people use.

This is a shortcut method for that.

See also:

HTMLCacheUpdate::__construct()

Parameters:

Title	$title
string	$table

Definition at line 62 of file DeferredUpdates.php.

References $title, and addUpdate().

static DeferredUpdates::addUpdate

(

DeferrableUpdate $

update

)

[static]

Add an update to the deferred list.

Parameters:

DeferrableUpdate

$update

Some object that implements doUpdate()

Definition at line 51 of file DeferredUpdates.php.

Referenced by addCallableUpdate(), and addHTMLCacheUpdate().

static DeferredUpdates::clearPendingUpdates

(

)

[static]

Clear all pending updates without performing them.

Generally, you don't want or need to call this. Unit tests need it though.

Definition at line 128 of file DeferredUpdates.php.

References $wgDeferredUpdateList, array(), and global.

Referenced by doUpdates(), and UploadFromUrlTestSuite\setUp().

static DeferredUpdates::doUpdates

(

$

commit = ''

)

[static]

Do any deferred updates and clear the list.

Parameters:

string

$commit

set to 'commit' to commit after every update to prevent lock contention

Definition at line 82 of file DeferredUpdates.php.

References $e, $updates, $wgDeferredUpdateList, as, clearPendingUpdates(), global, MWExceptionHandler\logException(), wfGetDB(), wfProfileIn(), and wfProfileOut().

Referenced by BackupReader\showReport().

---

Member Data Documentation

DeferredUpdates::$updates = array() [static, private]

Store of updates to be deferred until the end of the request.

Definition at line 45 of file DeferredUpdates.php.

Referenced by doUpdates().

---

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

• includes/deferred/DeferredUpdates.php