MediaWiki master
Wikimedia\WRStats\LimitBatchResult Class Reference

A class representing the results from a batch operation. More...

Public Member Functions

 __construct ( $results)
 
 getAllResults ()
 Get LimitOperationResult objects for all operations in the batch.
 
 getFailedResults ()
 Get LimitOperationResult objects for operations exceeding the limit.
 
 getPassedResults ()
 Get LimitOperationResult objects for operations not exceeding the limit.
 
 isAllowed ()
 Determine whether the batch as a whole is/was allowed.
 

Detailed Description

A class representing the results from a batch operation.

Since
1.39

Definition at line 10 of file LimitBatchResult.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\WRStats\LimitBatchResult::__construct ( $results)
Access: internal
Use WRStatsFactory::createRateLimiter() instead
Parameters
LimitOperationResult[]$results

Definition at line 21 of file LimitBatchResult.php.

Member Function Documentation

◆ getAllResults()

Wikimedia\WRStats\LimitBatchResult::getAllResults ( )

Get LimitOperationResult objects for all operations in the batch.

The keys will match the input array. For input arrays constructed by LimitBatch, the keys will be the condition names.

Returns
LimitOperationResult[]

Definition at line 87 of file LimitBatchResult.php.

◆ getFailedResults()

Wikimedia\WRStats\LimitBatchResult::getFailedResults ( )

Get LimitOperationResult objects for operations exceeding the limit.

The keys will match the input array. For input arrays constructed by LimitBatch, the keys will be the condition names.

Returns
LimitOperationResult[]

Definition at line 51 of file LimitBatchResult.php.

◆ getPassedResults()

Wikimedia\WRStats\LimitBatchResult::getPassedResults ( )

Get LimitOperationResult objects for operations not exceeding the limit.

The keys will match the input array. For input arrays constructed by LimitBatch, the keys will be the condition names.

Returns
LimitOperationResult[]

Definition at line 69 of file LimitBatchResult.php.

◆ isAllowed()

Wikimedia\WRStats\LimitBatchResult::isAllowed ( )

Determine whether the batch as a whole is/was allowed.

Returns
bool

Definition at line 30 of file LimitBatchResult.php.


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