Wikimedia\WRStats\LimitOperation Class Reference

One item in a LimitBatch. More...

Collaboration diagram for Wikimedia\WRStats\LimitOperation:

Public Member Functions
	__construct (string $condName, EntityKey $entityKey=null, $amount=1)

Public Attributes
int	$amount
string	$condName
EntityKey	$entityKey

Detailed Description

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.

Stability: newable

Since

1.39

Definition at line 15 of file LimitOperation.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\WRStats\LimitOperation::__construct	(	string	$condName,
		EntityKey	$entityKey = null,
			$amount = 1 )

Parameters

string	$condName
EntityKey | null	$entityKey
int	$amount

Definition at line 28 of file LimitOperation.php.

References Wikimedia\WRStats\LimitOperation\$amount, Wikimedia\WRStats\LimitOperation\$condName, and Wikimedia\WRStats\LimitOperation\$entityKey.

Member Data Documentation

$amount

int Wikimedia\WRStats\LimitOperation::$amount

Definition at line 21 of file LimitOperation.php.

Referenced by Wikimedia\WRStats\LimitOperation\__construct().

$condName

string Wikimedia\WRStats\LimitOperation::$condName

Definition at line 17 of file LimitOperation.php.

Referenced by Wikimedia\WRStats\LimitOperation\__construct().

$entityKey

EntityKey Wikimedia\WRStats\LimitOperation::$entityKey

Definition at line 19 of file LimitOperation.php.

Referenced by Wikimedia\WRStats\LimitOperation\__construct().

---

The documentation for this class was generated from the following file:

• includes/libs/WRStats/LimitOperation.php