Wikimedia\WRStats\LimitOperationResult Class Reference

Information about the result of a single item in a limit batch. More...

Collaboration diagram for Wikimedia\WRStats\LimitOperationResult:

Public Member Functions
	__construct (LimitCondition $condition, $prevTotal, $newTotal)
	dump ()
	Get a string representing the object, for testing or debugging.
	isAllowed ()
	Whether the operation was/is allowed.

Public Attributes
LimitCondition	$condition
int	$newTotal
	The value the metric would have if the increment operation were allowed.
int	$prevTotal
	The previous metric value before the current action was executed.

Detailed Description

Information about the result of a single item in a limit batch.

Since

1.39

Definition at line 10 of file LimitOperationResult.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\WRStats\LimitOperationResult::__construct	(	LimitCondition	$condition,
			$prevTotal,
			$newTotal )

Access: internal

Parameters

LimitCondition	$condition
int	$prevTotal
int	$newTotal

Definition at line 27 of file LimitOperationResult.php.

References Wikimedia\WRStats\LimitOperationResult\$condition, Wikimedia\WRStats\LimitOperationResult\$newTotal, and Wikimedia\WRStats\LimitOperationResult\$prevTotal.

Member Function Documentation

dump()

Wikimedia\WRStats\LimitOperationResult::dump

(

)

Get a string representing the object, for testing or debugging.

Returns

string

Definition at line 47 of file LimitOperationResult.php.

isAllowed()

Wikimedia\WRStats\LimitOperationResult::isAllowed

(

)

Whether the operation was/is allowed.

Returns

bool

Definition at line 38 of file LimitOperationResult.php.

Member Data Documentation

$condition

LimitCondition Wikimedia\WRStats\LimitOperationResult::$condition

Definition at line 12 of file LimitOperationResult.php.

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

$newTotal

int Wikimedia\WRStats\LimitOperationResult::$newTotal

The value the metric would have if the increment operation were allowed.

Definition at line 18 of file LimitOperationResult.php.

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

$prevTotal

int Wikimedia\WRStats\LimitOperationResult::$prevTotal

The previous metric value before the current action was executed.

Definition at line 15 of file LimitOperationResult.php.

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

---

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

• includes/libs/WRStats/LimitOperationResult.php