<?php
/**
- * SpecialPage: handling special pages and lists thereof.
+ * Parent class for all special pages.
*
- * To add a special page in an extension, add to $wgSpecialPages either
- * an object instance or an array containing the name and constructor
- * parameters. The latter is preferred for performance reasons.
+ * 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.
*
- * The object instantiated must be either an instance of SpecialPage or a
- * sub-class thereof. It must have an execute() method, which sends the HTML
- * for the special page to $wgOut. The parent class has an execute() method
- * which distributes the call to the historical global functions. Additionally,
- * execute() also checks if the user has the necessary access privileges
- * and bails out if not.
+ * 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.
*
- * To add a core special page, use the similar static list in
- * SpecialPage::$mList. To remove a core static special page at runtime, use
- * a SpecialPage_initList hook.
+ * 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
- * @defgroup SpecialPage SpecialPage
*/
/**
*
* @param $page Mixed: SpecialPage or string
* @param $group String
- * @return null
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function setGroup( $page, $group ) {
wfDeprecated( __METHOD__, '1.18' );
- return SpecialPageFactory::setGroup( $page, $group );
+ SpecialPageFactory::setGroup( $page, $group );
}
/**
* Get the group that the special page belongs in on Special:SpecialPage
*
* @param $page SpecialPage
- * @return null
+ * @return string
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getGroup( &$page ) {
*
* @param $user User object to check permissions, $wgUser will be used
* if not provided
- * @return Associative array mapping page's name to its SpecialPage object
+ * @return array Associative array mapping page's name to its SpecialPage object
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getUsablePages( User $user = null ) {
/**
* Return categorised listable special pages for all users
*
- * @return Associative array mapping page's name to its SpecialPage object
+ * @return array Associative array mapping page's name to its SpecialPage object
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getRegularPages() {
* Return categorised listable special pages which are available
* for the current user, but not for everyone
*
- * @return Associative array mapping page's name to its SpecialPage object
+ * @return array Associative array mapping page's name to its SpecialPage object
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getRestrictedPages() {
$this->mListed = $listed;
$this->mIncludable = $includable;
if ( !$function ) {
- $this->mFunction = 'wfSpecial'.$name;
+ $this->mFunction = 'wfSpecial' . $name;
} else {
$this->mFunction = $function;
}
if ( $file === 'default' ) {
- $this->mFile = dirname(__FILE__) . "/specials/Special$name.php";
+ $this->mFile = dirname( __FILE__ ) . "/specials/Special$name.php";
} else {
$this->mFile = $file;
}
public function __call( $fName, $a ) {
// Deprecated messages now, remove in 1.19 or 1.20?
wfDeprecated( __METHOD__, '1.17' );
-
+
// Sometimes $fName is SpecialPage, sometimes it's specialpage. <3 PHP
- if( strtolower( $fName ) == 'specialpage' ) {
+ if ( strtolower( $fName ) == 'specialpage' ) {
$name = isset( $a[0] ) ? $a[0] : '';
$restriction = isset( $a[1] ) ? $a[1] : '';
$listed = isset( $a[2] ) ? $a[2] : true;
* @deprecated since 1.18
*/
function getFile() {
- wfDeprecated( __METHOD__, '1.18' );
+ wfDeprecated( __METHOD__, '1.18' );
return $this->mFile;
}
* @param $x Bool
* @return Bool
*/
- function listed( $x = null) {
+ function listed( $x = null ) {
return wfSetVar( $this->mListed, $x );
}
* Whether it's allowed to transclude the special page via {{Special:Foo/params}}
* @return Bool
*/
- public function isIncludable(){
+ public function isIncludable() {
return $this->mIncludable;
}
* @return Mixed
* @deprecated since 1.18
*/
- function restriction( $x = null) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mRestriction, $x ); }
+ function restriction( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mRestriction, $x ); }
/**
* These mutators are very evil, as the relevant variables should not mutate. So
* @return Mixed
* @deprecated since 1.18
*/
- function func( $x = null) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mFunction, $x ); }
+ function func( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mFunction, $x ); }
/**
* These mutators are very evil, as the relevant variables should not mutate. So
* @return Mixed
* @deprecated since 1.18
*/
- function file( $x = null) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mFile, $x ); }
+ function file( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mFile, $x ); }
/**
* These mutators are very evil, as the relevant variables should not mutate. So
public function isRestricted() {
global $wgGroupPermissions;
// DWIM: If all anons can do something, then it is not restricted
- return $this->mRestriction != '' && empty($wgGroupPermissions['*'][$this->mRestriction]);
+ return $this->mRestriction != '' && empty( $wgGroupPermissions['*'][$this->mRestriction] );
}
/**
$func = $this->mFunction;
// only load file if the function does not exist
- if( !is_callable($func) && $this->mFile ) {
+ if ( !is_callable( $func ) && $this->mFile ) {
require_once( $this->mFile );
}
$this->outputHeader();
function outputHeader( $summaryMessageKey = '' ) {
global $wgContLang;
- if( $summaryMessageKey == '' ) {
+ if ( $summaryMessageKey == '' ) {
$msg = $wgContLang->lc( $this->getName() ) . '-summary';
} else {
$msg = $summaryMessageKey;
}
- if ( !$this->msg( $msg )->isBlank() && !$this->including() ) {
+ if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
$this->getOutput()->wrapWikiMsg(
"<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
}
/**
* Gets the context this SpecialPage is executed in
*
- * @return IContextSource
+ * @return IContextSource|RequestContext
* @since 1.18
*/
public function getContext() {
// Works fine as the first parameter, which appears elsewhere in the
// code base. Sighhhh.
$args = func_get_args();
- return call_user_func_array( array( $this->getContext(), 'msg' ), $args );
+ $message = call_user_func_array( array( $this->getContext(), 'msg' ), $args );
+ // RequestContext passes context to wfMessage, and the language is set from
+ // the context, but setting the language for Message class removes the
+ // interface message status, which breaks for example usernameless gender
+ // invokations. Restore the flag when not including special page in content.
+ if ( $this->including() ) {
+ $message->setInterfaceMessageFlag( false );
+ }
+ return $message;
}
/**
$feedTemplate = wfScript( 'api' ) . '?';
- foreach( $wgFeedClasses as $format => $class ) {
+ foreach ( $wgFeedClasses as $format => $class ) {
$theseParams = $params + array( 'feedformat' => $format );
$url = $feedTemplate . wfArrayToCGI( $theseParams );
$this->getOutput()->addFeedLink( $format, $url );
* Maybe do something interesting with the subpage parameter
* @param $par String
*/
- protected function setParameter( $par ){}
+ protected function setParameter( $par ) {}
/**
* Called from execute() to check if the given user can perform this action.
$this->checkPermissions();
if ( $this->requiresUnblock() && $user->isBlocked() ) {
- $block = $user->mBlock;
+ $block = $user->getBlock();
throw new UserBlockedError( $block );
}
parent::__construct( $name, $restriction, false, $function, $file );
}
- public function isListed(){
+ public function isListed() {
return false;
}
}
parent::__construct( $name, $restriction, $listed, $function, $file, true );
}
- public function isIncludable(){
+ public function isIncludable() {
return true;
}
}
// Query parameteres added by redirects
protected $mAddedRedirectParams = array();
- public function execute( $par ){
+ public function execute( $par ) {
$redirect = $this->getRedirect( $par );
$query = $this->getRedirectQuery();
// Redirect to a page title with possible query parameters
* False otherwise.
*
* @param $par String Subpage string
- * @return Title|false
+ * @return Title|bool
*/
abstract public function getRedirect( $par );
public function getRedirectQuery() {
$params = array();
- foreach( $this->mAllowedRedirectParams as $arg ) {
- if( $this->getRequest()->getVal( $arg, null ) !== null ){
+ foreach ( $this->mAllowedRedirectParams as $arg ) {
+ if ( $this->getRequest()->getVal( $arg, null ) !== null ) {
$params[$arg] = $this->getRequest()->getVal( $arg );
}
}
- foreach( $this->mAddedRedirectParams as $arg => $val ) {
+ foreach ( $this->mAddedRedirectParams as $arg => $val ) {
$params[$arg] = $val;
}
* ListAdmins --> ListUsers/sysop
*/
class SpecialListAdmins extends SpecialRedirectToSpecial {
- function __construct(){
+ function __construct() {
parent::__construct( 'Listadmins', 'Listusers', 'sysop' );
}
}
* ListBots --> ListUsers/bot
*/
class SpecialListBots extends SpecialRedirectToSpecial {
- function __construct(){
+ function __construct() {
parent::__construct( 'Listbots', 'Listusers', 'bot' );
}
}
* @todo FIXME: This (and the rest of the login frontend) needs to die a horrible painful death
*/
class SpecialCreateAccount extends SpecialRedirectToSpecial {
- function __construct(){
+ function __construct() {
parent::__construct( 'CreateAccount', 'Userlogin', 'signup', array( 'uselang' ) );
}
}
class SpecialMypage extends RedirectSpecialPage {
function __construct() {
parent::__construct( 'Mypage' );
- $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro',
+ $this->mAllowedRedirectParams = array( 'action', 'preload', 'preloadtitle', 'editintro',
'section', 'oldid', 'diff', 'dir',
// Options for action=raw; missing ctype can break JS or CSS in some browsers
'ctype', 'maxage', 'smaxage' );
class SpecialMytalk extends RedirectSpecialPage {
function __construct() {
parent::__construct( 'Mytalk' );
- $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro',
+ $this->mAllowedRedirectParams = array( 'action', 'preload', 'preloadtitle', 'editintro',
'section', 'oldid', 'diff', 'dir' );
}
function getRedirect( $subpage ) {
$subpage = intval( $subpage );
- if( $subpage === 0 ) {
+ if ( $subpage === 0 ) {
# throw an error page when no subpage was given
throw new ErrorPageError( 'nopagetitle', 'nopagetext' );
}
dépôts / lhc / web / wiklou.git / blobdiff