Handles purging the appropriate CDN objects given a list of URLs or Title instances. More...
Inherits MediaWiki\Deferred\DeferrableUpdate, and MediaWiki\Deferred\MergeableUpdate.
Public Member Functions | |
| __construct (array $targets, array $options=[]) | |
| doUpdate () | |
| Perform the actual work. | |
| getUrls () | |
| merge (MergeableUpdate $update) | |
| Merge this enqueued update with a new MergeableUpdate of the same qualified class name. | |
Static Public Member Functions | |
| static | purge (array $urls) |
| Purges a list of CDN nodes defined in $wgCdnServers. | |
Detailed Description
Handles purging the appropriate CDN objects given a list of URLs or Title instances.
Definition at line 23 of file CdnCacheUpdate.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Deferred\CdnCacheUpdate::__construct | ( | array | $targets, |
| array | $options = [] ) |
- Parameters
-
string[] | PageReference[] $targets Collection of URLs/titles to be purged from CDN array $options Options map. Supports: - reboundDelay: how many seconds after the first purge to send a rebound purge. No rebound purge will be sent if this is not positive. [Default: 0]
Definition at line 38 of file CdnCacheUpdate.php.
Member Function Documentation
◆ doUpdate()
| MediaWiki\Deferred\CdnCacheUpdate::doUpdate | ( | ) |
Perform the actual work.
Implements MediaWiki\Deferred\DeferrableUpdate.
Definition at line 62 of file CdnCacheUpdate.php.
References $url, MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Deferred\CdnCacheUpdate\purge().
◆ getUrls()
| MediaWiki\Deferred\CdnCacheUpdate::getUrls | ( | ) |
- Returns
- string[] List of URLs
Definition at line 137 of file CdnCacheUpdate.php.
◆ merge()
| MediaWiki\Deferred\CdnCacheUpdate::merge | ( | MergeableUpdate | $update | ) |
Merge this enqueued update with a new MergeableUpdate of the same qualified class name.
- Parameters
-
MergeableUpdate $update The new update (having the same class)
Implements MediaWiki\Deferred\MergeableUpdate.
Definition at line 53 of file CdnCacheUpdate.php.
◆ purge()
|
static |
Purges a list of CDN nodes defined in $wgCdnServers.
$urlArr should contain the full URLs to purge as values (example: $urlArr[] = 'http://my.host/something')
- Parameters
-
string[] $urls List of full URLs to purge
Definition at line 95 of file CdnCacheUpdate.php.
References $url, MediaWiki\MainConfigNames\CdnServers, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\MainConfigNames\HTCPRouting, and wfDebugLog().
Referenced by MediaWiki\Deferred\CdnCacheUpdate\doUpdate().
The documentation for this class was generated from the following file:
- includes/Deferred/CdnCacheUpdate.php
