X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FPoolCounter.php;h=2dac9388c0eb019ea2a1c7c6f112e40e3e77c340;hb=fd26d27c094cc962d59a7477afdc1c232f13eb2c;hp=38c6f046bca044a84344b3af4b2974b9f5bd806b;hpb=27126ae0c162a66fe9f967f38ff96c840aee81ee;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/PoolCounter.php b/includes/PoolCounter.php
index 38c6f046bc..2dac9388c0 100644
--- a/includes/PoolCounter.php
+++ b/includes/PoolCounter.php
@@ -190,9 +190,19 @@ abstract class PoolCounterWork {
 	}
 
 	/**
-	 * Get the result of the work (whatever it is), or false.
+	 * Get the result of the work (whatever it is), or the result of the error() function.
+	 * This returns the result of the first applicable method that returns a non-false value,
+	 * where the methods are checked in the following order:
+	 *   - a) doWork()       : Applies if the work is exclusive or no another process
+	 *                         is doing it, and on the condition that either this process
+	 *                         successfully entered the pool or the pool counter is down.
+	 *   - b) doCachedWork() : Applies if the work is cacheable and this blocked on another
+	 *                         process which finished the work.
+	 *   - c) fallback()     : Applies for all remaining cases.
+	 * If these all fall through (by returning false), then the result of error() is returned.
+	 *
 	 * @param $skipcache bool
-	 * @return bool|mixed
+	 * @return mixed
 	 */
 	public function execute( $skipcache = false ) {
 		if ( $this->cacheable && !$skipcache ) {