47620852892e86b69552034e89ba713d4ada8fcd
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.
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.
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
19 * @ingroup RevisionDelete
23 * Abstract base class for deletable items
25 abstract class RevDelItem
extends RevisionItemBase
{
27 * Returns true if the item is "current", and the operation to set the given
28 * bits can't be executed for that reason
33 public function isHideCurrentOp( $newBits ) {
38 * Get the current deletion bitfield value
42 abstract public function getBits();
45 * Set the visibility of the item. This should do any necessary DB queries.
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.
53 * @return bool Success
55 abstract public function setBits( $newBits );
58 * Get the return information about the revision for the API
60 * @param ApiResult $result
61 * @return array Data for the API result
63 abstract public function getApiData( ApiResult
$result );
66 * Lock the item against changes outside of the DB
70 public function lock() {
71 return Status
::newGood();
75 * Unlock the item against changes outside of the DB
79 public function unlock() {
80 return Status
::newGood();