Add a way for packagers to override some installation details
[lhc/web/wiklou.git] / includes / SkinTemplate.php
index 03292c2..b74f7c5 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * Base class for template-based skins
+ * Base class for template-based skins.
  *
  * 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
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       die( 1 );
-}
-
 /**
  * Wrapper object for MediaWiki's localization functions,
  * to be passed to the template engine.
@@ -139,7 +135,7 @@ class SkinTemplate extends Skin {
                global $wgDisableCounters, $wgSitename, $wgLogo, $wgHideInterlanguageLinks;
                global $wgMaxCredits, $wgShowCreditsIfMax;
                global $wgPageShowWatchingUsers;
-               global $wgUseSiteJs, $wgDebugComments;
+               global $wgDebugComments;
                global $wgArticlePath, $wgScriptPath, $wgServer;
 
                wfProfileIn( __METHOD__ );
@@ -155,6 +151,7 @@ class SkinTemplate extends Skin {
                $out = $this->getOutput();
                $request = $this->getRequest();
                $user = $this->getUser();
+               $title = $this->getTitle();
 
                wfProfileIn( __METHOD__ . '-init' );
                $this->initPage( $out );
@@ -163,7 +160,8 @@ class SkinTemplate extends Skin {
                wfProfileOut( __METHOD__ . '-init' );
 
                wfProfileIn( __METHOD__ . '-stuff' );
-               $this->thispage = $this->getTitle()->getPrefixedDBkey();
+               $this->thispage = $title->getPrefixedDBkey();
+               $this->titletxt = $title->getPrefixedText();
                $this->userpage = $user->getUserPage()->getPrefixedText();
                $query = array();
                if ( !$request->wasPosted() ) {
@@ -175,9 +173,8 @@ class SkinTemplate extends Skin {
                $this->thisquery = wfArrayToCGI( $query );
                $this->loggedin = $user->isLoggedIn();
                $this->username = $user->getName();
-               $this->userdisplayname = $user->getDisplayName();
 
-               if ( $user->isLoggedIn() || $this->showIPinHeader() ) {
+               if ( $this->loggedin || $this->showIPinHeader() ) {
                        $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
                } else {
                        # This won't be used in the standard skins, but we define it to preserve the interface
@@ -185,7 +182,6 @@ class SkinTemplate extends Skin {
                        $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage );
                }
 
-               $this->titletxt = $this->getTitle()->getPrefixedText();
                wfProfileOut( __METHOD__ . '-stuff' );
 
                wfProfileIn( __METHOD__ . '-stuff-head' );
@@ -193,29 +189,17 @@ class SkinTemplate extends Skin {
                        $tpl->set( 'pagecss', false );
                        $tpl->set( 'usercss', false );
 
-                       $this->userjs = $this->userjsprev = false;
-                       # @todo FIXME: This is the only use of OutputPage::isUserJsAllowed() anywhere; can we
-                       # get rid of it?  For that matter, why is any of this here at all?
-                       $this->setupUserJs( $out->isUserJsAllowed() );
-                       $tpl->setRef( 'userjs', $this->userjs );
-                       $tpl->setRef( 'userjsprev', $this->userjsprev );
-
-                       if( $wgUseSiteJs ) {
-                               $jsCache = $this->loggedin ? '&smaxage=0' : '';
-                               $tpl->set( 'jsvarurl',
-                                                 self::makeUrl( '-',
-                                                                               "action=raw$jsCache&gen=js&useskin=" .
-                                                                               urlencode( $this->getSkinName() ) ) );
-                       } else {
-                               $tpl->set( 'jsvarurl', false );
-                       }
+                       $tpl->set( 'userjs', false );
+                       $tpl->set( 'userjsprev', false );
+
+                       $tpl->set( 'jsvarurl', false );
 
                        $tpl->setRef( 'xhtmldefaultnamespace', $wgXhtmlDefaultNamespace );
                        $tpl->set( 'xhtmlnamespaces', $wgXhtmlNamespaces );
                        $tpl->set( 'html5version', $wgHtml5Version );
                        $tpl->set( 'headlinks', $out->getHeadLinks() );
                        $tpl->set( 'csslinks', $out->buildCssLinks() );
-                       $tpl->set( 'pageclass', $this->getPageClasses( $this->getTitle() ) );
+                       $tpl->set( 'pageclass', $this->getPageClasses( $title ) );
                        $tpl->set( 'skinnameclass', ( 'skin-' . Sanitizer::escapeClass( $this->getSkinName() ) ) );
                }
                wfProfileOut( __METHOD__ . '-stuff-head' );
@@ -225,25 +209,25 @@ class SkinTemplate extends Skin {
                $tpl->set( 'pagetitle', $out->getHTMLTitle() );
                $tpl->set( 'displaytitle', $out->mPageLinkTitle );
 
-               $tpl->set( 'titleprefixeddbkey', $this->getTitle()->getPrefixedDBKey() );
-               $tpl->set( 'titletext', $this->getTitle()->getText() );
-               $tpl->set( 'articleid', $this->getTitle()->getArticleId() );
+               $tpl->setRef( 'thispage', $this->thispage );
+               $tpl->setRef( 'titleprefixeddbkey', $this->thispage );
+               $tpl->set( 'titletext', $title->getText() );
+               $tpl->set( 'articleid', $title->getArticleID() );
 
                $tpl->set( 'isarticle', $out->isArticle() );
 
-               $tpl->setRef( 'thispage', $this->thispage );
                $subpagestr = $this->subPageSubtitle();
-               $tpl->set(
-                       'subtitle', !empty( $subpagestr ) ?
-                       '<span class="subpages">' . $subpagestr . '</span>' . $out->getSubtitle() :
-                       $out->getSubtitle()
-               );
+               if ( $subpagestr !== '' ) {
+                       $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
+               }
+               $tpl->set( 'subtitle',  $subpagestr . $out->getSubtitle() );
+
                $undelete = $this->getUndeleteLink();
-               $tpl->set(
-                       'undelete', !empty( $undelete ) ?
-                       '<span class="subpages">' . $undelete . '</span>' :
-                       ''
-               );
+               if ( $undelete === '' ) {
+                       $tpl->set( 'undelete', '' );
+               } else {
+                       $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
+               }
 
                $tpl->set( 'catlinks', $this->getCategories() );
                if( $out->isSyndicated() ) {
@@ -265,16 +249,17 @@ class SkinTemplate extends Skin {
                $tpl->setRef( 'wgScript', $wgScript );
                $tpl->setRef( 'skinname', $this->skinname );
                $tpl->set( 'skinclass', get_class( $this ) );
+               $tpl->setRef( 'skin', $this );
                $tpl->setRef( 'stylename', $this->stylename );
                $tpl->set( 'printable', $out->isPrintable() );
                $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
                $tpl->setRef( 'loggedin', $this->loggedin );
-               $tpl->set( 'notspecialpage', !$this->getTitle()->isSpecialPage() );
+               $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
                /* XXX currently unused, might get useful later
-               $tpl->set( 'editable', ( !$this->getTitle()->isSpecialPage() ) );
-               $tpl->set( 'exists', $this->getTitle()->getArticleID() != 0 );
-               $tpl->set( 'watch', $this->getTitle()->userIsWatching() ? 'unwatch' : 'watch' );
-               $tpl->set( 'protect', count( $this->getTitle()->isProtected() ) ? 'unprotect' : 'protect' );
+               $tpl->set( 'editable', ( !$title->isSpecialPage() ) );
+               $tpl->set( 'exists', $title->getArticleID() != 0 );
+               $tpl->set( 'watch', $title->userIsWatching() ? 'unwatch' : 'watch' );
+               $tpl->set( 'protect', count( $title->isProtected() ) ? 'unprotect' : 'protect' );
                $tpl->set( 'helppage', $this->msg( 'helppage' )->text() );
                */
                $tpl->set( 'searchaction', $this->escapeSearchLink() );
@@ -287,19 +272,17 @@ class SkinTemplate extends Skin {
                $tpl->setRef( 'logopath', $wgLogo );
                $tpl->setRef( 'sitename', $wgSitename );
 
-               $contentlang = $wgContLang->getCode();
-               $contentdir  = $wgContLang->getDir();
-               $userlang = $this->getLanguage()->getCode();
-               $userdir  = $this->getLanguage()->getDir();
+               $lang = $this->getLanguage();
+               $userlang = $lang->getHtmlCode();
+               $userdir  = $lang->getDir();
 
                $tpl->set( 'lang', $userlang );
                $tpl->set( 'dir', $userdir );
-               $tpl->set( 'rtl', $this->getLanguage()->isRTL() );
+               $tpl->set( 'rtl', $lang->isRTL() );
 
-               $tpl->set( 'capitalizeallnouns', $this->getLanguage()->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
+               $tpl->set( 'capitalizeallnouns', $lang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
                $tpl->set( 'showjumplinks', $user->getOption( 'showjumplinks' ) );
-               $tpl->set( 'username', $user->isAnon() ? null : $this->username );
-               $tpl->set( 'userdisplayname', $user->isAnon() ? null : $this->userdisplayname );
+               $tpl->set( 'username', $this->loggedin ? $this->username : null );
                $tpl->setRef( 'userpage', $this->userpage );
                $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href'] );
                $tpl->set( 'userlang', $userlang );
@@ -310,7 +293,7 @@ class SkinTemplate extends Skin {
                $tpl->set( 'userlangattributes', '' );
                $tpl->set( 'specialpageattributes', '' ); # obsolete
 
-               if ( $userlang !== $contentlang || $userdir !== $contentdir ) {
+               if ( $userlang !== $wgContLang->getHtmlCode() || $userdir !== $wgContLang->getDir() ) {
                        $attrs = " lang='$userlang' dir='$userdir'";
                        $tpl->set( 'userlangattributes', $attrs );
                }
@@ -319,7 +302,6 @@ class SkinTemplate extends Skin {
 
                wfProfileIn( __METHOD__ . '-stuff3' );
                $tpl->set( 'newtalk', $this->getNewtalks() );
-               $tpl->setRef( 'skin', $this );
                $tpl->set( 'logo', $this->logoText() );
 
                $tpl->set( 'copyright', false );
@@ -327,11 +309,10 @@ class SkinTemplate extends Skin {
                $tpl->set( 'lastmod', false );
                $tpl->set( 'credits', false );
                $tpl->set( 'numberofwatchingusers', false );
-               if ( $out->isArticle() && $this->getTitle()->exists() ) {
+               if ( $out->isArticle() && $title->exists() ) {
                        if ( $this->isRevisionCurrent() ) {
-                               $article = new Article( $this->getTitle(), 0 );
                                if ( !$wgDisableCounters ) {
-                                       $viewcount = $article->getCount();
+                                       $viewcount = $this->getWikiPage()->getCount();
                                        if ( $viewcount ) {
                                                $tpl->set( 'viewcount', $this->msg( 'viewcount' )->numParams( $viewcount )->parse() );
                                        }
@@ -340,7 +321,7 @@ class SkinTemplate extends Skin {
                                if( $wgPageShowWatchingUsers ) {
                                        $dbr = wfGetDB( DB_SLAVE );
                                        $num = $dbr->selectField( 'watchlist', 'COUNT(*)',
-                                               array( 'wl_title' => $this->getTitle()->getDBkey(), 'wl_namespace' => $this->getTitle()->getNamespace() ),
+                                               array( 'wl_title' => $title->getDBkey(), 'wl_namespace' => $title->getNamespace() ),
                                                __METHOD__
                                        );
                                        if( $num > 0 ) {
@@ -351,9 +332,10 @@ class SkinTemplate extends Skin {
                                }
 
                                if ( $wgMaxCredits != 0 ) {
-                                       $tpl->set( 'credits', Action::factory( 'credits', $article )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
+                                       $tpl->set( 'credits', Action::factory( 'credits', $this->getWikiPage(),
+                                               $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
                                } else {
-                                       $tpl->set( 'lastmod', $this->lastModified( $article ) );
+                                       $tpl->set( 'lastmod', $this->lastModified() );
                                }
                        }
                        $tpl->set( 'copyright', $this->getCopyright() );
@@ -407,23 +389,27 @@ class SkinTemplate extends Skin {
                        $tpl->set( 'debug', '' );
                }
 
-               $tpl->set( 'reporttime', wfReportTime() );
                $tpl->set( 'sitenotice', $this->getSiteNotice() );
                $tpl->set( 'bottomscripts', $this->bottomScripts() );
                $tpl->set( 'printfooter', $this->printSource() );
 
-               # Add a <div class="mw-content-ltr/rtl"> around the body text
+               # An ID that includes the actual body text; without categories, contentSub, ...
+               $realBodyAttribs = array( 'id' => 'mw-content-text' );
+
+               # Add a mw-content-ltr/rtl class to be able to style based on text direction
+               # when the content is different from the UI language, i.e.:
                # not for special pages or file pages AND only when viewing AND if the page exists
                # (or is in MW namespace, because that has default content)
-               if( !in_array( $this->getTitle()->getNamespace(), array( NS_SPECIAL, NS_FILE ) ) &&
+               if( !in_array( $title->getNamespace(), array( NS_SPECIAL, NS_FILE ) ) &&
                        in_array( $request->getVal( 'action', 'view' ), array( 'view', 'historysubmit' ) ) &&
-                       ( $this->getTitle()->exists() || $this->getTitle()->getNamespace() == NS_MEDIAWIKI ) ) {
-                       $pageLang = $this->getTitle()->getPageLanguage();
-                       $realBodyAttribs = array( 'lang' => $pageLang->getCode(), 'dir' => $pageLang->getDir(),
-                               'class' => 'mw-content-'.$pageLang->getDir() );
-                       $out->mBodytext = Html::rawElement( 'div', $realBodyAttribs, $out->mBodytext );
+                       ( $title->exists() || $title->getNamespace() == NS_MEDIAWIKI ) ) {
+                       $pageLang = $title->getPageLanguage();
+                       $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
+                       $realBodyAttribs['dir'] = $pageLang->getDir();
+                       $realBodyAttribs['class'] = 'mw-content-'.$pageLang->getDir();
                }
 
+               $out->mBodytext = Html::rawElement( 'div', $realBodyAttribs, $out->mBodytext );
                $tpl->setRef( 'bodytext', $out->mBodytext );
 
                # Language links
@@ -438,10 +424,12 @@ class SkinTemplate extends Skin {
                                if ( $nt ) {
                                        $language_urls[] = array(
                                                'href' => $nt->getFullURL(),
-                                               'text' => ( $wgContLang->getLanguageName( $nt->getInterwiki() ) != '' ?
-                                                                       $wgContLang->getLanguageName( $nt->getInterwiki() ) : $l ),
+                                               'text' => ( Language::fetchLanguageName( $nt->getInterwiki() ) != '' ?
+                                                                       Language::fetchLanguageName( $nt->getInterwiki() ) : $l ),
                                                'title' => $nt->getText(),
-                                               'class' => $class
+                                               'class' => $class,
+                                               'lang' => $nt->getInterwiki(),
+                                               'hreflang' => $nt->getInterwiki(),
                                        );
                                }
                        }
@@ -468,10 +456,11 @@ class SkinTemplate extends Skin {
                if ( $this->useHeadElement ) {
                        $tpl->set( 'headelement', $out->headElement( $this ) );
                } else {
-                       $tpl->set( 'headscripts', $out->getScript() );
+                       $tpl->set( 'headscripts', $out->getHeadScripts() . $out->getHeadItems() );
                }
 
                $tpl->set( 'debughtml', $this->generateDebugHTML() );
+               $tpl->set( 'reporttime', wfReportTime() );
 
                // original version by hansm
                if( !wfRunHooks( 'SkinTemplateOutputPageBeforeExec', array( &$this, &$tpl ) ) ) {
@@ -525,6 +514,7 @@ class SkinTemplate extends Skin {
         * This is setup as a method so that like with $wgLogo and getLogo() a skin
         * can override this setting and always output one or the other if it has
         * a reason it can't output one of the two modes.
+        * @return bool
         */
        function useCombinedLoginLink() {
                global $wgUseCombinedLoginLink;
@@ -544,16 +534,24 @@ class SkinTemplate extends Skin {
                /* set up the default links for the personal toolbar */
                $personal_urls = array();
 
-               $page = $request->getVal( 'returnto', $this->thispage );
-               $query = $request->getVal( 'returntoquery', $this->thisquery );
-               $a = array( 'returnto' => $page );
-               if( $query != '' ) {
-                       $a['returntoquery'] = $query;
+               # Due to bug 32276, if a user does not have read permissions,
+               # $this->getTitle() will just give Special:Badtitle, which is
+               # not especially useful as a returnto parameter. Use the title
+               # from the request instead, if there was one.
+               $page = Title::newFromURL( $request->getVal( 'title', '' ) );
+               $page = $request->getVal( 'returnto', $page );
+               $a = array();
+               if ( strval( $page ) !== '' ) {
+                       $a['returnto'] = $page;
+                       $query = $request->getVal( 'returntoquery', $this->thisquery );
+                       if( $query != '' ) {
+                               $a['returntoquery'] = $query;
+                       }
                }
                $returnto = wfArrayToCGI( $a );
                if( $this->loggedin ) {
                        $personal_urls['userpage'] = array(
-                               'text' => $this->userdisplayname,
+                               'text' => $this->username,
                                'href' => &$this->userpageUrlDetails['href'],
                                'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
                                'active' => ( $this->userpageUrlDetails['href'] == $pageurl )
@@ -579,10 +577,12 @@ class SkinTemplate extends Skin {
                        );
 
                        # We need to do an explicit check for Special:Contributions, as we
-                       # have to match both the title, and the target (which could come
-                       # from request values or be specified in "sub page" form. The plot
-                       # thickens, because $wgTitle is altered for special pages, so doesn't
-                       # contain the original alias-with-subpage.
+                       # have to match both the title, and the target, which could come
+                       # from request values (Special:Contributions?target=Jimbo_Wales)
+                       # or be specified in "sub page" form
+                       # (Special:Contributions/Jimbo_Wales). The plot
+                       # thickens, because the Title object is altered for special pages,
+                       # so it doesn't contain the original alias-with-subpage.
                        $origTitle = Title::newFromText( $request->getText( 'title' ) );
                        if( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
                                list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
@@ -644,11 +644,14 @@ class SkinTemplate extends Skin {
                                }
                        }
 
+                       if ( isset( $createaccount_url ) ) {
+                               $personal_urls['createaccount'] = $createaccount_url;
+                       }
 
                        if( $this->showIPinHeader() ) {
                                $href = &$this->userpageUrlDetails['href'];
                                $personal_urls['anonuserpage'] = array(
-                                       'text' => $this->userdisplayname,
+                                       'text' => $this->username,
                                        'href' => $href,
                                        'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
                                        'active' => ( $pageurl == $href )
@@ -665,9 +668,6 @@ class SkinTemplate extends Skin {
                        } else {
                                $personal_urls['login'] = $login_url;
                        }
-                       if ( isset($createaccount_url) ) {
-                               $personal_urls['createaccount'] = $createaccount_url;
-                       }
                }
 
                wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$title ) );
@@ -998,7 +998,9 @@ class SkinTemplate extends Skin {
                                                $content_navigation['variants'][] = array(
                                                        'class' => ( $code == $preferred ) ? 'selected' : false,
                                                        'text' => $varname,
-                                                       'href' => $title->getLocalURL( '', $code )
+                                                       'href' => $title->getLocalURL( array( 'variant' => $code ) ),
+                                                       'lang' => $code,
+                                                       'hreflang' => $code
                                                );
                                        }
                                }
@@ -1169,7 +1171,7 @@ class SkinTemplate extends Skin {
                        $nav_urls['whatlinkshere'] = array(
                                'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalUrl()
                        );
-                       if ( $this->getTitle()->getArticleId() ) {
+                       if ( $this->getTitle()->getArticleID() ) {
                                $nav_urls['recentchangeslinked'] = array(
                                        'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalUrl()
                                );
@@ -1184,12 +1186,10 @@ class SkinTemplate extends Skin {
                                'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser )
                        );
 
-                       if ( $user->isLoggedIn() ) {
-                               $logPage = SpecialPage::getTitleFor( 'Log' );
-                               $nav_urls['log'] = array(
-                                       'href' => $logPage->getLocalUrl( array( 'user' => $rootUser ) )
-                               );
-                       }
+                       $logPage = SpecialPage::getTitleFor( 'Log' );
+                       $nav_urls['log'] = array(
+                               'href' => $logPage->getLocalUrl( array( 'user' => $rootUser ) )
+                       );
 
                        if ( $this->getUser()->isAllowed( 'block' ) ) {
                                $nav_urls['blockip'] = array(
@@ -1217,25 +1217,6 @@ class SkinTemplate extends Skin {
                return $this->getTitle()->getNamespaceKey();
        }
 
-       /**
-        * @private
-        * @todo FIXME: Why is this duplicated in/from OutputPage::getHeadScripts()??
-        */
-       function setupUserJs( $allowUserJs ) {
-               global $wgJsMimeType;
-               wfProfileIn( __METHOD__ );
-
-               if( $allowUserJs && $this->loggedin ) {
-                       if( $this->getTitle()->isJsSubpage() and $this->getOutput()->userCanPreview() ) {
-                               # XXX: additional security check/prompt?
-                               $this->userjsprev = '/*<![CDATA[*/ ' . $this->getRequest()->getText( 'wpTextbox1' ) . ' /*]]>*/';
-                       } else {
-                               $this->userjs = self::makeUrl( $this->userpage . '/' . $this->skinname . '.js', 'action=raw&ctype=' . $wgJsMimeType );
-                       }
-               }
-               wfProfileOut( __METHOD__ );
-       }
-
        public function commonPrintStylesheet() {
                return false;
        }
@@ -1333,6 +1314,7 @@ abstract class QuickTemplate {
 
        /**
         * @private
+        * @return bool
         */
        function haveData( $str ) {
                return isset( $this->data[$str] );
@@ -1368,7 +1350,7 @@ abstract class BaseTemplate extends QuickTemplate {
        /**
         * Get a Message object with its context set
         *
-        * @param $name Str message name
+        * @param $name string message name
         * @return Message
         */
        public function getMsg( $name ) {
@@ -1392,6 +1374,7 @@ abstract class BaseTemplate extends QuickTemplate {
         * stored by SkinTemplate.
         * The resulting array is built acording to a format intended to be passed
         * through makeListItem to generate the html.
+        * @return array
         */
        function getToolbox() {
                wfProfileIn( __METHOD__ );
@@ -1452,6 +1435,7 @@ abstract class BaseTemplate extends QuickTemplate {
         * This is in reality the same list as already stored in personal_urls
         * however it is reformatted so that you can just pass the individual items
         * to makeListItem instead of hardcoding the element creation boilerplate.
+        * @return array
         */
        function getPersonalTools() {
                $personal_tools = array();
@@ -1625,6 +1609,7 @@ abstract class BaseTemplate extends QuickTemplate {
         *   A link-fallback can be used to specify a tag to use instead of <a> if there is
         *   no link. eg: If you specify 'link-fallback' => 'span' than any non-link will
         *   output a <span> instead of just text.
+        * @return string
         */
        function makeLink( $key, $item, $options = array() ) {
                if ( isset( $item['text'] ) ) {
@@ -1703,6 +1688,7 @@ abstract class BaseTemplate extends QuickTemplate {
         * If you need an id or class on a single link you should include a "links"
         * array with just one link item inside of it.
         * $options is also passed on to makeLink calls
+        * @return string
         */
        function makeListItem( $key, $item, $options = array() ) {
                if ( isset( $item['links'] ) ) {
@@ -1797,6 +1783,7 @@ abstract class BaseTemplate extends QuickTemplate {
         * If you pass "flat" as an option then the returned array will be a flat array
         * of footer icons instead of a key/value array of footerlinks arrays broken
         * up into categories.
+        * @return array|mixed
         */
        function getFooterLinks( $option = null ) {
                $footerlinks = $this->data['footerlinks'];
@@ -1835,6 +1822,7 @@ abstract class BaseTemplate extends QuickTemplate {
         * in the list of footer icons. This is mostly useful for skins which only
         * display the text from footericons instead of the images and don't want a
         * duplicate copyright statement because footerlinks already rendered one.
+        * @return
         */
        function getFooterIcons( $option = null ) {
                // Generate additional footer icons