MediaWiki  master
Go to the documentation of this file.
1 <?php
11  private $reason;
14  private $reasonFile;
23  public function __construct( $reason, $reasonFile = null ) {
24  if ( $reason instanceof Config ) {
25  // Before 1.34 we passed a whole Config object, which was overkill
26  wfDeprecated( __METHOD__ . ' with Config passed to constructor', '1.34' );
27  $reason = $reason->get( 'ReadOnly' );
28  $reasonFile = $reason->get( 'ReadOnlyFile' );
29  }
30  $this->reason = $reason;
31  $this->reasonFile = $reasonFile;
32  }
39  public function isReadOnly() {
40  return $this->getReason() !== false;
41  }
48  public function getReason() {
49  if ( $this->reason !== null ) {
50  return $this->reason;
51  }
52  if ( $this->reasonFile === null ) {
53  return false;
54  }
55  // Try the reason file
56  if ( is_file( $this->reasonFile ) && filesize( $this->reasonFile ) > 0 ) {
57  $this->reason = file_get_contents( $this->reasonFile );
58  }
59  // No need to try the reason file again
60  $this->reasonFile = null;
61  return $this->reason ?? false;
62  }
70  public function setReason( $msg ) {
71  $this->reason = $msg;
72  }
73 }
setReason( $msg)
Set the read-only mode, which will apply for the remainder of the request or until a service reset...
A read-only mode service which does not depend on LoadBalancer.
__construct( $reason, $reasonFile=null)
Interface for configuration instances.
Definition: Config.php:28
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
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
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Check whether the wiki is in read-only mode.