LimitBatch.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\WRStats;
 
class LimitBatch {
    private $limiter;
 
    private $defaultAmount;
 
    private $operations = [];
 
    public function __construct(
        WRStatsRateLimiter $limiter,
        $defaultAmount
    ) {
        $this->limiter = $limiter;
        $this->defaultAmount = $defaultAmount;
    }
 
    public function localOp( $condName, $components = [], $amount = null ) {
        if ( !is_array( $components ) ) {
            $components = [ $components ];
        }
        $this->queueOp(
            $condName,
            new LocalEntityKey( array_merge( [ $condName ], $components ) ),
            $amount
        );
        return $this;
    }
 
    public function globalOp( $condName, $components = [], $amount = null ) {
        if ( !is_array( $components ) ) {
            $components = [ $components ];
        }
        $this->queueOp(
            $condName,
            new GlobalEntityKey( array_merge( [ $condName ], $components ) ),
            $amount
        );
        return $this;
    }
 
    private function queueOp( $type, $entity, $amount ) {
        $amount ??= $this->defaultAmount;
        if ( isset( $this->operations[$type] ) ) {
            throw new WRStatsError( __METHOD__ .
                ': cannot queue multiple actions of the same type, ' .
                'since the result array is indexed by type' );
        }
        $this->operations[$type] = new LimitOperation( $type, $entity, $amount );
    }
 
    public function peek() {
        return $this->limiter->peekBatch( $this->operations );
    }
 
    public function incr() {
        $this->limiter->incrBatch( $this->operations );
    }
 
    public function tryIncr() {
        return $this->limiter->tryIncrBatch( $this->operations );
    }
}