includes/site/SiteSQLStore.php

   1 <?php
   2
   3 /**
   4  * Dummy class for accessing the global SiteStore instance.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @since 1.21
  22  *
  23  * @file
  24  * @ingroup Site
  25  *
  26  * @license GPL-2.0-or-later
  27  * @author Daniel Kinzler
  28  */
  29 class SiteSQLStore {
  30
  31         /**
  32          * Returns the global SiteStore instance. This is a relict of the first implementation
  33          * of SiteStore, and is kept around for compatibility.
  34          *
  35          * @note This does not return an instance of SiteSQLStore!
  36          *
  37          * @since 1.21
  38          * @deprecated since 1.27 use MediaWikiServices::getSiteStore()
  39          *             or MediaWikiServices::getSiteLookup() instead.
  40          *
  41          * @param null $sitesTable IGNORED
  42          * @param null $cache IGNORED
  43          *
  44          * @return SiteStore
  45          */
  46         public static function newInstance( $sitesTable = null, BagOStuff $cache = null ) {
  47                 if ( $sitesTable !== null ) {
  48                         throw new InvalidArgumentException(
  49                                 __METHOD__ . ': $sitesTable parameter is unused and must be null'
  50                         );
  51                 }
  52
  53                 // NOTE: we silently ignore $cache for now, since some existing callers
  54                 // specify it. If we break compatibility with them, we could just as
  55                 // well just remove this class.
  56
  57                 return \MediaWiki\MediaWikiServices::getInstance()->getSiteStore();
  58         }
  59
  60 }