Skin class: documentation and spacing tweaks, shortened some long lines, added braces
authorJack Phoenix <ashley@users.mediawiki.org>
Mon, 1 Feb 2010 13:52:55 +0000 (13:52 +0000)
committerJack Phoenix <ashley@users.mediawiki.org>
Mon, 1 Feb 2010 13:52:55 +0000 (13:52 +0000)
includes/Skin.php

index d00d762..d1a0016 100644 (file)
@@ -3,8 +3,9 @@
  * @defgroup Skins Skins
  */
 
-if ( ! defined( 'MEDIAWIKI' ) )
+if ( !defined( 'MEDIAWIKI' ) ) {
        die( 1 );
+}
 
 /**
  * The main skin class that provide methods and properties for all other skins.
@@ -28,12 +29,13 @@ class Skin extends Linker {
        var $mTitle = null;
 
        /** Constructor, call parent constructor */
-       function Skin() { parent::__construct(); }
+       function __construct() {
+               parent::__construct();
+       }
 
        /**
         * Fetch the set of available skins.
         * @return array of strings
-        * @static
         */
        static function getSkinNames() {
                global $wgValidSkinNames;
@@ -53,7 +55,7 @@ class Skin extends Linker {
                                $matches = array();
                                if( preg_match( '/^([^.]*)\.php$/', $file, $matches ) ) {
                                        $aSkin = $matches[1];
-                                       $wgValidSkinNames[strtolower($aSkin)] = $aSkin;
+                                       $wgValidSkinNames[strtolower( $aSkin )] = $aSkin;
                                }
                        }
                        $skinDir->close();
@@ -82,9 +84,8 @@ class Skin extends Linker {
         * Normalize a skin preference value to a form that can be loaded.
         * If a skin can't be found, it will fall back to the configured
         * default (or the old 'Classic' skin if that's broken).
-        * @param string $key
+        * @param $key String: 'monobook', 'standard', etc.
         * @return string
-        * @static
         */
        static function normalizeKey( $key ) {
                global $wgDefaultSkin;
@@ -105,9 +106,10 @@ class Skin extends Linker {
                $fallback = array(
                        0 => $wgDefaultSkin,
                        1 => 'nostalgia',
-                       2 => 'cologneblue' );
+                       2 => 'cologneblue'
+               );
 
-               if( isset( $fallback[$key] ) ){
+               if( isset( $fallback[$key] ) ) {
                        $key = $fallback[$key];
                }
 
@@ -120,9 +122,8 @@ class Skin extends Linker {
 
        /**
         * Factory method for loading a skin of a given type
-        * @param string $key 'monobook', 'standard', etc
+        * @param $key String: 'monobook', 'standard', etc.
         * @return Skin
-        * @static
         */
        static function &newFromKey( $key ) {
                global $wgStyleDirectory;
@@ -131,13 +132,15 @@ class Skin extends Linker {
 
                $skinNames = Skin::getSkinNames();
                $skinName = $skinNames[$key];
-               $className = 'Skin'.ucfirst($key);
+               $className = 'Skin' . ucfirst( $key );
 
                # Grab the skin class and initialise it.
                if ( !class_exists( $className ) ) {
                        // Preload base classes to work around APC/PHP5 bug
                        $deps = "{$wgStyleDirectory}/{$skinName}.deps.php";
-                       if( file_exists( $deps ) ) include_once( $deps );
+                       if( file_exists( $deps ) ) {
+                               include_once( $deps );
+                       }
                        require_once( "{$wgStyleDirectory}/{$skinName}.php" );
 
                        # Check if we got if not failback to default skin
@@ -168,7 +171,9 @@ class Skin extends Linker {
        function qbSetting() {
                global $wgOut, $wgUser;
 
-               if ( $wgOut->isQuickbarSuppressed() ) { return 0; }
+               if ( $wgOut->isQuickbarSuppressed() ) {
+                       return 0;
+               }
                $q = $wgUser->getOption( 'quickbar', 0 );
                return $q;
        }
@@ -180,7 +185,7 @@ class Skin extends Linker {
 
                # Generally the order of the favicon and apple-touch-icon links
                # should not matter, but Konqueror (3.5.9 at least) incorrectly
-               # uses whichever one appears later in the HTML source.  Make sure
+               # uses whichever one appears later in the HTML source. Make sure
                # apple-touch-icon is specified first to avoid this.
                if( false !== $wgAppleTouchIcon ) {
                        $out->addLink( array( 'rel' => 'apple-touch-icon', 'href' => $wgAppleTouchIcon ) );
@@ -229,6 +234,11 @@ class Skin extends Linker {
                $lb->execute();
        }
 
+       /**
+        * Adds metadata links (Creative Commons/Dublin Core/copyright) to the HTML
+        * output.
+        * @param $out Object: instance of OutputPage
+        */
        function addMetadataLinks( OutputPage $out ) {
                global $wgEnableDublinCoreRdf, $wgEnableCreativeCommonsRdf;
                global $wgRightsPage, $wgRightsUrl;
@@ -271,7 +281,7 @@ class Skin extends Linker {
        /**
         * Set some local variables
         */
-       protected function setMembers(){
+       protected function setMembers() {
                global $wgUser;
                $this->mUser = $wgUser;
                $this->userpage = $wgUser->getUserPage()->getPrefixedText();
@@ -291,6 +301,10 @@ class Skin extends Linker {
                return $this->mTitle;
        }
 
+       /**
+        * Outputs the HTML generated by other functions.
+        * @param $out Object: instance of OutputPage
+        */
        function outputPage( OutputPage $out ) {
                global $wgDebugComments;
                wfProfileIn( __METHOD__ );
@@ -416,25 +430,26 @@ class Skin extends Linker {
                        $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
                }
 
-               //if on upload page output the extension list & js_upload
-               if( SpecialPage::resolveAlias( $wgTitle->getDBkey() ) ==  "Upload" ) {
+               // if on upload page output the extension list & js_upload
+               if( SpecialPage::resolveAlias( $wgTitle->getDBkey() ) == 'Upload' ) {
                        global $wgFileExtensions, $wgAjaxUploadInterface;
                        $vars['wgFileExtensions'] = $wgFileExtensions;
                }
 
-               if( $wgUseAjax && $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ){
+               if( $wgUseAjax && $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ) {
                        $vars['wgMWSuggestTemplate'] = SearchEngine::getMWSuggestTemplate();
                        $vars['wgDBname'] = $wgDBname;
                        $vars['wgSearchNamespaces'] = SearchEngine::userNamespaces( $wgUser );
                        $vars['wgMWSuggestMessages'] = array( wfMsg( 'search-mwsuggest-enabled' ), wfMsg( 'search-mwsuggest-disabled' ) );
                }
 
-               foreach( $wgRestrictionTypes as $type )
+               foreach( $wgRestrictionTypes as $type ) {
                        $vars['wgRestriction' . ucfirst( $type )] = $wgTitle->getRestrictions( $type );
+               }
 
                if ( $wgOut->isArticleRelated() && $wgUseAjax && $wgAjaxWatch && $wgUser->isLoggedIn() ) {
                        $msgs = (object)array();
-                       foreach ( array( 'watch', 'unwatch', 'watching', 'unwatching', 
+                       foreach ( array( 'watch', 'unwatch', 'watching', 'unwatching',
                                'tooltip-ca-watch', 'tooltip-ca-unwatch' ) as $msgName ) {
                                $msgs->{$msgName . 'Msg'} = wfMsg( $msgName );
                        }
@@ -454,26 +469,30 @@ class Skin extends Linker {
         * passed back with the preview request, we won't render
         * the code.
         *
-        * @param string $action
+        * @param $action String: 'edit', 'submit' etc.
         * @return bool
         */
        public function userCanPreview( $action ) {
                global $wgRequest, $wgUser;
 
-               if( $action != 'submit' )
+               if( $action != 'submit' ) {
                        return false;
-               if( !$wgRequest->wasPosted() )
+               }
+               if( !$wgRequest->wasPosted() ) {
                        return false;
-               if( !$this->mTitle->userCanEditCssSubpage() )
+               }
+               if( !$this->mTitle->userCanEditCssSubpage() ) {
                        return false;
-               if( !$this->mTitle->userCanEditJsSubpage() )
+               }
+               if( !$this->mTitle->userCanEditJsSubpage() ) {
                        return false;
+               }
                return $wgUser->matchEditToken(
                        $wgRequest->getVal( 'wpEditToken' ) );
        }
 
        /**
-        * generated JavaScript action=raw&gen=js
+        * Generated JavaScript action=raw&gen=js
         * This returns MediaWiki:Common.js and MediaWiki:[Skinname].js concate-
         * nated together.  For some bizarre reason, it does *not* return any
         * custom user JS from subpages.  Huh?
@@ -483,8 +502,7 @@ class Skin extends Linker {
         * top.  For now Monobook.js will be maintained, but it should be consi-
         * dered deprecated.
         *
-        * @param $force_skin string If set, overrides the skin name
-        *
+        * @param $skinName String: If set, overrides the skin name
         * @return string
         */
        public function generateUserJs( $skinName = null ) {
@@ -496,7 +514,7 @@ class Skin extends Linker {
                }
 
                $s = "/* generated javascript */\n";
-               $s .= "var skin = '" . Xml::escapeJsString($skinName ) . "';\n";
+               $s .= "var skin = '" . Xml::escapeJsString( $skinName ) . "';\n";
                $s .= "var stylepath = '" . Xml::escapeJsString( $wgStylePath ) . "';";
                $s .= "\n\n/* MediaWiki:Common.js */\n";
                $commonJs = wfMsgExt( 'common.js', 'content' );
@@ -504,7 +522,7 @@ class Skin extends Linker {
                        $s .= $commonJs;
                }
 
-               $s .= "\n\n/* MediaWiki:".ucfirst( $skinName ).".js */\n";
+               $s .= "\n\n/* MediaWiki:" . ucfirst( $skinName ) . ".js */\n";
                // avoid inclusion of non defined user JavaScript (with custom skins only)
                // by checking for default message content
                $msgKey = ucfirst( $skinName ) . '.js';
@@ -531,7 +549,7 @@ class Skin extends Linker {
        /**
         * Split for easier subclassing in SkinSimple, SkinStandard and SkinCologneBlue
         */
-       protected function reallyGenerateUserStylesheet(){
+       protected function reallyGenerateUserStylesheet() {
                global $wgUser;
                $s = '';
                if( ( $undopt = $wgUser->getOption( 'underline' ) ) < 2 ) {
@@ -632,8 +650,10 @@ CSS;
                                // @FIXME: properly escape the cdata!
                                $out->addInlineStyle( $wgRequest->getText( 'wpTextbox1' ) );
                        } else {
-                               $out->addStyle( self::makeUrl( $this->userpage . '/' . $this->getSkinName() .'.css',
-                                       'action=raw&ctype=text/css' ) );
+                               $out->addStyle( self::makeUrl(
+                                       $this->userpage . '/' . $this->getSkinName() . '.css',
+                                       'action=raw&ctype=text/css' )
+                               );
                        }
                }
 
@@ -652,7 +672,7 @@ CSS;
        }
 
        function getPageClasses( $title ) {
-               $numeric = 'ns-'.$title->getNamespace();
+               $numeric = 'ns-' . $title->getNamespace();
                if( $title->getNamespace() == NS_SPECIAL ) {
                        $type = 'ns-special';
                } elseif( $title->isTalkPage() ) {
@@ -660,7 +680,7 @@ CSS;
                } else {
                        $type = 'ns-subject';
                }
-               $name = Sanitizer::escapeClass( 'page-'.$title->getPrefixedText() );
+               $name = Sanitizer::escapeClass( 'page-' . $title->getPrefixedText() );
                return "$numeric $type $name";
        }
 
@@ -687,7 +707,8 @@ CSS;
                $s = '';
                $qb = $this->qbSetting();
 
-               if( $langlinks = $this->otherLanguages() ) {
+               $langlinks = $this->otherLanguages();
+               if( $langlinks ) {
                        $rows = 2;
                        $borderhack = '';
                } else {
@@ -701,11 +722,13 @@ CSS;
 
                $shove = ( $qb != 0 );
                $left = ( $qb == 1 || $qb == 3 );
-               if( $wgContLang->isRTL() ) $left = !$left;
+               if( $wgContLang->isRTL() ) {
+                       $left = !$left;
+               }
 
                if( !$shove ) {
                        $s .= "<td class='top' align='left' valign='top' rowspan='{$rows}'>\n" .
-                         $this->logoText() . '</td>';
+                               $this->logoText() . '</td>';
                } elseif( $left ) {
                        $s .= $this->getQuickbarCompensator( $rows );
                }
@@ -713,12 +736,12 @@ CSS;
                $s .= "<td {$borderhack} align='$l' valign='top'>\n";
 
                $s .= $this->topLinks();
-               $s .= "<p class='subtitle'>" . $this->pageTitleLinks() . "</p>\n";
+               $s .= '<p class="subtitle">' . $this->pageTitleLinks() . "</p>\n";
 
                $r = $wgContLang->alignEnd();
                $s .= "</td>\n<td {$borderhack} valign='top' align='$r' nowrap='nowrap'>";
                $s .= $this->nameAndLogin();
-               $s .= "\n<br />" . $this->searchForm() . "</td>";
+               $s .= "\n<br />" . $this->searchForm() . '</td>';
 
                if ( $langlinks ) {
                        $s .= "</tr>\n<tr>\n<td class='top' colspan=\"2\">$langlinks</td>\n";
@@ -741,12 +764,13 @@ CSS;
                return $s;
        }
 
-
        function getCategoryLinks() {
                global $wgOut, $wgUseCategoryBrowser;
                global $wgContLang, $wgUser;
 
-               if( count( $wgOut->mCategoryLinks ) == 0 ) return '';
+               if( count( $wgOut->mCategoryLinks ) == 0 ) {
+                       return '';
+               }
 
                # Separator
                $sep = wfMsgExt( 'catseparator', array( 'parsemag', 'escapenoentities' ) );
@@ -781,12 +805,12 @@ CSS;
                        $s .= "<div id=\"mw-hidden-catlinks\" class=\"$class\">" .
                                wfMsgExt( 'hidden-categories', array( 'parsemag', 'escapenoentities' ), count( $allCats['hidden'] ) ) .
                                $colon . $embed . implode( "$pop $sep $embed", $allCats['hidden'] ) . $pop .
-                               "</div>";
+                               '</div>';
                }
 
                # optional 'dmoz-like' category browser. Will be shown under the list
                # of categories an article belong to
-               if( $wgUseCategoryBrowser ){
+               if( $wgUseCategoryBrowser ) {
                        $s .= '<br /><hr />';
 
                        # get a big array of the parents tree
@@ -810,7 +834,7 @@ CSS;
         * @param &skin Object: skin passed by reference
         * @return String separated by &gt;, terminate with "\n"
         */
-       function drawCategoryBrowser( $tree, &$skin ){
+       function drawCategoryBrowser( $tree, &$skin ) {
                $return = '';
                foreach( $tree as $element => $parent ) {
                        if( empty( $parent ) ) {
@@ -838,7 +862,7 @@ CSS;
                $showHidden = $wgUser->getBoolOption( 'showhiddencats' ) ||
                                                $this->mTitle->getNamespace() == NS_CATEGORY;
 
-               if( empty($allCats['normal']) && !( !empty($allCats['hidden']) && $showHidden ) ) {
+               if( empty( $allCats['normal'] ) && !( !empty( $allCats['hidden'] ) && $showHidden ) ) {
                        $classes .= ' catlinks-allhidden';
                }
 
@@ -866,10 +890,10 @@ CSS;
        protected function afterContentHook() {
                $data = '';
 
-               if( wfRunHooks( 'SkinAfterContent', array( &$data ) ) ){
+               if( wfRunHooks( 'SkinAfterContent', array( &$data ) ) ) {
                        // adding just some spaces shouldn't toggle the output
                        // of the whole <div/>, so we use trim() here
-                       if( trim( $data ) != '' ){
+                       if( trim( $data ) != '' ) {
                                // Doing this here instead of in the skins to
                                // ensure that the div has the same ID in all
                                // skins
@@ -909,8 +933,9 @@ CSS;
                        $ident = strlen( $line ) - strlen( $display );
                        $diff = $ident - $curIdent;
 
-                       if ( $display == '' )
+                       if ( $display == '' ) {
                                $display = "\xc2\xa0";
+                       }
 
                        if ( !$ident && $diff < 0 && substr( $display, 0, 9 ) != 'Entering ' && substr( $display, 0, 8 ) != 'Exiting ' ) {
                                $ident = $curIdent;
@@ -920,12 +945,13 @@ CSS;
                                $display = htmlspecialchars( $display );
                        }
 
-                       if ( $diff < 0 )
+                       if ( $diff < 0 ) {
                                $ret .= str_repeat( "</li></ul>\n", -$diff ) . "</li><li>\n";
-                       elseif ( $diff == 0 )
+                       } elseif ( $diff == 0 ) {
                                $ret .= "</li><li>\n";
-                       else
+                       } else {
                                $ret .= str_repeat( "<ul><li>\n", $diff );
+                       }
                        $ret .= $display . "\n";
 
                        $curIdent = $ident;
@@ -956,7 +982,7 @@ CSS;
        /** @return string Retrievied from HTML text */
        function printSource() {
                $url = htmlspecialchars( $this->mTitle->getFullURL() );
-               return wfMsg( 'retrievedfrom', '<a href="'.$url.'">'.$url.'</a>' );
+               return wfMsg( 'retrievedfrom', '<a href="' . $url . '">' . $url . '</a>' );
        }
 
        function printFooter() {
@@ -965,7 +991,9 @@ CSS;
        }
 
        /** overloaded by derived classes */
-       function doAfterContent() { return '</div></div>'; }
+       function doAfterContent() {
+               return '</div></div>';
+       }
 
        function pageTitleLinks() {
                global $wgOut, $wgUser, $wgRequest, $wgLang;
@@ -1087,6 +1115,10 @@ CSS;
                return $wgLang->pipeList( $s );
        }
 
+       /**
+        * Gets the h1 element with the page title.
+        * @return string
+        */
        function pageTitle() {
                global $wgOut;
                $s = '<h1 class="pagetitle">' . $wgOut->getPageTitle() . '</h1>';
@@ -1109,8 +1141,9 @@ CSS;
 
        function subPageSubtitle() {
                $subpages = '';
-               if( !wfRunHooks( 'SkinSubPageSubtitle', array( &$subpages ) ) )
+               if( !wfRunHooks( 'SkinSubPageSubtitle', array( &$subpages ) ) ) {
                        return $subpages;
+               }
 
                global $wgOut;
                if( $wgOut->isArticle() && MWNamespace::hasSubpages( $this->mTitle->getNamespace() ) ) {
@@ -1125,7 +1158,7 @@ CSS;
                                        $growinglink .= $link;
                                        $display .= $link;
                                        $linkObj = Title::newFromText( $growinglink );
-                                       if( is_object( $linkObj ) && $linkObj->exists() ){
+                                       if( is_object( $linkObj ) && $linkObj->exists() ) {
                                                $getlink = $this->link(
                                                        $linkObj,
                                                        htmlspecialchars( $display ),
@@ -1230,16 +1263,17 @@ CSS;
                global $wgRequest, $wgUseTwoButtonsSearchForm;
                $search = $wgRequest->getText( 'search' );
 
-               $s = '<form id="searchform'.$this->searchboxes.'" name="search" class="inline" method="post" action="'
+               $s = '<form id="searchform' . $this->searchboxes . '" name="search" class="inline" method="post" action="'
                  . $this->escapeSearchLink() . "\">\n"
-                 . '<input type="text" id="searchInput'.$this->searchboxes.'" name="search" size="19" value="'
+                 . '<input type="text" id="searchInput' . $this->searchboxes . '" name="search" size="19" value="'
                  . htmlspecialchars( substr( $search, 0, 256 ) ) . "\" />\n"
                  . '<input type="submit" name="go" value="' . wfMsg( 'searcharticle' ) . '" />';
 
-               if( $wgUseTwoButtonsSearchForm )
+               if( $wgUseTwoButtonsSearchForm ) {
                        $s .= '&nbsp;<input type="submit" name="fulltext" value="' . wfMsg( 'searchbutton' ) . "\" />\n";
-               else
+               } else {
                        $s .= ' <a href="' . $this->escapeSearchLink() . '" rel="search">' . wfMsg( 'powersearch-legend' ) . "</a>\n";
+               }
 
                $s .= '</form>';
 
@@ -1315,11 +1349,12 @@ CSS;
                if( !$wgDisableLangConversion && sizeof( $variants ) > 1 ) {
                        foreach( $variants as $code ) {
                                $varname = $wgContLang->getVariantname( $code );
-                               if( $varname == 'disable' )
+                               if( $varname == 'disable' ) {
                                        continue;
+                               }
                                $s = $wgLang->pipeList( array(
                                        $s,
-                                       '<a href="' . $this->mTitle->escapeLocalUrl( 'variant=' . $code ) . '">' . htmlspecialchars( $varname ) . '</a>'
+                                       '<a href="' . $this->mTitle->escapeLocalURL( 'variant=' . $code ) . '">' . htmlspecialchars( $varname ) . '</a>'
                                ) );
                        }
                }
@@ -1341,15 +1376,20 @@ CSS;
                        $element[] = $this->whatLinksHere();
                        $element[] = $this->watchPageLinksLink();
 
-                       if( $wgUseTrackbacks )
+                       if( $wgUseTrackbacks ) {
                                $element[] = $this->trackbackLink();
+                       }
 
-                       if ( $this->mTitle->getNamespace() == NS_USER
-                           || $this->mTitle->getNamespace() == NS_USER_TALK ){
+                       if (
+                               $this->mTitle->getNamespace() == NS_USER ||
+                               $this->mTitle->getNamespace() == NS_USER_TALK
+                       )
+                       {
                                $id = User::idFromName( $this->mTitle->getText() );
                                $ip = User::isIP( $this->mTitle->getText() );
 
-                               if( $id || $ip ) { # both anons and non-anons have contri list
+                               # Both anons and non-anons have contributions list
+                               if( $id || $ip ) {
                                        $element[] = $this->userContribsLink();
                                }
                                if( $this->showEmailUser( $id ) ) {
@@ -1361,9 +1401,16 @@ CSS;
 
                        if ( $this->mTitle->getArticleId() ) {
                                $s .= "\n<br />";
-                               if( $wgUser->isAllowed( 'delete' ) ) { $s .= $this->deleteThisPage(); }
-                               if( $wgUser->isAllowed( 'protect' ) ) { $s .= $sep . $this->protectThisPage(); }
-                               if( $wgUser->isAllowed( 'move' ) ) { $s .= $sep . $this->moveThisPage(); }
+                               // Delete/protect/move links for privileged users
+                               if( $wgUser->isAllowed( 'delete' ) ) {
+                                       $s .= $this->deleteThisPage();
+                               }
+                               if( $wgUser->isAllowed( 'protect' ) ) {
+                                       $s .= $sep . $this->protectThisPage();
+                               }
+                               if( $wgUser->isAllowed( 'move' ) ) {
+                                       $s .= $sep . $this->moveThisPage();
+                               }
                        }
                        $s .= "<br />\n" . $this->otherLanguages();
                }
@@ -1377,10 +1424,18 @@ CSS;
 
                $oldid = $wgRequest->getVal( 'oldid' );
                $diff = $wgRequest->getVal( 'diff' );
-               if ( ! $wgOut->isArticle() ) { return ''; }
-               if( !$wgArticle instanceOf Article ) { return ''; }
-               if ( isset( $oldid ) || isset( $diff ) ) { return ''; }
-               if ( 0 == $wgArticle->getID() ) { return ''; }
+               if ( !$wgOut->isArticle() ) {
+                       return '';
+               }
+               if( !$wgArticle instanceof Article ) {
+                       return '';
+               }
+               if ( isset( $oldid ) || isset( $diff ) ) {
+                       return '';
+               }
+               if ( 0 == $wgArticle->getID() ) {
+                       return '';
+               }
 
                $s = '';
                if ( !$wgDisableCounters ) {
@@ -1390,7 +1445,7 @@ CSS;
                        }
                }
 
-               if( $wgMaxCredits != 0 ){
+               if( $wgMaxCredits != 0 ) {
                        $s .= ' ' . Credits::getCredits( $wgArticle, $wgMaxCredits, $wgShowCreditsIfMax );
                } else {
                        $s .= $this->lastModified();
@@ -1398,9 +1453,13 @@ CSS;
 
                if( $wgPageShowWatchingUsers && $wgUser->getOption( 'shownumberswatching' ) ) {
                        $dbr = wfGetDB( DB_SLAVE );
-                       $res = $dbr->select( 'watchlist',
+                       $res = $dbr->select(
+                               'watchlist',
                                array( 'COUNT(*) AS n' ),
-                               array( 'wl_title' => $dbr->strencode( $this->mTitle->getDBkey() ), 'wl_namespace' => $this->mTitle->getNamespace() ),
+                               array(
+                                       'wl_title' => $dbr->strencode( $this->mTitle->getDBkey() ),
+                                       'wl_namespace' => $this->mTitle->getNamespace()
+                               ),
                                __METHOD__
                        );
                        $x = $dbr->fetchObject( $res );
@@ -1445,8 +1504,9 @@ CSS;
                        return $out;
                }
                // Allow for site and per-namespace customization of copyright notice.
-               if( isset($wgArticle) )
+               if( isset( $wgArticle ) ) {
                        wfRunHooks( 'SkinCopyrightFooter', array( $wgArticle->getTitle(), $type, &$msg, &$link ) );
+               }
 
                $out .= wfMsgForContent( $msg, $link );
                return $out;
@@ -1457,7 +1517,7 @@ CSS;
                $out = '';
                if ( isset( $wgCopyrightIcon ) && $wgCopyrightIcon ) {
                        $out = $wgCopyrightIcon;
-               } else if ( $wgRightsIcon ) {
+               } elseif ( $wgRightsIcon ) {
                        $icon = htmlspecialchars( $wgRightsIcon );
                        if ( $wgRightsUrl ) {
                                $url = htmlspecialchars( $wgRightsUrl );
@@ -1472,16 +1532,20 @@ CSS;
                return $out;
        }
 
+       /**
+        * Gets the powered by MediaWiki icon.
+        * @return string
+        */
        function getPoweredBy() {
                global $wgStylePath;
                $url = htmlspecialchars( "$wgStylePath/common/images/poweredby_mediawiki_88x31.png" );
-               $img = '<a href="http://www.mediawiki.org/"><img src="'.$url.'" height="31" width="88" alt="Powered by MediaWiki" /></a>';
+               $img = '<a href="http://www.mediawiki.org/"><img src="' . $url . '" height="31" width="88" alt="Powered by MediaWiki" /></a>';
                return $img;
        }
 
        function lastModified() {
                global $wgLang, $wgArticle;
-               if( $this->mRevisionId && $this->mRevisionId != $wgArticle->getLatest()) {
+               if( $this->mRevisionId && $this->mRevisionId != $wgArticle->getLatest() ) {
                        $timestamp = Revision::getTimestampFromId( $wgArticle->getTitle(), $this->mRevisionId );
                } else {
                        $timestamp = $wgArticle->getTimestamp();
@@ -1516,7 +1580,7 @@ CSS;
        }
 
        /**
-        * show a drop-down box of special pages
+        * Show a drop-down box of special pages
         */
        function specialPagesList() {
                global $wgUser, $wgContLang, $wgServer, $wgRedirectScript;
@@ -1545,6 +1609,10 @@ CSS;
                return $s;
        }
 
+       /**
+        * Gets the link to the wiki's main page.
+        * @return string
+        */
        function mainPageLink() {
                $s = $this->link(
                        Title::newMainPage(),
@@ -1556,7 +1624,7 @@ CSS;
                return $s;
        }
 
-       private function footerLink ( $desc, $page ) {
+       private function footerLink( $desc, $page ) {
                // if the link description has been set to "-" in the default language,
                if ( wfMsgForContent( $desc )  == '-') {
                        // then it is disabled, for all languages.
@@ -1573,14 +1641,23 @@ CSS;
                }
        }
 
+       /**
+        * Gets the link to the wiki's privacy policy page.
+        */
        function privacyLink() {
                return $this->footerLink( 'privacy', 'privacypage' );
        }
 
+       /**
+        * Gets the link to the wiki's about page.
+        */
        function aboutLink() {
                return $this->footerLink( 'aboutsite', 'aboutpage' );
        }
 
+       /**
+        * Gets the link to the wiki's general disclaimers page.
+        */
        function disclaimerLink() {
                return $this->footerLink( 'disclaimers', 'disclaimerpage' );
        }
@@ -1750,7 +1827,7 @@ CSS;
        function showEmailUser( $id ) {
                global $wgUser;
                $targetUser = User::newFromId( $id );
-               return  $wgUser->canSendEmail() && # the sending user must have a confirmed email address
+               return $wgUser->canSendEmail() && # the sending user must have a confirmed email address
                        $targetUser->canReceiveEmail(); # the target user must have a confirmed email address and allow emails from users
        }
 
@@ -1766,7 +1843,7 @@ CSS;
 
        function watchPageLinksLink() {
                global $wgOut;
-               if ( ! $wgOut->isArticleRelated() ) {
+               if ( !$wgOut->isArticleRelated() ) {
                        return '(' . wfMsg( 'notanarticle' ) . ')';
                } else {
                        return $this->link(
@@ -1798,7 +1875,9 @@ CSS;
 
                $s = wfMsg( 'otherlanguages' ) . wfMsg( 'colon-separator' );
                $first = true;
-               if( $wgContLang->isRTL() ) $s .= '<span dir="LTR">';
+               if( $wgContLang->isRTL() ) {
+                       $s .= '<span dir="LTR">';
+               }
                foreach( $a as $l ) {
                        if ( !$first ) {
                                $s .= wfMsgExt( 'pipe-separator', 'escapenoentities' );
@@ -1809,11 +1888,15 @@ CSS;
                        $url = $nt->escapeFullURL();
                        $text = $wgContLang->getLanguageName( $nt->getInterwiki() );
 
-                       if ( $text == '' ) { $text = $l; }
+                       if ( $text == '' ) {
+                               $text = $l;
+                       }
                        $style = $this->getExternalLinkAttributes();
                        $s .= "<a href=\"{$url}\"{$style}>{$text}</a>";
                }
-               if( $wgContLang->isRTL() ) $s .= '</span>';
+               if( $wgContLang->isRTL() ) {
+                       $s .= '</span>';
+               }
                return $s;
        }
 
@@ -1927,8 +2010,10 @@ CSS;
                return $title->getLocalURL( $urlaction );
        }
 
-       # If url string starts with http, consider as external URL, else
-       # internal
+       /**
+        * If url string starts with http, consider as external URL, else
+        * internal
+        */
        static function makeInternalOrExternalUrl( $name ) {
                if ( preg_match( '/^(?:' . wfUrlProtocols() . ')/', $name ) ) {
                        return $name;
@@ -2000,14 +2085,16 @@ CSS;
                $this->addToSidebar( $bar, 'sidebar' );
 
                wfRunHooks( 'SkinBuildSidebar', array( $this, &$bar ) );
-               if ( $wgEnableSidebarCache ) $parserMemc->set( $key, $bar, $wgSidebarCacheExpiry );
+               if ( $wgEnableSidebarCache ) {
+                       $parserMemc->set( $key, $bar, $wgSidebarCacheExpiry );
+               }
                wfProfileOut( __METHOD__ );
                return $bar;
        }
        /**
         * Add content from a sidebar system message
         * Currently only used for MediaWiki:Sidebar (but may be used by Extensions)
-        * 
+        *
         * @param &$bar array
         * @param $message String
         */
@@ -2015,23 +2102,29 @@ CSS;
                $lines = explode( "\n", wfMsgForContent( $message ) );
                $heading = '';
                foreach( $lines as $line ) {
-                       if( strpos( $line, '*' ) !== 0 )
+                       if( strpos( $line, '*' ) !== 0 ) {
                                continue;
+                       }
                        if( strpos( $line, '**') !== 0 ) {
                                $heading = trim( $line, '* ' );
-                               if( !array_key_exists( $heading, $bar ) ) $bar[$heading] = array();
+                               if( !array_key_exists( $heading, $bar ) ) {
+                                       $bar[$heading] = array();
+                               }
                        } else {
                                if( strpos( $line, '|' ) !== false ) { // sanity check
                                        $line = array_map( 'trim', explode( '|', trim( $line, '* ' ), 2 ) );
                                        $link = wfMsgForContent( $line[0] );
-                                       if( $link == '-' )
+                                       if( $link == '-' ) {
                                                continue;
+                                       }
 
                                        $text = wfMsgExt( $line[1], 'parsemag' );
-                                       if( wfEmptyMsg( $line[1], $text ) )
+                                       if( wfEmptyMsg( $line[1], $text ) ) {
                                                $text = $line[1];
-                                       if( wfEmptyMsg( $line[0], $link ) )
+                                       }
+                                       if( wfEmptyMsg( $line[0], $link ) ) {
                                                $link = $line[0];
+                                       }
 
                                        if ( preg_match( '/^(?:' . wfUrlProtocols() . ')/', $link ) ) {
                                                $href = $link;
@@ -2051,7 +2144,9 @@ CSS;
                                                'id' => 'n-' . strtr( $line[1], ' ', '-' ),
                                                'active' => false
                                        );
-                               } else { continue; }
+                               } else {
+                                       continue;
+                               }
                        }
                }
        }