Special page to direct the user to a random page. More...

Inheritance diagram for SpecialRandomInCategory:

[legend]

Collaboration diagram for SpecialRandomInCategory:

[legend]

Public Member Functions
	__construct ( $name='RandomInCategory')

	getRandomTitle ()
	Choose a random title.

	onSubmit (array $data)
	Process the form on POST submission.

	requiresUnblock ()
	Whether this action cannot be executed by a blocked user.

	requiresWrite ()
	Whether this action requires the wiki not to be locked.

	setCategory (Title $cat)
	Set which category to use.

Public Member Functions inherited from FormSpecialPage
	execute ( $par)
	Basic SpecialPage workflow: get a form, send it to the user; get some data back,.

	onSuccess ()
	Do something exciting on successful processing of the form, most likely to show a confirmation message.

Public Member Functions inherited from SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.

	doesWrites ()
	Indicates whether this special page may perform database writes.

	getConfig ()
	Shortcut to get main config object.

	getContext ()
	Gets the context this SpecialPage is executed in.

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page Stable to override.

	getName ()
	Get the name of this Special Page.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRequest ()
	Get the WebRequest being used for this instance.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getSkin ()
	Shortcut to get the skin being used for this instance.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}} Stable to override.

	isListed ()
	Whether this special page is listed in Special:SpecialPages Stable to override.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	run ( $subPage)
	Entry point.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Protected Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.

	getDisplayFormat ()
	Get display format for the form.

	getFormFields ()
	Get an HTMLForm descriptor array.

	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

	getMinAndMaxForCat (Title $category)
	Get the lowest and highest timestamp for a category.

	getQueryInfo ( $rand, $offset, $up)

	getTimestampOffset ( $rand)

	setParameter ( $par)
	Maybe do something interesting with the subpage parameter.

Protected Member Functions inherited from FormSpecialPage
	checkExecutePermissions (User $user)
	Called from execute() to check if the given user can perform this action.

	getForm ()
	Get the HTMLForm to control behavior.

	getMessagePrefix ()
	Get message prefix for HTMLForm.

	postText ()
	Add post-text to the form.

	preText ()
	Add pre-text to the form.

	setReauthPostData (array $data)
	Preserve POST data across reauthentication.

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have Stable to override.

	getCacheTTL ()
	Stable to override.

	getHookContainer ()

	getHookRunner ()

	getLanguageConverter ()
	Shortcut to get language's converter.

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes! Stable to override.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Protected Attributes
Title false	$category = false

string[]	$extra = []

int	$maxOffset = 30

Protected Attributes inherited from FormSpecialPage
string null	$par = null
	The sub-page of the special page.

array null	$reauthPostData = null
	POST data preserved across re-authentication.

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Private Member Functions
	selectRandomPageFromDB ( $rand, $offset, $up, $fname=__METHOD__)

Private Attributes
int null	$maxTimestamp = null

int null	$minTimestamp = null

Additional Inherited Members
Static Public Member Functions inherited from SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

Static Protected Member Functions inherited from SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Detailed Description

Special page to direct the user to a random page.

Note: The method used here is rather biased. It is assumed that the use of this page will be people wanting to get a random page out of a maintenance category, to fix it up. The method used by this page should return different pages in an unpredictable fashion which is hoped to be sufficient, even if some pages are selected more often than others.

A more unbiased method could be achieved by adding a cl_random field to the categorylinks table.

The method used here is as follows:

Find the smallest and largest timestamp in the category
Pick a random timestamp in between
Pick an offset between 0 and 30
Get the offset'ed page that is newer than the timestamp selected The offset is meant to counter the fact the timestamps aren't usually uniformly distributed, so if things are very non-uniform at least we won't have the same page selected 99% of the time.

Definition at line 49 of file SpecialRandomInCategory.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialRandomInCategory::__construct ( $name = 'RandomInCategory' )

Definition at line 61 of file SpecialRandomInCategory.php.

Member Function Documentation

◆ alterForm()

SpecialRandomInCategory::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Parameters

HTMLForm $form

Reimplemented from FormSpecialPage.

Definition at line 101 of file SpecialRandomInCategory.php.

References HTMLForm\setSubmitTextMsg().

◆ getDisplayFormat()

SpecialRandomInCategory::getDisplayFormat ( )

protected

Get display format for the form.

See HTMLForm documentation for available values.

Since: 1.25

Returns: string

Reimplemented from FormSpecialPage.

Definition at line 97 of file SpecialRandomInCategory.php.

◆ getFormFields()

SpecialRandomInCategory::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns: array

Reimplemented from FormSpecialPage.

Definition at line 75 of file SpecialRandomInCategory.php.

References SpecialPage\addHelpLink(), and NS_CATEGORY.

◆ getGroupName()

SpecialRandomInCategory::getGroupName ( )

protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Stable to override

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 314 of file SpecialRandomInCategory.php.

◆ getMinAndMaxForCat()

SpecialRandomInCategory::getMinAndMaxForCat ( Title $category )

protected

Get the lowest and highest timestamp for a category.

Parameters

Title $category

Returns: array The lowest and highest timestamp

Exceptions

MWException If category has no entries.

Definition at line 268 of file SpecialRandomInCategory.php.

References $dbr, $res, DB_REPLICA, wfGetDB(), and wfTimestamp().

Referenced by getTimestampOffset().

◆ getQueryInfo()

SpecialRandomInCategory::getQueryInfo	(	$rand,
		$offset,
		$up
	)

protected

Parameters

float	$rand	Random number between 0 and 1
int	$offset	Extra offset to fudge randomness
bool	$up	True to get the result above the random number, false for below

Returns: array Query information.

Exceptions

MWException

Note: The $up parameter is supposed to counteract what would happen if there was a large gap in the distribution of cl_timestamp values. This way instead of things to the right of the gap being favoured, both sides of the gap are favoured.

Definition at line 206 of file SpecialRandomInCategory.php.

References $dbr, DB_REPLICA, getTimestampOffset(), and wfGetDB().

Referenced by selectRandomPageFromDB().

◆ getRandomTitle()

SpecialRandomInCategory::getRandomTitle ( )

Choose a random title.

Returns: Title|null Title object (or null if nothing to choose from)

Definition at line 156 of file SpecialRandomInCategory.php.

References $title, selectRandomPageFromDB(), and wfRandom().

Referenced by onSubmit().

◆ getTimestampOffset()

SpecialRandomInCategory::getTimestampOffset ( $rand )

protected

Parameters

float $rand Random number between 0 and 1

Returns: int|bool A random (unix) timestamp from the range of the category or false on failure

Definition at line 243 of file SpecialRandomInCategory.php.

References $minTimestamp, and getMinAndMaxForCat().

Referenced by getQueryInfo().

◆ onSubmit()

SpecialRandomInCategory::onSubmit ( array $data )

Process the form on POST submission.

@phpcs:disable MediaWiki.Commenting.FunctionComment.ExtraParamComment

Parameters

array	$data
HTMLForm \| null	$form	PhanCommentParamWithoutRealParam Many implementations don't have $form

Returns: bool|string|array|Status As documented for HTMLForm::trySubmit. @phpcs:enable MediaWiki.Commenting.FunctionComment.ExtraParamComment

Reimplemented from FormSpecialPage.

Definition at line 110 of file SpecialRandomInCategory.php.

References $title, SpecialPage\getOutput(), getRandomTitle(), SpecialPage\getRequest(), SpecialPage\msg(), NS_CATEGORY, setCategory(), and wfEscapeWikiText().

Referenced by setParameter().

◆ requiresUnblock()

SpecialRandomInCategory::requiresUnblock ( )

Whether this action cannot be executed by a blocked user.

Returns: bool

Reimplemented from FormSpecialPage.

Definition at line 93 of file SpecialRandomInCategory.php.

◆ requiresWrite()

SpecialRandomInCategory::requiresWrite ( )

Whether this action requires the wiki not to be locked.

Returns: bool

Reimplemented from FormSpecialPage.

Definition at line 89 of file SpecialRandomInCategory.php.

◆ selectRandomPageFromDB()

SpecialRandomInCategory::selectRandomPageFromDB	(	$rand,
		$offset,
		$up,
		$fname = `__METHOD__`
	)

private

Parameters

float	$rand	A random number that is converted to a random timestamp
int	$offset	A small offset to make the result seem more "random"
bool	$up	Get the result above the random value
string	$fname	The name of the calling method