MediaWiki  1.28.1
ILBFactory.php
Go to the documentation of this file.
1 <?php
29 interface ILBFactory {
30  const SHUTDOWN_NO_CHRONPROT = 0; // don't save DB positions at all
31  const SHUTDOWN_CHRONPROT_ASYNC = 1; // save DB positions, but don't wait on remote DCs
32  const SHUTDOWN_CHRONPROT_SYNC = 2; // save DB positions, waiting on all DCs
33 
56  public function __construct( array $conf );
57 
63  public function destroy();
64 
77  public function newMainLB( $domain = false );
78 
85  public function getMainLB( $domain = false );
86 
99  public function newExternalLB( $cluster );
100 
107  public function getExternalLB( $cluster );
108 
117  public function forEachLB( $callback, array $params = [] );
118 
124  public function shutdown(
125  $mode = self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback = null
126  );
127 
133  public function flushReplicaSnapshots( $fname = __METHOD__ );
134 
143  public function commitAll( $fname = __METHOD__, array $options = [] );
144 
158  public function beginMasterChanges( $fname = __METHOD__ );
159 
167  public function commitMasterChanges( $fname = __METHOD__, array $options = [] );
168 
173  public function rollbackMasterChanges( $fname = __METHOD__ );
174 
179  public function hasMasterChanges();
180 
185  public function laggedReplicaUsed();
186 
192  public function hasOrMadeRecentMasterChanges( $age = null );
193 
217  public function waitForReplication( array $opts = [] );
218 
227  public function setWaitForReplicationListener( $name, callable $callback = null );
228 
235  public function getEmptyTransactionTicket( $fname );
236 
247  public function commitAndWaitForReplication( $fname, $ticket, array $opts = [] );
248 
253  public function getChronologyProtectorTouched( $dbName );
254 
260  public function disableChronologyProtection();
261 
267  public function setDomainPrefix( $prefix );
268 
272  public function closeAll();
273 
277  public function setAgentName( $agent );
278 
288  public function appendPreShutdownTimeAsQuery( $url, $time );
289 
296  public function setRequestInfo( array $info );
297 }
commitMasterChanges($fname=__METHOD__, array $options=[])
Commit changes on all master connections.
the array() calling protocol came about after MediaWiki 1.4rc1.
appendPreShutdownTimeAsQuery($url, $time)
Append ?cpPosTime parameter to a URL for ChronologyProtector purposes if needed.
commitAndWaitForReplication($fname, $ticket, array $opts=[])
Convenience method for safely running commitMasterChanges()/waitForReplication()
setDomainPrefix($prefix)
Set a new table prefix for the existing local domain ID for testing.
An interface for generating database load balancers.
Definition: ILBFactory.php:29
rollbackMasterChanges($fname=__METHOD__)
Rollback changes on all master connections.
newExternalLB($cluster)
Create a new load balancer for external storage.
commitAll($fname=__METHOD__, array $options=[])
Commit open transactions on all connections.
hasOrMadeRecentMasterChanges($age=null)
Determine if any master connection has pending/written changes from this request. ...
__construct(array $conf)
Construct a manager of ILoadBalancer objects.
forEachLB($callback, array $params=[])
Execute a function for each tracked load balancer The callback is called with the load balancer as th...
getExternalLB($cluster)
Get a cached (tracked) load balancer for external storage.
destroy()
Disables all load balancers.
hasMasterChanges()
Determine if any master connection has pending changes.
const SHUTDOWN_CHRONPROT_ASYNC
Definition: ILBFactory.php:31
const SHUTDOWN_NO_CHRONPROT
Definition: ILBFactory.php:30
setWaitForReplicationListener($name, callable $callback=null)
Add a callback to be run in every call to waitForReplication() before waiting.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
getChronologyProtectorTouched($dbName)
flushReplicaSnapshots($fname=__METHOD__)
Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot.
$params
getMainLB($domain=false)
Get a cached (tracked) load balancer object.
getEmptyTransactionTicket($fname)
Get a token asserting that no transaction writes are active.
setAgentName($agent)
setRequestInfo(array $info)
disableChronologyProtection()
Disable the ChronologyProtector for all load balancers.
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
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined...
Definition: Setup.php:36
closeAll()
Close all open database connections on all open load balancers.
const SHUTDOWN_CHRONPROT_SYNC
Definition: ILBFactory.php:32
beginMasterChanges($fname=__METHOD__)
Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set)
laggedReplicaUsed()
Detemine if any lagged replica DB connection was used.
waitForReplication(array $opts=[])
Waits for the replica DBs to catch up to the current master position.
shutdown($mode=self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback=null)
Prepare all tracked load balancers for shutdown.
newMainLB($domain=false)
Create a new load balancer object.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1749
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300