1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
|
<?php
namespace MediaWiki\Deferred;
use Closure;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\Platform\ISQLPlatform;
/**
* DeferrableUpdate for closure/callable
*
* @internal Use DeferredUpdates::addCallableUpdate instead
*/
class MWCallableUpdate
implements DeferrableUpdate, DeferrableCallback, TransactionRoundAwareUpdate
{
/** @var callable|null Callback, or null if it was cancelled */
private $callback;
/** @var string Calling method name */
private $fname;
/** @var int One of the class TRX_ROUND_* constants */
private $trxRoundRequirement = self::TRX_ROUND_PRESENT;
/**
* @param callable $callback One of the following:
* - A Closure callback that takes the caller name as its argument
* - A non-Closure callback that takes no arguments
* @param string $fname Calling method @phan-mandatory-param
* @param IDatabase|IDatabase[] $dependeeDbws DB handles which might have pending writes
* upon which this update depends. If any of the handles already has an open transaction,
* a rollback thereof will cause this update to be cancelled (if it has not already run).
* [optional]
*/
public function __construct(
callable $callback,
$fname = ISQLPlatform::CALLER_UNKNOWN,
$dependeeDbws = []
) {
$this->callback = $callback;
$this->fname = $fname;
$dependeeDbws = is_array( $dependeeDbws ) ? $dependeeDbws : [ $dependeeDbws ];
foreach ( $dependeeDbws as $dbw ) {
if ( $dbw->trxLevel() ) {
$dbw->onTransactionResolution( [ $this, 'cancelOnRollback' ], $fname );
}
}
}
public function doUpdate() {
if ( $this->callback instanceof Closure ) {
( $this->callback )( $this->fname );
} elseif ( $this->callback ) {
// For backwards-compatibility with [$classOrObject, 'func'] style callbacks
// where the function happened to already take an optional parameter.
( $this->callback )();
}
}
/**
* @internal This method is public so that it works with onTransactionResolution()
* @param int $trigger
*/
public function cancelOnRollback( $trigger ) {
if ( $trigger === IDatabase::TRIGGER_ROLLBACK ) {
$this->callback = null;
}
}
public function getOrigin() {
return $this->fname;
}
/**
* @param int $mode One of the class TRX_ROUND_* constants
*/
public function setTransactionRoundRequirement( $mode ) {
$this->trxRoundRequirement = $mode;
}
public function getTransactionRoundRequirement() {
return $this->trxRoundRequirement;
}
}
/** @deprecated class alias since 1.42 */
class_alias( MWCallableUpdate::class, 'MWCallableUpdate' );
|