Merge "Type hint against LinkTarget in WatchedItemStore"
[lhc/web/wiklou.git] / includes / revisionlist / RevisionItem.php
1 <?php
2 /**
3 * Holders of revision list for a single page
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 use MediaWiki\Storage\RevisionRecord;
24
25 /**
26 * Item class for a live revision table row
27 */
28 class RevisionItem extends RevisionItemBase {
29 /** @var Revision */
30 protected $revision;
31
32 /** @var RequestContext */
33 protected $context;
34
35 public function __construct( $list, $row ) {
36 parent::__construct( $list, $row );
37 $this->revision = new Revision( $row );
38 $this->context = $list->getContext();
39 }
40
41 public function getIdField() {
42 return 'rev_id';
43 }
44
45 public function getTimestampField() {
46 return 'rev_timestamp';
47 }
48
49 public function getAuthorIdField() {
50 return 'rev_user';
51 }
52
53 public function getAuthorNameField() {
54 return 'rev_user_text';
55 }
56
57 public function canView() {
58 return $this->revision->userCan(
59 RevisionRecord::DELETED_RESTRICTED, $this->context->getUser()
60 );
61 }
62
63 public function canViewContent() {
64 return $this->revision->userCan(
65 RevisionRecord::DELETED_TEXT, $this->context->getUser()
66 );
67 }
68
69 public function isDeleted() {
70 return $this->revision->isDeleted( RevisionRecord::DELETED_TEXT );
71 }
72
73 /**
74 * Get the HTML link to the revision text.
75 * @todo Essentially a copy of RevDelRevisionItem::getRevisionLink. That class
76 * should inherit from this one, and implement an appropriate interface instead
77 * of extending RevDelItem
78 * @return string
79 */
80 protected function getRevisionLink() {
81 $date = $this->list->getLanguage()->userTimeAndDate(
82 $this->revision->getTimestamp(), $this->list->getUser() );
83
84 if ( $this->isDeleted() && !$this->canViewContent() ) {
85 return htmlspecialchars( $date );
86 }
87 $linkRenderer = $this->getLinkRenderer();
88 return $linkRenderer->makeKnownLink(
89 $this->list->title,
90 $date,
91 [],
92 [
93 'oldid' => $this->revision->getId(),
94 'unhide' => 1
95 ]
96 );
97 }
98
99 /**
100 * Get the HTML link to the diff.
101 * @todo Essentially a copy of RevDelRevisionItem::getDiffLink. That class
102 * should inherit from this one, and implement an appropriate interface instead
103 * of extending RevDelItem
104 * @return string
105 */
106 protected function getDiffLink() {
107 if ( $this->isDeleted() && !$this->canViewContent() ) {
108 return $this->context->msg( 'diff' )->escaped();
109 } else {
110 $linkRenderer = $this->getLinkRenderer();
111 return $linkRenderer->makeKnownLink(
112 $this->list->title,
113 $this->list->msg( 'diff' )->text(),
114 [],
115 [
116 'diff' => $this->revision->getId(),
117 'oldid' => 'prev',
118 'unhide' => 1
119 ]
120 );
121 }
122 }
123
124 /**
125 * @todo Essentially a copy of RevDelRevisionItem::getHTML. That class
126 * should inherit from this one, and implement an appropriate interface instead
127 * of extending RevDelItem
128 * @return string
129 */
130 public function getHTML() {
131 $difflink = $this->context->msg( 'parentheses' )
132 ->rawParams( $this->getDiffLink() )->escaped();
133 $revlink = $this->getRevisionLink();
134 $userlink = Linker::revUserLink( $this->revision );
135 $comment = Linker::revComment( $this->revision );
136 if ( $this->isDeleted() ) {
137 $revlink = "<span class=\"history-deleted\">$revlink</span>";
138 }
139 return "<li>$difflink $revlink $userlink $comment</li>";
140 }
141 }