File: LimitOperation.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (37 lines) | stat: -rw-r--r-- 766 bytes parent folder | download | duplicates (2)
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
<?php

namespace Wikimedia\WRStats;

/**
 * One item in a LimitBatch.
 *
 * To perform a single operation, it is generally recommended to use
 * the simpler interface of WRStatsRateLimiter::peek(), ::incr(), and
 * ::tryIncr() instead of constructing LimitOperation objects.
 *
 * @newable
 * @since 1.39
 */
class LimitOperation {
	/** @var string */
	public $condName;
	/** @var EntityKey */
	public $entityKey;
	/** @var int */
	public $amount;

	/**
	 * @param string $condName
	 * @param EntityKey|null $entityKey
	 * @param int $amount
	 */
	public function __construct(
		string $condName,
		?EntityKey $entityKey = null,
		$amount = 1
	) {
		$this->condName = $condName;
		$this->entityKey = $entityKey ?? new LocalEntityKey;
		$this->amount = $amount;
	}
}