ForeignDBRepo.php

Go to the documentation of this file.

<?php
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\IDatabase;
 
class ForeignDBRepo extends LocalRepo {
    protected $dbType;
 
    protected $dbServer;
 
    protected $dbUser;
 
    protected $dbPassword;
 
    protected $dbName;
 
    protected $dbFlags;
 
    protected $tablePrefix;
 
    protected $hasSharedCache;
 
    protected $dbConn;
 
    protected $fileFactory = [ 'ForeignDBFile', 'newFromTitle' ];
    protected $fileFromRowFactory = [ 'ForeignDBFile', 'newFromRow' ];
 
    function __construct( $info ) {
        parent::__construct( $info );
        $this->dbType = $info['dbType'];
        $this->dbServer = $info['dbServer'];
        $this->dbUser = $info['dbUser'];
        $this->dbPassword = $info['dbPassword'];
        $this->dbName = $info['dbName'];
        $this->dbFlags = $info['dbFlags'];
        $this->tablePrefix = $info['tablePrefix'];
        $this->hasSharedCache = $info['hasSharedCache'];
    }
 
    function getMasterDB() {
        if ( !isset( $this->dbConn ) ) {
            $func = $this->getDBFactory();
            $this->dbConn = $func( DB_MASTER );
        }
 
        return $this->dbConn;
    }
 
    function getReplicaDB() {
        return $this->getMasterDB();
    }
 
    protected function getDBFactory() {
        $type = $this->dbType;
        $params = [
            'host' => $this->dbServer,
            'user' => $this->dbUser,
            'password' => $this->dbPassword,
            'dbname' => $this->dbName,
            'flags' => $this->dbFlags,
            'tablePrefix' => $this->tablePrefix,
            'foreign' => true,
        ];
 
        return function ( $index ) use ( $type, $params ) {
            return Database::factory( $type, $params );
        };
    }
 
    function hasSharedCache() {
        return $this->hasSharedCache;
    }
 
    function getSharedCacheKey( /*...*/ ) {
        if ( $this->hasSharedCache() ) {
            $args = func_get_args();
            array_unshift( $args, $this->dbName, $this->tablePrefix );
 
            return call_user_func_array( 'wfForeignMemcKey', $args );
        } else {
            return false;
        }
    }
 
    protected function assertWritableRepo() {
        throw new MWException( static::class . ': write operations are not supported.' );
    }
 
    function getInfo() {
        return FileRepo::getInfo();
    }
}