[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/deferred/ -> DeferredUpdates.php (summary)

Interface and manager for deferred updates. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 136 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

DeferrableUpdate:: (1 method):
  doUpdate()

DeferredUpdates:: (5 methods):
  addUpdate()
  addHTMLCacheUpdate()
  addCallableUpdate()
  doUpdates()
  clearPendingUpdates()


Interface: DeferrableUpdate  - X-Ref

Interface that deferrable updates should implement. Basically required so we
can validate input on DeferredUpdates::addUpdate()

doUpdate()   X-Ref
Perform the actual work


Class: DeferredUpdates  - X-Ref

Class for managing the deferred updates.

addUpdate( DeferrableUpdate $update )   X-Ref
Add an update to the deferred list

param: DeferrableUpdate $update Some object that implements doUpdate()

addHTMLCacheUpdate( $title, $table )   X-Ref
HTMLCacheUpdates are the most common deferred update people use. This
is a shortcut method for that.

param: Title $title
param: string $table

addCallableUpdate( $callable )   X-Ref
Add a callable update.  In a lot of cases, we just need a callback/closure,
defining a new DeferrableUpdate object is not necessary

param: callable $callable

doUpdates( $commit = '' )   X-Ref
Do any deferred updates and clear the list

param: string $commit Set to 'commit' to commit after every update to

clearPendingUpdates()   X-Ref
Clear all pending updates without performing them. Generally, you don't
want or need to call this. Unit tests need it though.




Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1