ConnectionManager.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Rdbms;
 
use InvalidArgumentException;
 
class ConnectionManager {
 
    private $loadBalancer;
 
    private $domain;
 
    private $groups = [];
 
    public function __construct( ILoadBalancer $loadBalancer, $domain = false, array $groups = [] ) {
        if ( !is_string( $domain ) && $domain !== false ) {
            throw new InvalidArgumentException( '$dbName must be a string, or false.' );
        }
 
        $this->loadBalancer = $loadBalancer;
        $this->domain = $domain;
        $this->groups = $groups;
    }
 
    private function getConnection( $i, ?array $groups = null, int $flags = 0 ) {
        $groups ??= $this->groups;
        return $this->loadBalancer->getConnection( $i, $groups, $this->domain, $flags );
    }
 
    private function getConnectionRef( $i, array $groups = null ) {
        $groups ??= $this->groups;
        return $this->loadBalancer->getConnectionRef( $i, $groups, $this->domain );
    }
 
    public function getWriteConnection( int $flags = 0 ) {
        return $this->getConnection( DB_PRIMARY, null, $flags );
    }
 
    public function getReadConnection( ?array $groups = null, int $flags = 0 ) {
        $groups ??= $this->groups;
        return $this->getConnection( DB_REPLICA, $groups, $flags );
    }
 
    public function releaseConnection( IDatabase $db ) {
        wfDeprecated( 'ConnectionManager::releaseConnection()', '1.38' );
        $this->loadBalancer->reuseConnection( $db );
    }
 
    public function getWriteConnectionRef() {
        wfDeprecated( 'ConnectionManager::getWriteConnectionRef()', '1.39' );
        return $this->getConnectionRef( DB_PRIMARY );
    }
 
    public function getReadConnectionRef( array $groups = null ) {
        wfDeprecated( 'ConnectionManager::getReadConnectionRef()', '1.38' );
        $groups ??= $this->groups;
        return $this->getConnectionRef( DB_REPLICA, $groups );
    }
 
    public function getLazyWriteConnectionRef(): DBConnRef {
        wfDeprecated( 'ConnectionManager::getLazyWriteConnectionRef()', '1.39' );
        return $this->getConnectionRef( DB_PRIMARY );
    }
 
    public function getLazyReadConnectionRef( array $groups = null ) {
        wfDeprecated( 'ConnectionManager::getLazyReadConnectionRef()', '1.39' );
        $groups ??= $this->groups;
        return $this->getConnectionRef( DB_REPLICA, $groups );
    }
 
}