MWCallableUpdate.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Deferred;
 
use Closure;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\Platform\ISQLPlatform;
 
class MWCallableUpdate
    implements DeferrableUpdate, DeferrableCallback, TransactionRoundAwareUpdate
{
    private $callback;
    private $fname;
    private $trxRoundRequirement = self::TRX_ROUND_PRESENT;
 
    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 )();
        }
    }
 
    public function cancelOnRollback( $trigger ) {
        if ( $trigger === IDatabase::TRIGGER_ROLLBACK ) {
            $this->callback = null;
        }
    }
 
    public function getOrigin() {
        return $this->fname;
    }
 
    public function setTransactionRoundRequirement( $mode ) {
        $this->trxRoundRequirement = $mode;
    }
 
    public function getTransactionRoundRequirement() {
        return $this->trxRoundRequirement;
    }
}
 
class_alias( MWCallableUpdate::class, 'MWCallableUpdate' );