wiki.techinc.nl/includes/db/LBFactorySingle.php
Thiemo Mättig e698d93bad Add missing visibility keywords to all LoadBalancer methods
Quite a few methods are unused, at least in my code base (which does
not cover all extensions). I made them public. All other decisions
are based on the usage of that method in my code base. If you think
a specific method should be public, please tell me.

Change-Id: Ie83a2921fe02a198bd75c5ff7a41bcd4f0b4980b
2014-11-20 21:02:14 +01:00

112 lines
2.9 KiB
PHP

<?php
/**
* Simple generator of database connections that always returns the same object.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Database
*/
/**
* An LBFactory class that always returns a single database object.
*/
class LBFactorySingle extends LBFactory {
/** @var LoadBalancerSingle */
private $lb;
/**
* @param array $conf An associative array with one member:
* - connection: The DatabaseBase connection object
*/
public function __construct( array $conf ) {
$this->lb = new LoadBalancerSingle( $conf );
}
/**
* @param bool|string $wiki
* @return LoadBalancerSingle
*/
public function newMainLB( $wiki = false ) {
return $this->lb;
}
/**
* @param bool|string $wiki
* @return LoadBalancerSingle
*/
public function getMainLB( $wiki = false ) {
return $this->lb;
}
/**
* @param string $cluster External storage cluster, or false for core
* @param bool|string $wiki Wiki ID, or false for the current wiki
* @return LoadBalancerSingle
*/
protected function newExternalLB( $cluster, $wiki = false ) {
return $this->lb;
}
/**
* @param string $cluster External storage cluster, or false for core
* @param bool|string $wiki Wiki ID, or false for the current wiki
* @return LoadBalancerSingle
*/
public function &getExternalLB( $cluster, $wiki = false ) {
return $this->lb;
}
/**
* @param string|callable $callback
* @param array $params
*/
public function forEachLB( $callback, array $params = array() ) {
call_user_func_array( $callback, array_merge( array( $this->lb ), $params ) );
}
}
/**
* Helper class for LBFactorySingle.
*/
class LoadBalancerSingle extends LoadBalancer {
/** @var DatabaseBase */
private $db;
/**
* @param array $params
*/
public function __construct( array $params ) {
$this->db = $params['connection'];
parent::__construct( array( 'servers' => array( array(
'type' => $this->db->getType(),
'host' => $this->db->getServer(),
'dbname' => $this->db->getDBname(),
'load' => 1,
) ) ) );
}
/**
*
* @param string $server
* @param bool $dbNameOverride
*
* @return DatabaseBase
*/
protected function reallyOpenConnection( $server, $dbNameOverride = false ) {
return $this->db;
}
}