*
* @param $page Mixed: SpecialPage or string
* @param $group String
+ * @return null
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function setGroup( $page, $group ) {
}
/**
- * Add a page to a certain display group for Special:SpecialPages
+ * Get the group that the special page belongs in on Special:SpecialPage
*
* @param $page SpecialPage
+ * @return null
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getGroup( &$page ) {
* Formerly used to disable expensive or dangerous special pages. The
* preferred method is now to add a SpecialPage_initList hook.
* @deprecated since 1.18
+ *
+ * @param $name String the page to remove
*/
static function removePage( $name ) {
unset( SpecialPageFactory::getList()->$name );
* Get a special page with a given localised name, or NULL if there
* is no such special page.
*
+ * @param $alias String
* @return SpecialPage object or null if the page doesn't exist
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
* @param $title Title object
* @param $context RequestContext
* @param $including Bool output is being captured for use in {{special:whatever}}
+ * @return Bool
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
public static function executePath( &$title, RequestContext &$context, $including = false ) {
* Returns false if there was no such special page, or a title object if it was
* a redirect.
*
+ * @param $title Title
* @return String: HTML fragment
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
/**
* Get a localised Title object for a specified special page name
*
+ * @param $name String
+ * @param $subpage String|Bool subpage string, or false to not use a subpage
* @return Title object
*/
public static function getTitleFor( $name, $subpage = false ) {
/**
* Get a localised Title object for a page name with a possibly unvalidated subpage
*
+ * @param $name String
+ * @param $subpage String|Bool subpage string, or false to not use a subpage
* @return Title object or null if the page doesn't exist
*/
public static function getSafeTitleFor( $name, $subpage = false ) {
/**
* Get a title for a given alias
*
+ * @param $alias String
* @return Title or null if there is no such alias
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
*
* @param $name String: name of the special page, as seen in links and URLs
* @param $restriction String: user right required, e.g. "block" or "delete"
- * @param $listed Boolean: whether the page is listed in Special:Specialpages
- * @param $function Callback: function called by execute(). By default it is constructed from $name
+ * @param $listed Bool: whether the page is listed in Special:Specialpages
+ * @param $function Callback|Bool: function called by execute(). By default it is constructed from $name
* @param $file String: file which is included by execute(). It is also constructed from $name by default
- * @param $includable Boolean: whether the page can be included in normal pages
+ * @param $includable Bool: whether the page can be included in normal pages
*/
- public function __construct( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
+ public function __construct(
+ $name = '', $restriction = '', $listed = true,
+ $function = false, $file = 'default', $includable = false
+ ) {
$this->init( $name, $restriction, $listed, $function, $file, $includable );
}
/**
* Do the real work for the constructor, mainly so __call() can intercept
* calls to SpecialPage()
- * @see __construct() for param docs
+ * @param $name String: name of the special page, as seen in links and URLs
+ * @param $restriction String: user right required, e.g. "block" or "delete"
+ * @param $listed Bool: whether the page is listed in Special:Specialpages
+ * @param $function Callback|Bool: function called by execute(). By default it is constructed from $name
+ * @param $file String: file which is included by execute(). It is also constructed from $name by default
+ * @param $includable Bool: whether the page can be included in normal pages
*/
private function init( $name, $restriction, $listed, $function, $file, $includable ) {
$this->mName = $name;
/**
* Set whether this page is listed in Special:Specialpages, at run-time
* @since r3583 (v1.3)
+ * @param $listed Bool
* @return Bool
*/
function setListed( $listed ) {
/**
* Get or set whether this special page is listed in Special:SpecialPages
* @since r11308 (v1.6)
+ * @param $x Bool
* @return Bool
*/
function listed( $x = null) {
/**
* These mutators are very evil, as the relevant variables should not mutate. So
* don't use them.
+ * @param $x Mixed
+ * @return Mixed
* @deprecated since 1.18
*/
function name( $x = null ) { return wfSetVar( $this->mName, $x ); }
/**
* Whether the special page is being evaluated via transclusion
+ * @param $x Bool
* @return Bool
*/
function including( $x = null ) {
* Checks user permissions, calls the function given in mFunction
*
* This must be overridden by subclasses; it will be made abstract in a future version
+ *
+ * @param $par String subpage string, if one was specified
*/
function execute( $par ) {
$this->setHeaders();
$msg = $summaryMessageKey;
}
if ( !wfMessage( $msg )->isBlank() and ! $this->including() ) {
- $this->getOutput()->wrapWikiMsg( "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
+ $this->getOutput()->wrapWikiMsg(
+ "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
}
}
/**
* Get a self-referential title object
*
+ * @param $subpage String|Bool
* @return Title object
*/
function getTitle( $subpage = false ) {
}
/**
- * Shortcut to get the skin being used for this instance
+ * Shortcut to get the User executing this instance
*
* @return User
* @since 1.18
return $this->getContext()->getSkin();
}
+ /**
+ * Shortcut to get user's language
+ *
+ * @return Language
+ * @since 1.18
+ */
+ public function getLang() {
+ return $this->getContext()->getLang();
+ }
+
/**
* Return the full title, including $par
*
}
/**
- * Wrapper around wfMessage that sets the current context. Currently this
- * is only the title.
+ * Wrapper around wfMessage that sets the current context.
*
+ * @return Message
* @see wfMessage
*/
public function msg( /* $args */ ) {
- return call_user_func_array( 'wfMessage', func_get_args() )->title( $this->getFullTitle() );
+ return call_user_func_array( array( $this->getContext(), 'msg' ), func_get_args() );
}
/**
$form = new HTMLForm( $this->fields, $this->getContext() );
$form->setSubmitCallback( array( $this, 'onSubmit' ) );
$form->setWrapperLegend( wfMessage( strtolower( $this->getName() ) . '-legend' ) );
- $form->addHeaderText( wfMessage( strtolower( $this->getName() ) . '-text' )->parseAsBlock() );
+ $form->addHeaderText(
+ wfMessage( strtolower( $this->getName() ) . '-text' )->parseAsBlock() );
// Retain query parameters (uselang etc)
- $params = array_diff_key( $this->getRequest()->getQueryValues(), array( 'title' => null ) );
+ $params = array_diff_key(
+ $this->getRequest()->getQueryValues(), array( 'title' => null ) );
$form->addHiddenField( 'redirectparams', wfArrayToCGI( $params ) );
$form->addPreText( $this->preText() );
/**
* Basic SpecialPage workflow: get a form, send it to the user; get some data back,
+ *
+ * @param $par String Subpage string if one was specified
*/
public function execute( $par ) {
$this->setParameter( $par );
* must throw subclasses of ErrorPageError
*
* @param $user User: the user to check, or null to use the context user
+ * @return Bool true
* @throws ErrorPageError
*/
public function userCanExecute( User $user ) {
* Shortcut to construct a special page which is unlisted by default
* @ingroup SpecialPage
*/
-class UnlistedSpecialPage extends SpecialPage
-{
+class UnlistedSpecialPage extends SpecialPage {
function __construct( $name, $restriction = '', $function = false, $file = 'default' ) {
parent::__construct( $name, $restriction, false, $function, $file );
}
* Shortcut to construct an includable special page
* @ingroup SpecialPage
*/
-class IncludableSpecialPage extends SpecialPage
-{
- function __construct( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
+class IncludableSpecialPage extends SpecialPage {
+ function __construct(
+ $name, $restriction = '', $listed = true, $function = false, $file = 'default'
+ ) {
parent::__construct( $name, $restriction, $listed, $function, $file, true );
}
// Redirect to a page title with possible query parameters
if ( $redirect instanceof Title ) {
$url = $redirect->getFullUrl( $query );
- $this->getContext()->output->redirect( $url );
+ $this->getOutput()->redirect( $url );
wfProfileOut( __METHOD__ );
return $redirect;
// Redirect to index.php with query parameters
} elseif ( $redirect === true ) {
global $wgScript;
$url = $wgScript . '?' . wfArrayToCGI( $query );
- $this->getContext()->output->redirect( $url );
+ $this->getOutput()->redirect( $url );
wfProfileOut( __METHOD__ );
return $redirect;
} else {
* If the special page is a redirect, then get the Title object it redirects to.
* False otherwise.
*
+ * @param $par String Subpage string
* @return Title|false
*/
abstract public function getRedirect( $par );
}
abstract class SpecialRedirectToSpecial extends RedirectSpecialPage {
-
var $redirName, $redirSubpage;
- function __construct( $name, $redirName, $redirSubpage = false, $allowedRedirectParams = array(), $addedRedirectParams = array() ) {
+ function __construct(
+ $name, $redirName, $redirSubpage = false,
+ $allowedRedirectParams = array(), $addedRedirectParams = array()
+ ) {
parent::__construct( $name );
$this->redirName = $redirName;
$this->redirSubpage = $redirSubpage;
}
function getRedirect( $subpage ) {
- global $wgUser;
if ( strval( $subpage ) !== '' ) {
- return Title::makeTitle( NS_USER, $wgUser->getName() . '/' . $subpage );
+ return Title::makeTitle( NS_USER, $this->getUser()->getName() . '/' . $subpage );
} else {
- return Title::makeTitle( NS_USER, $wgUser->getName() );
+ return Title::makeTitle( NS_USER, $this->getUser()->getName() );
}
}
}
}
function getRedirect( $subpage ) {
- global $wgUser;
if ( strval( $subpage ) !== '' ) {
- return Title::makeTitle( NS_USER_TALK, $wgUser->getName() . '/' . $subpage );
+ return Title::makeTitle( NS_USER_TALK, $this->getUser()->getName() . '/' . $subpage );
} else {
- return Title::makeTitle( NS_USER_TALK, $wgUser->getName() );
+ return Title::makeTitle( NS_USER_TALK, $this->getUser()->getName() );
}
}
}
}
function getRedirect( $subpage ) {
- global $wgUser;
- return SpecialPage::getTitleFor( 'Contributions', $wgUser->getName() );
+ return SpecialPage::getTitleFor( 'Contributions', $this->getUser()->getName() );
}
}
}
function getRedirect( $subpage ) {
- global $wgUser;
- return SpecialPage::getTitleFor( 'Listfiles', $wgUser->getName() );
+ return SpecialPage::getTitleFor( 'Listfiles', $this->getUser()->getName() );
}
}
dépôts / lhc / web / wiklou.git / blobdiff