Merge "Improve nullable documentation in special page class about args"
This commit is contained in:
commit
3064816e86
10 changed files with 18 additions and 18 deletions
|
|
@ -868,7 +868,7 @@ abstract class QueryPage extends SpecialPage {
|
|||
*
|
||||
* @param IResultWrapper $res The result wrapper to process. Needs to include the title
|
||||
* field and namespace field, if the $ns parameter isn't set.
|
||||
* @param null $ns Use this namespace for the given titles in the result wrapper,
|
||||
* @param int|null $ns Use this namespace for the given titles in the result wrapper,
|
||||
* instead of the namespace value of $res.
|
||||
*/
|
||||
protected function executeLBFromResultWrapper( IResultWrapper $res, $ns = null ) {
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ class SpecialPage implements MessageLocalizer {
|
|||
* @since 1.21 $fragment parameter added
|
||||
*
|
||||
* @param string $name
|
||||
* @param string|bool $subpage Subpage string, or false to not use a subpage
|
||||
* @param string|false $subpage Subpage string, or false to not use a subpage
|
||||
* @param string $fragment The link fragment (after the "#")
|
||||
* @return Title
|
||||
* @throws MWException
|
||||
|
|
@ -115,7 +115,7 @@ class SpecialPage implements MessageLocalizer {
|
|||
*
|
||||
* @since 1.28
|
||||
* @param string $name
|
||||
* @param string|bool $subpage Subpage string, or false to not use a subpage
|
||||
* @param string|false $subpage Subpage string, or false to not use a subpage
|
||||
* @param string $fragment The link fragment (after the "#")
|
||||
* @return TitleValue
|
||||
*/
|
||||
|
|
@ -130,7 +130,7 @@ class SpecialPage implements MessageLocalizer {
|
|||
* Get a localised Title object for a page name with a possibly unvalidated subpage
|
||||
*
|
||||
* @param string $name
|
||||
* @param string|bool $subpage Subpage string, or false to not use a subpage
|
||||
* @param string|false $subpage Subpage string, or false to not use a subpage
|
||||
* @return Title|null Title object or null if the page doesn't exist
|
||||
*/
|
||||
public static function getSafeTitleFor( $name, $subpage = false ) {
|
||||
|
|
@ -737,7 +737,7 @@ class SpecialPage implements MessageLocalizer {
|
|||
/**
|
||||
* Get a self-referential title object
|
||||
*
|
||||
* @param string|bool $subpage
|
||||
* @param string|false $subpage
|
||||
* @return Title
|
||||
* @since 1.23
|
||||
*/
|
||||
|
|
@ -1049,7 +1049,7 @@ class SpecialPage implements MessageLocalizer {
|
|||
* @param int $limit
|
||||
* @param array $query Optional URL query parameter string
|
||||
* @param bool $atend Optional param for specified if this is the last page
|
||||
* @param string|bool $subpage Optional param for specifying subpage
|
||||
* @param string|false $subpage Optional param for specifying subpage
|
||||
* @return string
|
||||
*/
|
||||
protected function buildPrevNextNavigation(
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ abstract class SpecialRedirectToSpecial extends RedirectSpecialPage {
|
|||
/** @var string Name of redirect target */
|
||||
protected $redirName;
|
||||
|
||||
/** @var string Name of subpage of redirect target */
|
||||
/** @var string|false Name of subpage of redirect target */
|
||||
protected $redirSubpage;
|
||||
|
||||
/**
|
||||
|
|
@ -38,7 +38,7 @@ abstract class SpecialRedirectToSpecial extends RedirectSpecialPage {
|
|||
*
|
||||
* @param string $name
|
||||
* @param string $redirName
|
||||
* @param bool $redirSubpage
|
||||
* @param string|false $redirSubpage
|
||||
* @param array $allowedRedirectParams
|
||||
* @param array $addedRedirectParams
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -37,10 +37,10 @@ class SpecialBotPasswords extends FormSpecialPage {
|
|||
/** @var BotPassword|null Bot password being edited, if any */
|
||||
private $botPassword = null;
|
||||
|
||||
/** @var string Operation being performed: create, update, delete */
|
||||
/** @var string|null Operation being performed: create, update, delete */
|
||||
private $operation = null;
|
||||
|
||||
/** @var string New password set, for communication between onSubmit() and onSuccess() */
|
||||
/** @var string|null New password set, for communication between onSubmit() and onSuccess() */
|
||||
private $password = null;
|
||||
|
||||
/** @var Psr\Log\LoggerInterface */
|
||||
|
|
|
|||
|
|
@ -61,10 +61,10 @@ class SpecialMergeHistory extends SpecialPage {
|
|||
/** @var bool Was submitted? */
|
||||
protected $mSubmitted;
|
||||
|
||||
/** @var Title */
|
||||
/** @var Title|null */
|
||||
protected $mTargetObj;
|
||||
|
||||
/** @var Title */
|
||||
/** @var Title|null */
|
||||
protected $mDestObj;
|
||||
|
||||
/** @var int[] */
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ class SpecialRedirect extends FormSpecialPage {
|
|||
*
|
||||
* Example value: `'user'`
|
||||
*
|
||||
* @var string
|
||||
* @var string|null
|
||||
*/
|
||||
protected $mType;
|
||||
|
||||
|
|
@ -46,7 +46,7 @@ class SpecialRedirect extends FormSpecialPage {
|
|||
*
|
||||
* Example value: `'42'`
|
||||
*
|
||||
* @var string
|
||||
* @var string|null
|
||||
*/
|
||||
protected $mValue;
|
||||
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ class SpecialUndelete extends SpecialPage {
|
|||
/** @var int[]|null */
|
||||
private $mFileVersions;
|
||||
|
||||
/** @var Title */
|
||||
/** @var Title|null */
|
||||
private $mTargetObj;
|
||||
/**
|
||||
* @var string Search prefix
|
||||
|
|
|
|||
|
|
@ -357,7 +357,7 @@ class SpecialUploadStash extends UnlistedSpecialPage {
|
|||
* usually is.
|
||||
* Side effect: preps PHP to write headers to STDOUT.
|
||||
* @param string $contentType String suitable for content-type header
|
||||
* @param string $size Length in bytes
|
||||
* @param int $size Length in bytes
|
||||
*/
|
||||
private static function outputFileHeaders( $contentType, $size ) {
|
||||
header( "Content-Type: $contentType", true );
|
||||
|
|
|
|||
|
|
@ -468,7 +468,7 @@ class UserrightsPage extends SpecialPage {
|
|||
* of the logging table. Only keeps essential data, removing redundant fields.
|
||||
*
|
||||
* @param UserGroupMembership|null $ugm May be null if things get borked
|
||||
* @return array
|
||||
* @return array|null
|
||||
*/
|
||||
protected static function serialiseUgmForLog( $ugm ) {
|
||||
if ( !$ugm instanceof UserGroupMembership ) {
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ class AllMessagesTablePager extends TablePager {
|
|||
protected $foreign;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
* @var string|false
|
||||
*/
|
||||
protected $prefix;
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue