objectcache: Deprecate ObjectCache::getWANInstance

[lhc/web/wiklou.git] / includes / objectcache / ObjectCache.php

diff --git a/includes/objectcache/ObjectCache.php b/includes/objectcache/ObjectCache.php
index 87edc8b..73f3993 100644 (file)
--- a/includes/objectcache/ObjectCache.php
+++ b/includes/objectcache/ObjectCache.php
@@ -43,11 +43,6 @@ use MediaWiki\MediaWikiServices;
  *
  * Primary entry points:
  *
- * - ObjectCache::getMainWANInstance()
- *   Purpose: Memory cache.
- *   Stored in the local data-center's main cache (keyspace different from local-cluster cache).
- *   Delete events are broadcasted to other DCs main cache. See WANObjectCache for details.
- *
  * - ObjectCache::getLocalServerInstance( $fallbackType )
  *   Purpose: Memory cache for very hot keys.
  *   Stored only on the individual web server (typically APC or APCu for web requests,
@@ -60,13 +55,6 @@ use MediaWiki\MediaWikiServices;
  *   Stored centrally within the local data-center. Not replicated to other DCs.
  *   Configured by $wgMainCacheType.
  *
- * - ObjectCache::getMainStashInstance()
- *   Purpose: Ephemeral global storage.
- *   Stored centrally within the primary data-center.
- *   Changes are applied there first and replicated to other DCs (best-effort).
- *   To retrieve the latest value (e.g. not from a replica DB), use BagOStuff::READ_LATEST.
- *   This store may be subject to LRU style evictions.
- *
  * - ObjectCache::getInstance( $cacheType )
  *   Purpose: Special cases (like tiered memory/disk caches).
  *   Get a specific cache type by key in $wgObjectCaches.
@@ -103,8 +91,10 @@ class ObjectCache {
         * @since 1.26
         * @param string $id A key in $wgWANObjectCaches.
         * @return WANObjectCache
+        * @deprecated since 1.34 Use MediaWikiServices::getMainWANObjectCache instead
         */
        public static function getWANInstance( $id ) {
+               wfDeprecated( __METHOD__, '1.34' );
                if ( !isset( self::$wanInstances[$id] ) ) {
                        self::$wanInstances[$id] = self::newWANCacheFromId( $id );
                }
@@ -320,8 +310,11 @@ class ObjectCache {
         * @return WANObjectCache
         * @throws UnexpectedValueException
         * @suppress PhanTypeMismatchReturn
+        * @deprecated since 1.34 Use MediaWikiServices::getMainWANObjectCache
+        *  instead or use WANObjectCache::__construct directly
         */
        public static function newWANCacheFromParams( array $params ) {
+               wfDeprecated( __METHOD__, '1.34' );
                global $wgCommandLineMode, $wgSecretKey;
 
                $services = MediaWikiServices::getInstance();