188d2cbbb0
Callers should not catch an unchecked exception, so it doesn't belong in a function signature. Unchecked exceptions indicate a coding error, which by definition the code will not be able to handle correctly. If any of these exceptions were supposed to be in response to an edge case, user input, or initial conditions, then they should be changed to a runtime error. If the exception class cannot be changed, then the annotation should include a comment explaining its purpose and prognosis. Bug: T240672 Change-Id: I2e640b9737cb68090a8e1cb70067d1b74037d647
114 lines
3.5 KiB
PHP
114 lines
3.5 KiB
PHP
<?php
|
|
/**
|
|
* Functions to get cache objects.
|
|
*
|
|
* 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 Cache
|
|
*/
|
|
|
|
use MediaWiki\MediaWikiServices;
|
|
use Wikimedia\ObjectCache\BagOStuff;
|
|
|
|
/**
|
|
* @see ObjectCacheFactory
|
|
* @ingroup Cache
|
|
*/
|
|
class ObjectCache {
|
|
/**
|
|
* @deprecated since 1.43; use ObjectCacheFactory instead.
|
|
* @var BagOStuff[] Map of (id => BagOStuff)
|
|
*/
|
|
public static $instances = [];
|
|
|
|
/**
|
|
* Get a cached instance of the specified type of cache object.
|
|
*
|
|
* @deprecated since 1.43; use ObjectCacheFactory::getInstance instead.
|
|
*
|
|
* @param string|int $id A key in $wgObjectCaches.
|
|
* @return BagOStuff
|
|
*/
|
|
public static function getInstance( $id ) {
|
|
return MediaWikiServices::getInstance()->getObjectCacheFactory()->getInstance( $id );
|
|
}
|
|
|
|
/**
|
|
* @see ObjectCacheFactory::newFromParams()
|
|
*
|
|
* @deprecated since 1.42, Use ObjectCacheFactory::newFromParams instead.
|
|
* @param array $params
|
|
*
|
|
* @return BagOStuff
|
|
*/
|
|
public static function newFromParams( array $params ) {
|
|
return MediaWikiServices::getInstance()->getObjectCacheFactory()
|
|
->newFromParams( $params );
|
|
}
|
|
|
|
/**
|
|
* Factory function for CACHE_ANYTHING (referenced by configuration)
|
|
*
|
|
* CACHE_ANYTHING means that stuff has to be cached, not caching is not an option.
|
|
* If a caching method is configured for any of the main caches ($wgMainCacheType,
|
|
* $wgMessageCacheType, $wgParserCacheType), then CACHE_ANYTHING will effectively
|
|
* be an alias to the configured cache choice for that.
|
|
* If no cache choice is configured (by default $wgMainCacheType is CACHE_NONE),
|
|
* then CACHE_ANYTHING will forward to CACHE_DB.
|
|
*
|
|
* @deprecated since 1.42, Use ObjectCacheFactory::getInstance( CACHE_ANYTHING );
|
|
*
|
|
* @return BagOStuff
|
|
*/
|
|
public static function newAnything() {
|
|
return MediaWikiServices::getInstance()->getObjectCacheFactory()
|
|
->getInstance( CACHE_ANYTHING );
|
|
}
|
|
|
|
/**
|
|
* @deprecated since 1.42, Use ObjectCacheFactory::getLocalServerInstance()
|
|
* @param int|string|array $fallback Fallback cache or parameter map with 'fallback'
|
|
* @return BagOStuff
|
|
* @since 1.27
|
|
*/
|
|
public static function getLocalServerInstance( $fallback = CACHE_NONE ) {
|
|
return MediaWikiServices::getInstance()->getObjectCacheFactory()
|
|
->getLocalServerInstance( $fallback );
|
|
}
|
|
|
|
/**
|
|
* Get the main cluster-local cache object.
|
|
*
|
|
* @deprecated since 1.43, Use ObjectCacheFactory::getLocalClusterInstance()
|
|
*
|
|
* @since 1.27
|
|
* @return BagOStuff
|
|
*/
|
|
public static function getLocalClusterInstance() {
|
|
return MediaWikiServices::getInstance()->getObjectCacheFactory()
|
|
->getLocalClusterInstance();
|
|
}
|
|
|
|
/**
|
|
* @deprecated since 1.42, Use ObjectCacheFactory::clear() instead.
|
|
*
|
|
* Clear all the cached instances.
|
|
*/
|
|
public static function clear() {
|
|
MediaWikiServices::getInstance()->getObjectCacheFactory()->clear();
|
|
}
|
|
}
|