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 38 39 40 41 42 43 44 45 46 47 48 49 50
|
<?php
namespace Wikimedia\WRStats;
/**
* Information about the result of a single item in a limit batch
*
* @since 1.39
*/
class LimitOperationResult {
/** @var LimitCondition */
public $condition;
/** @var int The previous metric value before the current action was executed */
public $prevTotal;
/** @var int The value the metric would have if the increment operation were allowed */
public $newTotal;
/**
* @internal
*
* @param LimitCondition $condition
* @param int $prevTotal
* @param int $newTotal
*/
public function __construct( LimitCondition $condition, $prevTotal, $newTotal ) {
$this->condition = $condition;
$this->prevTotal = $prevTotal;
$this->newTotal = $newTotal;
}
/**
* Whether the operation was/is allowed.
*
* @return bool
*/
public function isAllowed() {
return $this->newTotal <= $this->condition->limit;
}
/**
* Get a string representing the object, for testing or debugging
*
* @return string
*/
public function dump() {
return "LimitActionResult{{$this->newTotal}/{$this->condition->limit}}";
}
}
|