MediaWiki  REL1_31
ConfiguredReadOnlyMode.php
Go to the documentation of this file.
1 <?php
2 
11  private $config;
12 
14  private $fileReason;
15 
17  private $overrideReason;
18 
19  public function __construct( Config $config ) {
20  $this->config = $config;
21  }
22 
28  public function isReadOnly() {
29  return $this->getReason() !== false;
30  }
31 
37  public function getReason() {
38  if ( $this->overrideReason !== null ) {
39  return $this->overrideReason;
40  }
41  $confReason = $this->config->get( 'ReadOnly' );
42  if ( $confReason !== null ) {
43  return $confReason;
44  }
45  if ( $this->fileReason === null ) {
46  // Cache for faster access next time
47  $readOnlyFile = $this->config->get( 'ReadOnlyFile' );
48  if ( is_file( $readOnlyFile ) && filesize( $readOnlyFile ) > 0 ) {
49  $this->fileReason = file_get_contents( $readOnlyFile );
50  } else {
51  $this->fileReason = false;
52  }
53  }
54  return $this->fileReason;
55  }
56 
63  public function setReason( $msg ) {
64  $this->overrideReason = $msg;
65  }
66 
70  public function clearCache() {
71  $this->fileReason = null;
72  }
73 }
ConfiguredReadOnlyMode\isReadOnly
isReadOnly()
Check whether the wiki is in read-only mode.
Definition: ConfiguredReadOnlyMode.php:28
ConfiguredReadOnlyMode\clearCache
clearCache()
Clear the cache of the read only file.
Definition: ConfiguredReadOnlyMode.php:70
ConfiguredReadOnlyMode
A read-only mode service which does not depend on LoadBalancer.
Definition: ConfiguredReadOnlyMode.php:9
ConfiguredReadOnlyMode\$overrideReason
string null $overrideReason
Definition: ConfiguredReadOnlyMode.php:17
ConfiguredReadOnlyMode\getReason
getReason()
Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
Definition: ConfiguredReadOnlyMode.php:37
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
Config
Interface for configuration instances.
Definition: Config.php:28
ConfiguredReadOnlyMode\setReason
setReason( $msg)
Set the read-only mode, which will apply for the remainder of the request or until a service reset.
Definition: ConfiguredReadOnlyMode.php:63
ConfiguredReadOnlyMode\__construct
__construct(Config $config)
Definition: ConfiguredReadOnlyMode.php:19
ConfiguredReadOnlyMode\$config
Config $config
Definition: ConfiguredReadOnlyMode.php:11
ConfiguredReadOnlyMode\$fileReason
string bool null $fileReason
Definition: ConfiguredReadOnlyMode.php:14