MediaWiki  master
purgePage.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
31 class PurgePage extends Maintenance {
32  public function __construct() {
33  parent::__construct();
34  $this->addDescription( 'Purge page.' );
35  $this->addOption( 'skip-exists-check', 'Skip page existence check', false, false );
36  }
37 
38  public function execute() {
39  $stdin = $this->getStdin();
40 
41  while ( !feof( $stdin ) ) {
42  $title = trim( fgets( $stdin ) );
43  if ( $title != '' ) {
44  $this->purge( $title );
45  }
46  }
47  }
48 
49  private function purge( $titleText ) {
50  $title = Title::newFromText( $titleText );
51 
52  if ( is_null( $title ) ) {
53  $this->error( 'Invalid page title' );
54  return;
55  }
56 
57  $page = WikiPage::factory( $title );
58 
59  if ( is_null( $page ) ) {
60  $this->error( "Could not instantiate page object" );
61  return;
62  }
63 
64  if ( !$this->getOption( 'skip-exists-check' ) && !$page->exists() ) {
65  $this->error( "Page doesn't exist" );
66  return;
67  }
68 
69  if ( $page->doPurge() ) {
70  $this->output( "Purged {$titleText}\n" );
71  } else {
72  $this->error( "Purge failed for {$titleText}" );
73  }
74  }
75 }
76 
77 $maintClass = PurgePage::class;
78 require_once RUN_MAINTENANCE_IF_MAIN;
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:142
const RUN_MAINTENANCE_IF_MAIN
Definition: Maintenance.php:39
Maintenance script that purges a list of pages passed through stdin.
Definition: purgePage.php:31
error( $err, $die=0)
Throw an error to the user.
getOption( $name, $default=null)
Get an option, or return the default.
purge( $titleText)
Definition: purgePage.php:49
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:82
$maintClass
Definition: purgePage.php:77
addDescription( $text)
Set the description text.
output( $out, $channel=null)
Throw some output to the user.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getStdin( $len=null)
Return input from stdin.
__construct()
Definition: purgePage.php:32
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:316