MediaWiki  REL1_31
ForeignDBViaLBRepo.php
Go to the documentation of this file.
1 <?php
31  protected $wiki;
32 
34  protected $dbName;
35 
37  protected $tablePrefix;
38 
40  protected $fileFactory = [ ForeignDBFile::class, 'newFromTitle' ];
41 
43  protected $fileFromRowFactory = [ ForeignDBFile::class, 'newFromRow' ];
44 
46  protected $hasSharedCache;
47 
51  function __construct( $info ) {
52  parent::__construct( $info );
53  $this->wiki = $info['wiki'];
54  list( $this->dbName, $this->tablePrefix ) = wfSplitWikiID( $this->wiki );
55  $this->hasSharedCache = $info['hasSharedCache'];
56  }
57 
61  function getMasterDB() {
62  return wfGetLB( $this->wiki )->getConnectionRef( DB_MASTER, [], $this->wiki );
63  }
64 
68  function getReplicaDB() {
69  return wfGetLB( $this->wiki )->getConnectionRef( DB_REPLICA, [], $this->wiki );
70  }
71 
75  protected function getDBFactory() {
76  return function ( $index ) {
77  return wfGetLB( $this->wiki )->getConnectionRef( $index, [], $this->wiki );
78  };
79  }
80 
81  function hasSharedCache() {
82  return $this->hasSharedCache;
83  }
84 
91  function getSharedCacheKey( /*...*/ ) {
92  if ( $this->hasSharedCache() ) {
93  $args = func_get_args();
94  array_unshift( $args, $this->wiki );
95 
96  return implode( ':', $args );
97  } else {
98  return false;
99  }
100  }
101 
102  protected function assertWritableRepo() {
103  throw new MWException( static::class . ': write operations are not supported.' );
104  }
105 
106  public function getInfo() {
107  return FileRepo::getInfo();
108  }
109 }
ForeignDBViaLBRepo\getDBFactory
getDBFactory()
Definition: ForeignDBViaLBRepo.php:75
array
the array() calling protocol came about after MediaWiki 1.4rc1.
wfGetLB
wfGetLB( $wiki=false)
Get a load balancer object.
Definition: GlobalFunctions.php:2825
wiki
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default wiki
Definition: maintenance.txt:27
FileRepo\getInfo
getInfo()
Return information about the repository.
Definition: FileRepo.php:1919
wfSplitWikiID
wfSplitWikiID( $wiki)
Split a wiki ID into DB name and table prefix.
Definition: GlobalFunctions.php:2779
ForeignDBViaLBRepo\$fileFromRowFactory
array $fileFromRowFactory
Definition: ForeignDBViaLBRepo.php:43
ForeignDBViaLBRepo\$wiki
string $wiki
Definition: ForeignDBViaLBRepo.php:31
ForeignDBViaLBRepo\$dbName
string $dbName
Definition: ForeignDBViaLBRepo.php:34
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
ForeignDBViaLBRepo\getInfo
getInfo()
Return information about the repository.
Definition: ForeignDBViaLBRepo.php:106
MWException
MediaWiki exception.
Definition: MWException.php:26
ForeignDBViaLBRepo
A foreign repository with a MediaWiki database accessible via the configured LBFactory.
Definition: ForeignDBViaLBRepo.php:29
ForeignDBViaLBRepo\$tablePrefix
string $tablePrefix
Definition: ForeignDBViaLBRepo.php:37
ForeignDBViaLBRepo\$fileFactory
array $fileFactory
Definition: ForeignDBViaLBRepo.php:40
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
DB_MASTER
const DB_MASTER
Definition: defines.php:29
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
ForeignDBViaLBRepo\getReplicaDB
getReplicaDB()
Definition: ForeignDBViaLBRepo.php:68
ForeignDBViaLBRepo\$hasSharedCache
bool $hasSharedCache
Definition: ForeignDBViaLBRepo.php:46
ForeignDBViaLBRepo\getMasterDB
getMasterDB()
Definition: ForeignDBViaLBRepo.php:61
ForeignDBViaLBRepo\assertWritableRepo
assertWritableRepo()
Throw an exception if this repo is read-only by design.
Definition: ForeignDBViaLBRepo.php:102
ForeignDBViaLBRepo\getSharedCacheKey
getSharedCacheKey()
Get a key on the primary cache for this repository.
Definition: ForeignDBViaLBRepo.php:91
ForeignDBViaLBRepo\hasSharedCache
hasSharedCache()
Definition: ForeignDBViaLBRepo.php:81
$args
if( $line===false) $args
Definition: cdb.php:64
ForeignDBViaLBRepo\__construct
__construct( $info)
Definition: ForeignDBViaLBRepo.php:51
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:56
LocalRepo
A repository that stores files in the local filesystem and registers them in the wiki's own database.
Definition: LocalRepo.php:35