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 /**
  25  * Abstract base class for update jobs that do something with some secondary
  26  * data extracted from article.
  27  */
  28 abstract class DataUpdate implements DeferrableUpdate {
  29         /** @var mixed Result from LBFactory::getEmptyTransactionTicket() */
  30         protected $ticket;
  31         /** @var string Short update cause action description */
  32         protected $causeAction = 'unknown';
  33         /** @var string Short update cause user description */
  34         protected $causeAgent = 'unknown';
  35
  36         public function __construct() {
  37                 // noop
  38         }
  39
  40         /**
  41          * @param mixed $ticket Result of getEmptyTransactionTicket()
  42          * @since 1.28
  43          */
  44         public function setTransactionTicket( $ticket ) {
  45                 $this->ticket = $ticket;
  46         }
  47
  48         /**
  49          * @param string $action Action type
  50          * @param string $user User name
  51          */
  52         public function setCause( $action, $user ) {
  53                 $this->causeAction = $action;
  54                 $this->causeAgent = $user;
  55         }
  56
  57         /**
  58          * @return string
  59          */
  60         public function getCauseAction() {
  61                 return $this->causeAction;
  62         }
  63
  64         /**
  65          * @return string
  66          */
  67         public function getCauseAgent() {
  68                 return $this->causeAgent;
  69         }
  70
  71         /**
  72          * Convenience method, calls doUpdate() on every DataUpdate in the array.
  73          *
  74          * @param DataUpdate[] $updates A list of DataUpdate instances
  75          * @throws Exception
  76          * @deprecated Since 1.28 Use DeferredUpdates::execute()
  77          */
  78         public static function runUpdates( array $updates ) {
  79                 foreach ( $updates as $update ) {
  80                         $update->doUpdate();
  81                 }
  82         }
  83 }