MediaWiki master
purgeExpiredWatchlistItems.php
Go to the documentation of this file.
1<?php
7
8require_once __DIR__ . '/Maintenance.php';
9
11
12 public function __construct() {
13 parent::__construct();
14 $this->addDescription( 'Removes expired items from the watchlist and watchlist_expiry tables.' );
15 $this->setBatchSize( 500 );
16 }
17
21 public function execute() {
22 // Make sure watchlist expiring is enabled.
23 if ( !$this->getServiceContainer()->getMainConfig()->get( MainConfigNames::WatchlistExpiry ) ) {
24 $this->error( "Watchlist expiry is not enabled. Set `\$wgWatchlistExpiry = true;` to enable." );
25 return false;
26 }
27
28 // Loop through 500 entries at a time and delete them.
29 $watchedItemStore = $this->getServiceContainer()->getWatchedItemStore();
30 $count = $watchedItemStore->countExpired();
31 $this->output( $count . " expired watchlist entries found.\n" );
32 if ( $count === 0 ) {
33 // None found to delete.
34 return true;
35 }
36 while ( $watchedItemStore->countExpired() > 0 ) {
37 $watchedItemStore->removeExpired( $this->getBatchSize(), true );
38 }
39
40 // Report success.
41 $this->output( "All expired entries purged.\n" );
42 return true;
43 }
44}
45
46$maintClass = PurgeExpiredWatchlistItems::class;
47require_once RUN_MAINTENANCE_IF_MAIN;
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
output( $out, $channel=null)
Throw some output to the user.
getServiceContainer()
Returns the main service container.
getBatchSize()
Returns batch size.
addDescription( $text)
Set the description text.
setBatchSize( $s=0)
A class containing constants representing the names of configuration variables.
execute()
Do the actual work.All child classes will need to implement thisbool|null|void True for success,...