Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 3
CRAP
0.00% covered (danger)
0.00%
0 / 1
RevDelItem
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 3
12
0.00% covered (danger)
0.00%
0 / 1
 isHideCurrentOp
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 getBits
n/a
0 / 0
n/a
0 / 0
0
 setBits
n/a
0 / 0
n/a
0 / 0
0
 getApiData
n/a
0 / 0
n/a
0 / 0
0
 lock
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 unlock
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
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
22use MediaWiki\RevisionList\RevisionItemBase;
23use MediaWiki\Status\Status;
24
25/**
26 * Abstract base class for deletable items
27 */
28abstract class RevDelItem extends RevisionItemBase {
29    /**
30     * Returns true if the item is "current", and the operation to set the given
31     * bits can't be executed for that reason
32     * STUB
33     * @param int $newBits
34     * @return bool
35     */
36    public function isHideCurrentOp( $newBits ) {
37        return false;
38    }
39
40    /**
41     * Get the current deletion bitfield value
42     *
43     * @return int
44     */
45    abstract public function getBits();
46
47    /**
48     * Set the visibility of the item. This should do any necessary DB queries.
49     *
50     * The DB update query should have a condition which forces it to only update
51     * if the value in the DB matches the value fetched earlier with the SELECT.
52     * If the update fails because it did not match, the function should return
53     * false. This prevents concurrency problems.
54     *
55     * @param int $newBits
56     * @return bool Success
57     */
58    abstract public function setBits( $newBits );
59
60    /**
61     * Get the return information about the revision for the API
62     * @since 1.23
63     * @param ApiResult $result
64     * @return array Data for the API result
65     */
66    abstract public function getApiData( ApiResult $result );
67
68    /**
69     * Lock the item against changes outside of the DB
70     * @return Status
71     * @since 1.28
72     */
73    public function lock() {
74        return Status::newGood();
75    }
76
77    /**
78     * Unlock the item against changes outside of the DB
79     * @return Status
80     * @since 1.28
81     */
82    public function unlock() {
83        return Status::newGood();
84    }
85}