Document $rows on hook ChangesListInitRows as IResultWrapper

[lhc/web/wiklou.git] / includes / changes / ChangesList.php

diff --git a/includes/changes/ChangesList.php b/includes/changes/ChangesList.php
index bf275b3..34adea9 100644 (file)
--- a/includes/changes/ChangesList.php
+++ b/includes/changes/ChangesList.php
@@ -23,7 +23,7 @@
  */
 use MediaWiki\Linker\LinkRenderer;
 use MediaWiki\MediaWikiServices;
-use Wikimedia\Rdbms\ResultWrapper;
+use Wikimedia\Rdbms\IResultWrapper;
 
 class ChangesList extends ContextSource {
        const CSS_CLASS_PREFIX = 'mw-changeslist-';
@@ -192,7 +192,7 @@ class ChangesList extends ContextSource {
         * @param RecentChange|RCCacheEntry $rc
         * @param string|bool $watched Optionally timestamp for adding watched class
         *
-        * @return array of classes
+        * @return string[] List of CSS class names
         */
        protected function getHTMLClasses( $rc, $watched ) {
                $classes = [ self::CSS_CLASS_PREFIX . 'line' ];
@@ -298,7 +298,7 @@ class ChangesList extends ContextSource {
        }
 
        /**
-        * @param ResultWrapper|array $rows
+        * @param IResultWrapper|array $rows
         */
        public function initChangesListRows( $rows ) {
                Hooks::run( 'ChangesListInitRows', [ $this, $rows ] );
@@ -395,6 +395,36 @@ class ChangesList extends ContextSource {
                return $out;
        }
 
+       /**
+        * Render the date and time of a revision in the current user language
+        * based on whether the user is able to view this information or not.
+        * @param Revision $rev
+        * @param User $user
+        * @param Language $lang
+        * @param Title|null $title (optional) where Title does not match
+        *   the Title associated with the Revision
+        * @internal For usage by Pager classes only (e.g. HistoryPager and ContribsPager).
+        * @return string HTML
+        */
+       public static function revDateLink( Revision $rev, User $user, Language $lang, $title = null ) {
+               $ts = $rev->getTimestamp();
+               $date = $lang->userTimeAndDate( $ts, $user );
+               if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
+                       $link = MediaWikiServices::getInstance()->getLinkRenderer()->makeKnownLink(
+                               $title ?? $rev->getTitle(),
+                               $date,
+                               [ 'class' => 'mw-changeslist-date' ],
+                               [ 'oldid' => $rev->getId() ]
+                       );
+               } else {
+                       $link = htmlspecialchars( $date );
+               }
+               if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
+                       $link = "<span class=\"history-deleted mw-changeslist-date\">$link</span>";
+               }
+               return $link;
+       }
+
        /**
         * @param string &$s HTML to update
         * @param mixed $rc_timestamp
@@ -517,6 +547,7 @@ class ChangesList extends ContextSource {
         * and a separator
         *
         * @param RecentChange $rc
+        * @deprecated use revDateLink instead.
         * @return string HTML fragment
         */
        public function getTimestamp( $rc ) {
@@ -586,7 +617,13 @@ class ChangesList extends ContextSource {
                        return ' <span class="history-deleted">' .
                                $this->msg( 'rev-deleted-comment' )->escaped() . '</span>';
                } else {
-                       return Linker::commentBlock( $rc->mAttribs['rc_comment'], $rc->getTitle() );
+                       return Linker::commentBlock( $rc->mAttribs['rc_comment'], $rc->getTitle(),
+                               // Whether section links should refer to local page (using default false)
+                               false,
+                               // wikid to generate links for (using default null) */
+                               null,
+                               // whether parentheses should be rendered as part of the message
+                               false );
                }
        }
 
@@ -603,7 +640,7 @@ class ChangesList extends ContextSource {
                return $this->watchMsgCache->getWithSetCallback(
                        "watching-users-msg:$count",
                        function () use ( $count ) {
-                               return $this->msg( 'number_of_watching_users_RCview' )
+                               return $this->msg( 'number-of-watching-users-for-recent-changes' )
                                        ->numParams( $count )->escaped();
                        }
                );