Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F4048359
PoolCounterWorkViaCallback.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
2 KB
Referenced Files
None
Subscribers
None
PoolCounterWorkViaCallback.php
View Options
<?php
/**
* @license GPL-2.0-or-later
* @file
*/
namespace
MediaWiki\PoolCounter
;
use
InvalidArgumentException
;
/**
* Convenience class for dealing with PoolCounter using callbacks
* @since 1.22
* @newable
* @note marked as newable in 1.35 for lack of a better alternative,
* but should use a factory in the future.
*/
class
PoolCounterWorkViaCallback
extends
PoolCounterWork
{
/** @var callable|null */
protected
$doWork
;
/** @var callable|null */
protected
$doCachedWork
;
/** @var callable|null */
protected
$fallback
;
/** @var callable|null */
protected
$error
;
/**
* Build a PoolCounterWork class from a type, key, and callback map.
*
* The callback map must at least have a callback for the 'doWork' method.
* Additionally, callbacks can be provided for the 'doCachedWork', 'fallback',
* and 'error' methods. Methods without callbacks will be no-ops that return false.
* If a 'doCachedWork' callback is provided, then execute() may wait for any prior
* process in the pool to finish and reuse its cached result.
*
* @stable to call
* @param PoolCounter|string $pool The PoolCounter or PoolCounter type
* @param string $key
* @param array $callbacks Map of callbacks
*/
public
function
__construct
(
$pool
,
string
$key
,
array
$callbacks
)
{
if
(
is_string
(
$pool
)
)
{
$type
=
$pool
;
$pool
=
null
;
}
else
{
$type
=
$pool
->
getType
();
}
parent
::
__construct
(
$type
,
$key
,
$pool
);
foreach
(
[
'doWork'
,
'doCachedWork'
,
'fallback'
,
'error'
]
as
$name
)
{
if
(
isset
(
$callbacks
[
$name
]
)
)
{
if
(
!
is_callable
(
$callbacks
[
$name
]
)
)
{
throw
new
InvalidArgumentException
(
"Invalid callback provided for '$name' function."
);
}
$this
->
$name
=
$callbacks
[
$name
];
}
}
if
(
!
$this
->
doWork
)
{
throw
new
InvalidArgumentException
(
"No callback provided for 'doWork' function."
);
}
$this
->
cacheable
=
(
bool
)
$this
->
doCachedWork
;
}
/** @inheritDoc */
public
function
doWork
()
{
return
(
$this
->
doWork
)();
}
/** @inheritDoc */
public
function
getCachedWork
()
{
if
(
$this
->
doCachedWork
)
{
return
(
$this
->
doCachedWork
)();
}
return
false
;
}
/** @inheritDoc */
public
function
fallback
(
$fast
)
{
if
(
$this
->
fallback
)
{
return
(
$this
->
fallback
)(
$fast
);
}
return
false
;
}
/** @inheritDoc */
public
function
error
(
$status
)
{
if
(
$this
->
error
)
{
return
(
$this
->
error
)(
$status
);
}
return
false
;
}
}
/** @deprecated class alias since 1.42 */
class_alias
(
PoolCounterWorkViaCallback
::
class
,
'PoolCounterWorkViaCallback'
);
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Aug 15 2026, 14:00 (13 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
9b/6d/7ea41966d108f6a776c4730eb869
Default Alt Text
PoolCounterWorkViaCallback.php (2 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment