aboutsummaryrefslogtreecommitdiffstats
path: root/includes/deferred/TransactionRoundAwareUpdate.php
blob: dd91ead0918ee5ef1e410952c5b830b8e1702bc6 (plain) (blame)
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
<?php

namespace MediaWiki\Deferred;

/**
 * Deferrable update that specifies whether it must run outside of any explicit
 * LBFactory transaction round or must run inside of a round owned by doUpdate().
 *
 * @stable to implement
 *
 * @since 1.34
 */
interface TransactionRoundAwareUpdate {
	/** @var int No explicit transaction round should be used */
	public const TRX_ROUND_ABSENT = 1;
	/** @var int An explicit transaction round owned by self::doUpdate should be used */
	public const TRX_ROUND_PRESENT = 2;

	/**
	 * @return int One of the class TRX_ROUND_* constants
	 */
	public function getTransactionRoundRequirement();
}

/** @deprecated class alias since 1.42 */
class_alias( TransactionRoundAwareUpdate::class, 'TransactionRoundAwareUpdate' );