MediaWiki REL1_28
rebuildSitesCache.php
Go to the documentation of this file.
1<?php
2
23require_once __DIR__ . '/Maintenance.php';
24
30class RebuildSitesCache extends Maintenance {
31
32 public function __construct() {
33 parent::__construct();
34
35 $this->addDescription( 'Cache sites as json for file-based lookup.' );
36 $this->addOption( 'file', 'File to output the json to', false, true );
37 }
38
39 public function execute() {
40 $sitesCacheFileBuilder = new SitesCacheFileBuilder(
41 \MediaWiki\MediaWikiServices::getInstance()->getSiteLookup(),
42 $this->getCacheFile()
43 );
44
45 $sitesCacheFileBuilder->build();
46 }
47
51 private function getCacheFile() {
52 if ( $this->hasOption( 'file' ) ) {
53 $jsonFile = $this->getOption( 'file' );
54 } else {
55 $jsonFile = $this->getConfig()->get( 'SitesCacheFile' );
56
57 if ( $jsonFile === false ) {
58 $this->error( 'Error: No file set in configuration for SitesCacheFile.', 1 );
59 }
60 }
61
62 return $jsonFile;
63 }
64
65}
66
67$maintClass = "RebuildSitesCache";
68require_once RUN_MAINTENANCE_IF_MAIN;
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition maintenance.txt:39
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition Maintenance.php:387
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition Maintenance.php:231
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition Maintenance.php:282
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition Maintenance.php:210
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition Maintenance.php:245
RebuildSitesCache
Maintenance script to dump a SiteStore as a static json file.
Definition rebuildSitesCache.php:30
RebuildSitesCache\__construct
__construct()
Default constructor.
Definition rebuildSitesCache.php:32
RebuildSitesCache\execute
execute()
Do the actual work.
Definition rebuildSitesCache.php: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:37
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition maintenance.txt:50
MediaWiki
A helper class for throttling authentication attempts.