https://www.mediawiki.org/wiki/Special:Code/MediaWiki/113588

Revision: 113588
Author:   reedy
Date:     2012-03-11 20:51:54 +0000 (Sun, 11 Mar 2012)
Log Message:
-----------
More documentation stubs

Fix Html::inputLabel to Xml::inputLabel

Fix up some deprecated code

Modified Paths:
--------------
    trunk/extensions/AbuseFilter/AbuseFilter.class.php
    trunk/extensions/AbuseFilter/Views/AbuseFilterView.php
    trunk/extensions/AbuseFilter/Views/AbuseFilterViewDiff.php
    trunk/extensions/AbuseFilter/Views/AbuseFilterViewEdit.php
    trunk/extensions/AbuseFilter/Views/AbuseFilterViewHistory.php
    trunk/extensions/AbuseFilter/Views/AbuseFilterViewRevert.php
    trunk/extensions/AbuseFilter/special/SpecialAbuseLog.php

Modified: trunk/extensions/AbuseFilter/AbuseFilter.class.php
===================================================================
--- trunk/extensions/AbuseFilter/AbuseFilter.class.php  2012-03-11 20:40:04 UTC 
(rev 113587)
+++ trunk/extensions/AbuseFilter/AbuseFilter.class.php  2012-03-11 20:51:54 UTC 
(rev 113588)
@@ -990,7 +990,7 @@
         *
         * @param $stored_dump
         *
-        * @return object
+        * @return object|AbuseFilterVariableHolder
         */
        public static function loadVarDump( $stored_dump ) {
                wfProfileIn( __METHOD__ );

Modified: trunk/extensions/AbuseFilter/Views/AbuseFilterView.php
===================================================================
--- trunk/extensions/AbuseFilter/Views/AbuseFilterView.php      2012-03-11 
20:40:04 UTC (rev 113587)
+++ trunk/extensions/AbuseFilter/Views/AbuseFilterView.php      2012-03-11 
20:51:54 UTC (rev 113588)
@@ -53,6 +53,12 @@
 }
 
 class AbuseFilterChangesList extends OldChangesList {
+
+       /**
+        * @param $s
+        * @param $rc
+        * @param $classes array
+        */
        public function insertExtra( &$s, &$rc, &$classes ) {
                $examineParams = empty( $rc->examineParams ) ? array() : 
$rc->examineParams;
 

Modified: trunk/extensions/AbuseFilter/Views/AbuseFilterViewDiff.php
===================================================================
--- trunk/extensions/AbuseFilter/Views/AbuseFilterViewDiff.php  2012-03-11 
20:40:04 UTC (rev 113587)
+++ trunk/extensions/AbuseFilter/Views/AbuseFilterViewDiff.php  2012-03-11 
20:51:54 UTC (rev 113588)
@@ -94,7 +94,7 @@
                                        'history/' . $this->mFilter . '/item/' 
. $other['meta']['history_id'] );
                                global $wgOut;
                                $wgOut->redirect( $t->getFullURL() );
-                               return;
+                               return null;
                        }
 
                } elseif ( $spec == 'next' && !in_array( $otherSpec, 
$dependentSpecs ) ) {
@@ -117,7 +117,7 @@
                                        'history/' . $this->mFilter . '/item/' 
. $other['meta']['history_id'] );
                                global $wgOut;
                                $wgOut->redirect( $t->getFullURL() );
-                               return;
+                               return null;
                        }
                }
 
@@ -148,6 +148,11 @@
                );
        }
 
+       /**
+        * @param $timestamp
+        * @param $history_id
+        * @return string
+        */
        function formatVersionLink( $timestamp, $history_id ) {
                $filter = $this->mFilter;
                $text = $this->getLanguage()->timeanddate( $timestamp, true );
@@ -158,6 +163,9 @@
                return $link;
        }
 
+       /**
+        * @return string
+        */
        function formatDiff() {
                $oldVersion = $this->mOldVersion;
                $newVersion = $this->mNewVersion;
@@ -249,6 +257,10 @@
                return $html;
        }
 
+       /**
+        * @param $actions
+        * @return array
+        */
        function stringifyActions( $actions ) {
                $lines = array();
 
@@ -264,6 +276,10 @@
                return $lines;
        }
 
+       /**
+        * @param $msg
+        * @return String
+        */
        function getHeaderRow( $msg ) {
                $html = wfMsgExt( $msg, 'parseinline' );
                $html = Xml::tags( 'th', array( 'colspan' => 3 ), $html );
@@ -272,6 +288,13 @@
                return $html;
        }
 
+       /**
+        * @param $msg
+        * @param $old
+        * @param $new
+        * @param string $format
+        * @return string
+        */
        function getSimpleRow( $msg, $old, $new, $format = 'wikitext' ) {
                $row = '';
 
@@ -300,6 +323,12 @@
                return Xml::tags( 'tr', null, $row ) . "\n";
        }
 
+       /**
+        * @param $msg
+        * @param $old
+        * @param $new
+        * @return string
+        */
        function getMultiLineRow( $msg, $old, $new ) {
                if ( !is_array( $old ) ) {
                        $old = explode( "\n", preg_replace( "/\\\r\\\n?/", 
"\n", $old ) );

Modified: trunk/extensions/AbuseFilter/Views/AbuseFilterViewEdit.php
===================================================================
--- trunk/extensions/AbuseFilter/Views/AbuseFilterViewEdit.php  2012-03-11 
20:40:04 UTC (rev 113587)
+++ trunk/extensions/AbuseFilter/Views/AbuseFilterViewEdit.php  2012-03-11 
20:51:54 UTC (rev 113588)
@@ -240,6 +240,12 @@
                }
        }
 
+       /**
+        * @param $error
+        * @param $filter
+        * @param $history_id null
+        * @return bool|String
+        */
        function buildFilterEditor( $error, $filter, $history_id = null ) {
                if ( $filter === null ) {
                        return false;
@@ -249,14 +255,13 @@
                $out = $this->getOutput();
                $lang = $this->getLanguage();
                $user = $this->getUser();
-               $sk = $this->getSkin();
 
                // Load from request OR database.
                list( $row, $actions ) = $this->loadRequest( $filter, 
$history_id );
 
                if ( !$row ) {
                        $out->addWikiMsg( 'abusefilter-edit-badfilter' );
-                       $out->addHTML( $sk->link( $this->getTitle(), wfMsg( 
'abusefilter-return' ) ) );
+                       $out->addHTML( Linker::link( $this->getTitle(), wfMsg( 
'abusefilter-return' ) ) );
                        return;
                }
 
@@ -301,7 +306,7 @@
                        $count_display = wfMsgExt( 'abusefilter-hitcount', 
array( 'parseinline' ),
                                $lang->formatNum( $count )
                        );
-                       $hitCount = $sk->makeKnownLinkObj(
+                       $hitCount = Linker::makeKnownLinkObj(
                                SpecialPage::getTitleFor( 'AbuseLog' ),
                                $count_display,
                                'wpSearchFilter=' . $row->af_id
@@ -387,7 +392,7 @@
                if ( $filter != 'new' && $user->isAllowed( 'abusefilter-revert' 
) ) {
                        $tools .= Xml::tags(
                                'p', null,
-                               $sk->link(
+                               Linker::link(
                                        $this->getTitle( 'revert/' . $filter ),
                                        wfMsg( 'abusefilter-edit-revert' )
                                )
@@ -398,15 +403,15 @@
                        // Test link
                        $tools .= Xml::tags(
                                'p', null,
-                               $sk->link(
+                               Linker::link(
                                        $this->getTitle( "test/$filter" ),
                                        wfMsgExt( 'abusefilter-edit-test-link', 
'parseinline' )
                                )
                        );
                        // Last modification details
                        $userLink =
-                               $sk->userLink( $row->af_user, 
$row->af_user_text ) .
-                               $sk->userToolLinks( $row->af_user, 
$row->af_user_text );
+                               Linker::userLink( $row->af_user, 
$row->af_user_text ) .
+                               Linker::userToolLinks( $row->af_user, 
$row->af_user_text );
                        $userName = $row->af_user_text;
                        $fields['abusefilter-edit-lastmod'] =
                                wfMsgExt(
@@ -421,7 +426,7 @@
                                );
                        $history_display = wfMsgExt( 
'abusefilter-edit-viewhistory', array( 'parseinline' ) );
                        $fields['abusefilter-edit-history'] =
-                               $sk->makeKnownLinkObj( $this->getTitle( 
'history/' . $filter ), $history_display );
+                               Linker::makeKnownLinkObj( $this->getTitle( 
'history/' . $filter ), $history_display );
                }
 
                // Add export
@@ -463,6 +468,11 @@
                return $output;
        }
 
+       /**
+        * @param $row
+        * @param $actions
+        * @return string
+        */
        function buildConsequenceEditor( $row, $actions ) {
                global $wgAbuseFilterAvailableActions;
 
@@ -481,6 +491,12 @@
                return $output;
        }
 
+       /**
+        * @param $action
+        * @param $set
+        * @param $parameters
+        * @return string
+        */
        function buildConsequenceSelector( $action, $set, $parameters ) {
                global $wgAbuseFilterAvailableActions;
 
@@ -641,6 +657,10 @@
                }
        }
 
+       /**
+        * @param $warnMsg
+        * @return string
+        */
        function getExistingSelector( $warnMsg ) {
                $existingSelector = new XmlSelect(
                        'wpFilterWarnMessage',
@@ -678,6 +698,10 @@
                return $existingSelector->getHTML();
        }
 
+       /**
+        * @param $id
+        * @return array|null
+        */
        function loadFilterData( $id ) {
                if ( $id == 'new' ) {
                        $obj = new stdClass;
@@ -737,6 +761,11 @@
                return array( $row, $actions );
        }
 
+       /**
+        * @param $filter
+        * @param null $history_id
+        * @return array|null
+        */
        function loadRequest( $filter, $history_id = null ) {
                static $row = null;
                static $actions = null;
@@ -837,6 +866,10 @@
                return array( $row, $actions );
        }
 
+       /**
+        * @param $id
+        * @return array
+        */
        function loadHistoryItem( $id ) {
                $dbr = wfGetDB( DB_SLAVE );
 

Modified: trunk/extensions/AbuseFilter/Views/AbuseFilterViewHistory.php
===================================================================
--- trunk/extensions/AbuseFilter/Views/AbuseFilterViewHistory.php       
2012-03-11 20:40:04 UTC (rev 113587)
+++ trunk/extensions/AbuseFilter/Views/AbuseFilterViewHistory.php       
2012-03-11 20:51:54 UTC (rev 113588)
@@ -118,7 +118,6 @@
        }
 
        function formatValue( $name, $value ) {
-               $sk = $this->getSkin();
                $lang = $this->getLanguage();
 
                $row = $this->mCurrentRow;
@@ -130,12 +129,12 @@
                        case 'afh_timestamp':
                                $title = SpecialPage::getTitleFor( 
'AbuseFilter',
                                        'history/' . $row->afh_filter . 
'/item/' . $row->afh_id );
-                               $formatted = $sk->link( $title, 
$lang->timeanddate( $row->afh_timestamp, true ) );
+                               $formatted = Linker::link( $title, 
$lang->timeanddate( $row->afh_timestamp, true ) );
                                break;
                        case 'afh_user_text':
                                $formatted =
-                                       $sk->userLink( $row->afh_user, 
$row->afh_user_text ) . ' ' .
-                                       $sk->userToolLinks( $row->afh_user, 
$row->afh_user_text );
+                                       Linker::userLink( $row->afh_user, 
$row->afh_user_text ) . ' ' .
+                                       Linker::userToolLinks( $row->afh_user, 
$row->afh_user_text );
                                break;
                        case 'afh_public_comments':
                                $formatted = $this->getOutput()->parse( $value 
);
@@ -158,12 +157,12 @@
                                break;
                        case 'afh_filter':
                                $title = $this->mPage->getTitle( strval( $value 
) );
-                               $formatted = $sk->link( $title, $value );
+                               $formatted = Linker::link( $title, $value );
                                break;
                        case 'afh_id':
                                $title = $this->mPage->getTitle(
                                                        'history/' . 
$row->afh_filter . "/diff/prev/$value" );
-                               $formatted = $sk->link( $title, wfMsgExt( 
'abusefilter-history-diff', 'parseinline' ) );
+                               $formatted = Linker::link( $title, wfMsgExt( 
'abusefilter-history-diff', 'parseinline' ) );
                                break;
                        default:
                                $formatted = "Unable to format $name";

Modified: trunk/extensions/AbuseFilter/Views/AbuseFilterViewRevert.php
===================================================================
--- trunk/extensions/AbuseFilter/Views/AbuseFilterViewRevert.php        
2012-03-11 20:40:04 UTC (rev 113587)
+++ trunk/extensions/AbuseFilter/Views/AbuseFilterViewRevert.php        
2012-03-11 20:51:54 UTC (rev 113588)
@@ -9,7 +9,6 @@
 
                $user = $this->getUser();
                $out = $this->getOutput();
-               $sk = $this->getSkin();
 
                if ( !$user->isAllowed( 'abusefilter-revert' ) ) {
                        throw new PermissionsError( 'abusefilter-revert' );
@@ -67,11 +66,11 @@
                                        array( 'parseinline', 'replaceafter' ),
                                        array(
                                                $lang->timeanddate( 
$result['timestamp'], true ),
-                                               $sk->userLink( 
$result['userid'], $result['user'] ),
+                                               Linker::userLink( 
$result['userid'], $result['user'] ),
                                                $result['action'],
-                                               $sk->link( $result['title'] ),
+                                               Linker::link( $result['title'] 
),
                                                $lang->commaList( 
$displayActions ),
-                                               $sk->link(
+                                               Linker::link(
                                                        
SpecialPage::getTitleFor( 'AbuseLog' ),
                                                        wfMsgNoTrans( 
'abusefilter-log-detailslink' ),
                                                        array(),
@@ -90,7 +89,7 @@
                                Html::hidden( 'title', $this->getTitle( 
"revert/$filter" )->getPrefixedText() ) .
                                Html::hidden( 'wpPeriodStart', 
$this->origPeriodStart ) .
                                Html::hidden( 'wpPeriodEnd', 
$this->origPeriodEnd ) .
-                               Html::inputLabel(
+                               Xml::inputLabel(
                                        wfMsg( 'abusefilter-revert-reasonfield' 
),
                                        'wpReason', 'wpReason', 45
                                ) .

Modified: trunk/extensions/AbuseFilter/special/SpecialAbuseLog.php
===================================================================
--- trunk/extensions/AbuseFilter/special/SpecialAbuseLog.php    2012-03-11 
20:40:04 UTC (rev 113587)
+++ trunk/extensions/AbuseFilter/special/SpecialAbuseLog.php    2012-03-11 
20:51:54 UTC (rev 113588)
@@ -111,6 +111,10 @@
                $this->getOutput()->addHTML( $output );
        }
 
+       /**
+        * @param $id
+        * @return mixed
+        */
        function showHideForm( $id ) {
                if ( !$this->getUser()->isAllowed( 'abusefilter-hide-log' ) ) {
                        $this->getOutput()->addWikiMsg( 
'abusefilter-log-hide-forbidden' );
@@ -157,6 +161,10 @@
                $form->show();
        }
 
+       /**
+        * @param $fields
+        * @return bool
+        */
        function saveHideForm( $fields ) {
                $logid = $this->getRequest()->getVal( 'hide' );
 
@@ -223,6 +231,10 @@
                }
        }
 
+       /**
+        * @param $id
+        * @return mixed
+        */
        function showDetails( $id ) {
                $out = $this->getOutput();
 
@@ -252,7 +264,7 @@
                        return;
                }
 
-               if ( $this->isHidden($row) && !self::canSeeHidden() ) {
+               if ( $this->isHidden( $row ) && !self::canSeeHidden() ) {
                        $out->addWikiMsg( 'abusefilter-log-details-hidden' );
                        return;
                }
@@ -333,6 +345,8 @@
        }
 
        /**
+        * @param $filter_id null
+        * @param $filter_hidden null
         * @return bool
         */
        static function canSeeDetails( $filter_id = null, $filter_hidden = null 
) {
@@ -366,9 +380,13 @@
                return $wgUser->isAllowed( 'abusefilter-hidden-log' );
        }
 
+       /**
+        * @param $row
+        * @param $li bool
+        * @return String
+        */
        function formatRow( $row, $li = true ) {
                $user = $this->getUser();
-               $sk = $this->getSkin();
                $lang = $this->getLanguage();
 
                $actionLinks = array();
@@ -382,9 +400,9 @@
                }
 
                if ( !$row->afl_wiki ) {
-                       $pageLink = $sk->link( $title );
+                       $pageLink = Linker::link( $title );
                        if ( $row->afl_rev_id ) {
-                               $diffLink = $sk->link( $title,
+                               $diffLink = Linker::link( $title,
                                        
wfMessage('abusefilter-log-diff')->parse(), array(),
                                        array( 'diff' => 'prev', 'oldid' => 
$row->afl_rev_id ) );
                        }
@@ -403,8 +421,8 @@
 
                if ( !$row->afl_wiki ) {
                        // Local user
-                       $userLink = $sk->userLink( $row->afl_user, 
$row->afl_user_text ) .
-                               $sk->userToolLinks( $row->afl_user, 
$row->afl_user_text );
+                       $userLink = Linker::userLink( $row->afl_user, 
$row->afl_user_text ) .
+                                       Linker::userToolLinks( $row->afl_user, 
$row->afl_user_text );
                } else {
                        $userLink = WikiMap::foreignUserLink( $row->afl_wiki, 
$row->afl_user_text );
                        $userLink .= ' (' . WikiMap::getWikiName( 
$row->afl_wiki ) . ')';
@@ -440,11 +458,11 @@
 
                if ( self::canSeeDetails( $row->afl_filter, $filter_hidden ) ) {
                        $examineTitle = SpecialPage::getTitleFor( 
'AbuseFilter', 'examine/log/' . $row->afl_id );
-                       $detailsLink = $sk->makeKnownLinkObj(
+                       $detailsLink = Linker::makeKnownLinkObj(
                                $this->getTitle($row->afl_id),
                                wfMsg( 'abusefilter-log-detailslink' )
                        );
-                       $examineLink = $sk->link(
+                       $examineLink = Linker::link(
                                $examineTitle,
                                wfMsgExt( 'abusefilter-changeslist-examine', 
'parseinline' ),
                                array()
@@ -457,7 +475,7 @@
                                $actionLinks[] = $diffLink;
 
                        if ( $user->isAllowed( 'abusefilter-hide-log' ) ) {
-                               $hideLink = $sk->link(
+                               $hideLink = Linker::link(
                                                $this->getTitle(),
                                                wfMsg( 
'abusefilter-log-hidelink' ),
                                                array(),
@@ -474,11 +492,11 @@
                                                                                
        'Special:AbuseFilter/' . $globalIndex );
 
                                $linkText = wfMessage( 
'abusefilter-log-detailedentry-global' )->numParams( $globalIndex )->escaped();
-                               $filterLink = $sk->makeExternalLink( 
$globalURL, $linkText );
+                               $filterLink = Linker::makeExternalLink( 
$globalURL, $linkText );
                        } else {
                                $title = SpecialPage::getTitleFor( 
'AbuseFilter', $row->afl_filter );
                                $linkText = wfMessage( 
'abusefilter-log-detailedentry-local' )->numParams( $row->afl_filter 
)->escaped();
-                               $filterLink = $sk->link( $title, $linkText );
+                               $filterLink = Linker::link( $title, $linkText );
                        }
                        $description = wfMsgExt( 
'abusefilter-log-detailedentry-meta',
                                array( 'parseinline', 'replaceafter' ),
@@ -501,7 +519,7 @@
                                        $timestamp,
                                        $userLink,
                                        $row->afl_action,
-                                       $sk->link( $title ),
+                                       Linker::link( $title ),
                                        $actions_taken,
                                        $parsed_comments
                                )
@@ -537,7 +555,7 @@
        /**
         * Given a log entry row, decides whether or not it can be viewed by 
the public.
         *
-        * @param $row The abuse_filter_log row object.
+        * @param $row object The abuse_filter_log row object.
         * 
         * @return Mixed true if the item is explicitly hidden, false if it is 
not.
         *      The string 'implicit' if it is hidden because the corresponding 
revision is hidden.
@@ -566,6 +584,11 @@
         */
        public $mConds;
 
+       /**
+        * @param $form
+        * @param array $conds
+        * @param bool $details
+        */
        function __construct( $form, $conds = array(), $details = false ) {
                $this->mForm = $form;
                $this->mConds = $conds;


_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs

Reply via email to