includes/deferred/HTMLCacheUpdate.php

   1 <?php
   2 /**
   3  * HTML cache invalidation of all pages linking to a given title.
   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  * @ingroup Cache
  22  */
  23
  24 /**
  25  * Class to invalidate the HTML cache of all the pages linking to a given title.
  26  *
  27  * @ingroup Cache
  28  */
  29 class HTMLCacheUpdate extends DataUpdate {
  30         /** @var Title */
  31         public $mTitle;
  32
  33         /** @var string */
  34         public $mTable;
  35
  36         /**
  37          * @param Title $titleTo
  38          * @param string $table
  39          * @param string $causeAction Triggering action
  40          * @param string $causeAgent Triggering user
  41          */
  42         function __construct(
  43                 Title $titleTo, $table, $causeAction = 'unknown', $causeAgent = 'unknown'
  44         ) {
  45                 $this->mTitle = $titleTo;
  46                 $this->mTable = $table;
  47                 $this->causeAction = $causeAction;
  48                 $this->causeAgent = $causeAgent;
  49         }
  50
  51         public function doUpdate() {
  52                 $job = HTMLCacheUpdateJob::newForBacklinks(
  53                         $this->mTitle,
  54                         $this->mTable,
  55                         [ 'causeAction' => $this->getCauseAction(), 'causeAgent' => $this->getCauseAgent() ]
  56                 );
  57
  58                 JobQueueGroup::singleton()->lazyPush( $job );
  59         }
  60 }