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