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