Add numerous missing @throws to method documentation

[lhc/web/wiklou.git] / includes / specials / SpecialUnwatchedpages.php

diff --git a/includes/specials/SpecialUnwatchedpages.php b/includes/specials/SpecialUnwatchedpages.php
index 483afda..d397149 100644 (file)
--- a/includes/specials/SpecialUnwatchedpages.php
+++ b/includes/specials/SpecialUnwatchedpages.php
@@ -1,76 +1,97 @@
 <?php
 /**
+ * Implements Special:Unwatchedpages
+ *
+ * Copyright © 2005 Ævar Arnfjörð Bjarmason
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
  * @file
  * @ingroup SpecialPage
+ * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
  */
 
 /**
  * A special page that displays a list of pages that are not on anyones watchlist.
- * Implements Special:Unwatchedpages
  *
  * @ingroup SpecialPage
- * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
- * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
- * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
  */
 class UnwatchedpagesPage extends QueryPage {
 
-       function getName() { return 'Unwatchedpages'; }
-       function isExpensive() { return true; }
-       function isSyndicated() { return false; }
+       function __construct( $name = 'Unwatchedpages' ) {
+               parent::__construct( $name, 'unwatchedpages' );
+       }
 
-       function getSQL() {
-               $dbr = wfGetDB( DB_SLAVE );
-               list( $page, $watchlist ) = $dbr->tableNamesN( 'page', 'watchlist' );
-               $mwns = NS_MEDIAWIKI;
-               return
-                       "
-                       SELECT
-                               'Unwatchedpages' as type,
-                               page_namespace as namespace,
-                               page_title as title,
-                               page_namespace as value
-                       FROM $page
-                       LEFT JOIN $watchlist ON wl_namespace = page_namespace AND page_title = wl_title
-                       WHERE wl_title IS NULL AND page_is_redirect = 0 AND page_namespace<>$mwns
-                       ";
+       function isExpensive() {
+               return true;
        }
 
-       function sortDescending() { return false; }
+       function isSyndicated() {
+               return false;
+       }
 
+       function getQueryInfo() {
+               return array (
+                       'tables' => array ( 'page', 'watchlist' ),
+                       'fields' => array ( 'namespace' => 'page_namespace',
+                                       'title' => 'page_title',
+                                       'value' => 'page_namespace' ),
+                       'conds' => array ( 'wl_title IS NULL',
+                                       'page_is_redirect' => 0,
+                                       "page_namespace != '" . NS_MEDIAWIKI .
+                                       "'" ),
+                       'join_conds' => array ( 'watchlist' => array (
+                               'LEFT JOIN', array ( 'wl_title = page_title',
+                                       'wl_namespace = page_namespace' ) ) )
+               );
+       }
+
+       function sortDescending() {
+               return false;
+       }
+
+       function getOrderFields() {
+               return array( 'page_namespace', 'page_title' );
+       }
+
+       /**
+        * @param $skin Skin
+        * @param $result
+        * @return string
+        */
        function formatResult( $skin, $result ) {
                global $wgContLang;
 
-               $nt = Title::makeTitle( $result->namespace, $result->title );
+               $nt = Title::makeTitleSafe( $result->namespace, $result->title );
+               if ( !$nt ) {
+                       return Html::element( 'span', array( 'class' => 'mw-invalidtitle' ),
+                               Linker::getInvalidTitleDescription( $this->getContext(), $result->namespace, $result->title ) );
+               }
+
                $text = $wgContLang->convert( $nt->getPrefixedText() );
 
-               $plink = $skin->linkKnown(
+               $plink = Linker::linkKnown( $nt, htmlspecialchars( $text ) );
+               $token = WatchAction::getWatchToken( $nt, $this->getUser() );
+               $wlink = Linker::linkKnown(
                        $nt,
-                       htmlspecialchars( $text )
-               );
-               $wlink = $skin->linkKnown(
-                       $nt,
-                       wfMsgHtml( 'watch' ),
+                       $this->msg( 'watch' )->escaped(),
                        array(),
-                       array( 'action' => 'watch' )
+                       array( 'action' => 'watch', 'token' => $token )
                );
 
-               return wfSpecialList( $plink, $wlink );
+               return $this->getLanguage()->specialList( $plink, $wlink );
        }
 }
-
-/**
- * constructor
- */
-function wfSpecialUnwatchedpages() {
-       global $wgUser, $wgOut;
-
-       if ( ! $wgUser->isAllowed( 'unwatchedpages' ) )
-               return $wgOut->permissionRequired( 'unwatchedpages' );
-
-       list( $limit, $offset ) = wfCheckLimits();
-
-       $wpp = new UnwatchedpagesPage();
-
-       $wpp->doQuery( $offset, $limit );
-}