includes/deferred/DataUpdate.php

   1 <?php
   2 /**
   3  * Base code for update jobs that do something with some secondary
   4  * data extracted from article.
   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  * @file
  22  */
  23
  24 namespace MediaWiki\Deferred;
  25
  26 /**
  27  * Abstract base class for update jobs that do something with some secondary
  28  * data extracted from article.
  29  *
  30  * @stable to extend
  31  */
  32 abstract class DataUpdate implements DeferrableUpdate {
  33         /** @var mixed Result from LBFactory::getEmptyTransactionTicket() */
  34         protected $ticket;
  35         /** @var string Short update cause action description */
  36         protected $causeAction = 'unknown';
  37         /** @var string Short update cause user description */
  38         protected $causeAgent = 'unknown';
  39
  40         /**
  41          * @stable to call
  42          */
  43         public function __construct() {
  44                 // noop
  45         }
  46
  47         /**
  48          * @param mixed $ticket Result of getEmptyTransactionTicket()
  49          * @since 1.28
  50          */
  51         public function setTransactionTicket( $ticket ) {
  52                 $this->ticket = $ticket;
  53         }
  54
  55         /**
  56          * @param string $action Action type
  57          * @param string $user User name
  58          */
  59         public function setCause( $action, $user ) {
  60                 $this->causeAction = $action;
  61                 $this->causeAgent = $user;
  62         }
  63
  64         /**
  65          * @return string
  66          */
  67         public function getCauseAction() {
  68                 return $this->causeAction;
  69         }
  70
  71         /**
  72          * @return string
  73          */
  74         public function getCauseAgent() {
  75                 return $this->causeAgent;
  76         }
  77
  78 }
  79
  80 /** @deprecated class alias since 1.42 */
  81 class_alias( DataUpdate::class, 'DataUpdate' );