includes/revisiondelete/RevDelItem.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup RevisionDelete
  20  */
  21
  22 /**
  23  * Abstract base class for deletable items
  24  */
  25 abstract class RevDelItem extends RevisionItemBase {
  26         /**
  27          * Returns true if the item is "current", and the operation to set the given
  28          * bits can't be executed for that reason
  29          * STUB
  30          * @param int $newBits
  31          * @return bool
  32          */
  33         public function isHideCurrentOp( $newBits ) {
  34                 return false;
  35         }
  36
  37         /**
  38          * Get the current deletion bitfield value
  39          *
  40          * @return integer
  41          */
  42         abstract public function getBits();
  43
  44         /**
  45          * Set the visibility of the item. This should do any necessary DB queries.
  46          *
  47          * The DB update query should have a condition which forces it to only update
  48          * if the value in the DB matches the value fetched earlier with the SELECT.
  49          * If the update fails because it did not match, the function should return
  50          * false. This prevents concurrency problems.
  51          *
  52          * @param int $newBits
  53          * @return bool Success
  54          */
  55         abstract public function setBits( $newBits );
  56
  57         /**
  58          * Get the return information about the revision for the API
  59          * @since 1.23
  60          * @param ApiResult $result API result object
  61          * @return array Data for the API result
  62          */
  63         abstract public function getApiData( ApiResult $result );
  64
  65         /**
  66          * Lock the item against changes outside of the DB
  67          * @return Status
  68          * @since 1.28
  69          */
  70         public function lock() {
  71                 return Status::newGood();
  72         }
  73
  74         /**
  75          * Unlock the item against changes outside of the DB
  76          * @return Status
  77          * @since 1.28
  78          */
  79         public function unlock() {
  80                 return Status::newGood();
  81         }
  82 }