MediaWiki  1.33.0
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 
78 require_once RUN_MAINTENANCE_IF_MAIN;
PurgePage
Maintenance script that purges a list of pages passed through stdin.
Definition: purgePage.php:31
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:306
Maintenance\getStdin
getStdin( $len=null)
Return input from stdin.
Definition: Maintenance.php:407
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:329
$maintClass
$maintClass
Definition: purgePage.php:77
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
PurgePage\execute
execute()
Do the actual work.
Definition: purgePage.php:38
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:248
PurgePage\__construct
__construct()
Default constructor.
Definition: purgePage.php:32
PurgePage\purge
purge( $titleText)
Definition: purgePage.php:49
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:283
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:462
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:434
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52