includes/deferred/HtmlFileCacheUpdate.php

   1 <?php
   2 /**
   3  * HTMLFileCache cache purging
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 use MediaWiki\MediaWikiServices;
  24
  25 /**
  26  * Handles purging the appropriate HTMLFileCache files given a list of titles
  27  * @ingroup Cache
  28  */
  29 class HtmlFileCacheUpdate implements DeferrableUpdate {
  30         /** @var string[] Collection of prefixed DB keys for the pages to purge */
  31         private $prefixedDbKeys = [];
  32
  33         /**
  34          * @param string[] $prefixedDbKeys
  35          */
  36         public function __construct( array $prefixedDbKeys ) {
  37                 $this->prefixedDbKeys = $prefixedDbKeys;
  38         }
  39
  40         /**
  41          * Create an update object from an array of Title objects, or a TitleArray object
  42          *
  43          * @param Traversable|Title[] $titles
  44          * @return HtmlFileCacheUpdate
  45          */
  46         public static function newFromTitles( $titles ) {
  47                 $prefixedDbKeys = [];
  48                 foreach ( $titles as $title ) {
  49                         $prefixedDbKeys[] = $title->getPrefixedDBkey();
  50                 }
  51
  52                 return new self( $prefixedDbKeys );
  53         }
  54
  55         public function doUpdate() {
  56                 $config = MediaWikiServices::getInstance()->getMainConfig();
  57                 if ( $config->get( 'UseFileCache' ) ) {
  58                         HTMLFileCache::purge( $this->prefixedDbKeys );
  59                 }
  60         }
  61 }