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