wiki.techinc.nl/includes/Storage/BlobStoreFactory.php
James D. Forrester 4f2d1efdda Coding style: Auto-fix MediaWiki.Classes.UnsortedUseStatements.UnsortedUse
Change-Id: I94a0ae83c65e8ee419bbd1ae1e86ab21ed4d8210
2020-01-10 09:32:25 -08:00

120 lines
2.8 KiB
PHP

<?php
/**
* 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
*/
namespace MediaWiki\Storage;
use ExternalStoreAccess;
use MediaWiki\Config\ServiceOptions;
use WANObjectCache;
use Wikimedia\Rdbms\ILBFactory;
/**
* Service for instantiating BlobStores
*
* This can be used to create BlobStore objects for other wikis.
*
* @since 1.31
*/
class BlobStoreFactory {
/**
* @var ILBFactory
*/
private $lbFactory;
/**
* @var ExternalStoreAccess
*/
private $extStoreAccess;
/**
* @var WANObjectCache
*/
private $cache;
/**
* @var ServiceOptions
*/
private $options;
/**
* @var array
* @since 1.34
*/
public const CONSTRUCTOR_OPTIONS = [
'CompressRevisions',
'DefaultExternalStore',
'LegacyEncoding',
'RevisionCacheExpiry',
];
public function __construct(
ILBFactory $lbFactory,
ExternalStoreAccess $extStoreAccess,
WANObjectCache $cache,
ServiceOptions $options
) {
$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
$this->lbFactory = $lbFactory;
$this->extStoreAccess = $extStoreAccess;
$this->cache = $cache;
$this->options = $options;
}
/**
* @since 1.31
*
* @param bool|string $dbDomain The ID of the target wiki database. Use false for the local wiki.
*
* @return BlobStore
*/
public function newBlobStore( $dbDomain = false ) {
return $this->newSqlBlobStore( $dbDomain );
}
/**
* @internal Please call newBlobStore and use the BlobStore interface.
*
* @param bool|string $dbDomain The ID of the target wiki database. Use false for the local wiki.
*
* @return SqlBlobStore
*/
public function newSqlBlobStore( $dbDomain = false ) {
$lb = $this->lbFactory->getMainLB( $dbDomain );
$store = new SqlBlobStore(
$lb,
$this->extStoreAccess,
$this->cache,
$dbDomain
);
$store->setCompressBlobs( $this->options->get( 'CompressRevisions' ) );
$store->setCacheExpiry( $this->options->get( 'RevisionCacheExpiry' ) );
$store->setUseExternalStore( $this->options->get( 'DefaultExternalStore' ) !== false );
if ( $this->options->get( 'LegacyEncoding' ) ) {
$store->setLegacyEncoding( $this->options->get( 'LegacyEncoding' ) );
}
return $store;
}
}