MediaWiki master
MediaWiki\Specials\SpecialRandomInCategory Class Reference

Redirect to a random page in a category. More...

Inherits MediaWiki\SpecialPage\FormSpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialRandomInCategory:

Public Member Functions

 __construct (IConnectionProvider $dbProvider)
 
 getRandomTitle ()
 Choose a random title.
 
 onSubmit (array $data)
 Process the form on submission.
 
 requiresPost ()
 Whether this action should using POST method to submit, default to true.
 
 setCategory (Title $cat)
 Set which category to use.
 
- Public Member Functions inherited from MediaWiki\SpecialPage\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.
 
 requiresUnblock ()
 Whether this action cannot be executed by a blocked user, default to requiresPost()
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked, default to requiresPost()
 
- Public Member Functions inherited from MediaWiki\SpecialPage\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 POST requests to this special page require write access to the wiki.
 
 getAssociatedNavigationLinks ()
 Return an array of strings representing page titles that are discoverable to end users via UI.
 
 getAuthority ()
 Shortcut to get the Authority executing this instance.
 
 getConfig ()
 Shortcut to get main config object.
 
 getContentLanguage ()
 Shortcut to get content language.
 
 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.
 
 getName ()
 Get the canonical, unlocalized name of this special page without namespace.
 
 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.
 
 getShortDescription (string $path='')
 Similar to getDescription, but takes into account subpages and designed for display in tabs.
 
 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}}.
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages.
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes.
 
 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.
 
 requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', bool $alwaysRedirectToLoginPage=false)
 If the user is not logged in or is a temporary user, throws UserNotLoggedIn.
 
 run ( $subPage)
 Entry point.
 
 setContentLanguage (Language $contentLanguage)
 Set content language.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 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 ()
 Get the lowest and highest timestamp for a category.
 
 getQueryBuilder ( $rand, $offset, $up)
 
 getSubpageField ()
 Override this function to set the field name used in the subpage syntax.
 
 getTimestampOffset ( $rand)
 
- Protected Member Functions inherited from MediaWiki\SpecialPage\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.
 
 getShowAlways ()
 Whether the form should always be shown despite the success of submission.
 
 postHtml ()
 Add post-HTML to the form.
 
 postText ()
 Add post-text to the form.
 
 preHtml ()
 Add pre-HTML to the form.
 
 preText ()
 Add pre-text to the form.
 
 setParameter ( $par)
 Maybe do something interesting with the subpage parameter.
 
 setReauthPostData (array $data)
 Preserve POST data across reauthentication.
 
- Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 authorizeAction (?string $action=null)
 Utility function for authorizing an action to be performed by the special page.
 
 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.
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 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.
 
 getSpecialPageFactory ()
 
 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 By default the message key is the canonical name of the special page May be overridden, i.e.
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages.
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 

Protected Attributes

Title false $category = false
 Title object of category.
 
string[] $extra = []
 Extra SQL statements.
 
int $maxOffset = 30
 Max amount to fudge randomness by.
 
- Protected Attributes inherited from MediaWiki\SpecialPage\FormSpecialPage
string null $par = null
 The subpage of the special page.
 
array null $reauthPostData = null
 POST data preserved across re-authentication.
 
- Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource $mContext
 Current request context.
 
bool $mIncludable
 Whether the special page can be included in an article.
 
bool $mIncluding
 Whether or not this special page is being included from an article.
 
string $mName
 The canonical name of this special page Also used as the message key for the default.
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\SpecialPage\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 newSearchPage (User $user)
 Get the users preferred search page.
 
- Static Protected Member Functions inherited from MediaWiki\SpecialPage\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

Redirect to a random page in a category.

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.
Author
Brian Wolff

Definition at line 57 of file SpecialRandomInCategory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialRandomInCategory::__construct ( IConnectionProvider $dbProvider)
Parameters
IConnectionProvider$dbProvider

Definition at line 74 of file SpecialRandomInCategory.php.

Member Function Documentation

◆ alterForm()

MediaWiki\Specials\SpecialRandomInCategory::alterForm ( HTMLForm $form)
protected

Play with the HTMLForm if you need to more substantially.

Parameters
HTMLForm$form

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 111 of file SpecialRandomInCategory.php.

References MediaWiki\HTMLForm\HTMLForm\setSubmitTextMsg().

◆ getDisplayFormat()

MediaWiki\Specials\SpecialRandomInCategory::getDisplayFormat ( )
protected

Get display format for the form.

See HTMLForm documentation for available values.

Since
1.25
Returns
string

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 107 of file SpecialRandomInCategory.php.

◆ getFormFields()

MediaWiki\Specials\SpecialRandomInCategory::getFormFields ( )
protected

Get an HTMLForm descriptor array.

Returns
array

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 89 of file SpecialRandomInCategory.php.

References MediaWiki\SpecialPage\SpecialPage\addHelpLink(), and NS_CATEGORY.

◆ getGroupName()

MediaWiki\Specials\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'.

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 292 of file SpecialRandomInCategory.php.

◆ getMinAndMaxForCat()

MediaWiki\Specials\SpecialRandomInCategory::getMinAndMaxForCat ( )
protected

Get the lowest and highest timestamp for a category.

Returns
array|null The lowest and highest timestamp, or null if the category has no entries.

Definition at line 267 of file SpecialRandomInCategory.php.

References wfTimestamp().

Referenced by MediaWiki\Specials\SpecialRandomInCategory\getTimestampOffset().

◆ getQueryBuilder()

MediaWiki\Specials\SpecialRandomInCategory::getQueryBuilder ( $rand,
$offset,
$up )
protected
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.
Parameters
float | false$randRandom number between 0 and 1
int$offsetExtra offset to fudge randomness
bool$upTrue to get the result above the random number, false for below
Returns
SelectQueryBuilder

Definition at line 214 of file SpecialRandomInCategory.php.

References MediaWiki\Specials\SpecialRandomInCategory\getTimestampOffset().

◆ getRandomTitle()

MediaWiki\Specials\SpecialRandomInCategory::getRandomTitle ( )

Choose a random title.

Returns
Title|null Title object or null if nothing to choose from

Definition at line 165 of file SpecialRandomInCategory.php.

References wfRandom().

Referenced by MediaWiki\Specials\SpecialRandomInCategory\onSubmit().

◆ getSubpageField()

MediaWiki\Specials\SpecialRandomInCategory::getSubpageField ( )
protected

Override this function to set the field name used in the subpage syntax.

Since
1.40
Returns
false|string

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 115 of file SpecialRandomInCategory.php.

◆ getTimestampOffset()

MediaWiki\Specials\SpecialRandomInCategory::getTimestampOffset ( $rand)
protected
Parameters
float | false$randRandom number between 0 and 1
Returns
int|false A random (unix) timestamp from the range of the category or false on failure

Definition at line 244 of file SpecialRandomInCategory.php.

References MediaWiki\Specials\SpecialRandomInCategory\getMinAndMaxForCat().

Referenced by MediaWiki\Specials\SpecialRandomInCategory\getQueryBuilder().

◆ onSubmit()

MediaWiki\Specials\SpecialRandomInCategory::onSubmit ( array $data)

Process the form on submission.

@phpcs:disable MediaWiki.Commenting.FunctionComment.ExtraParamComment

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

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 119 of file SpecialRandomInCategory.php.

References MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\Specials\SpecialRandomInCategory\getRandomTitle(), MediaWiki\SpecialPage\SpecialPage\getRequest(), MediaWiki\SpecialPage\SpecialPage\msg(), NS_CATEGORY, MediaWiki\Specials\SpecialRandomInCategory\setCategory(), and wfEscapeWikiText().

◆ requiresPost()

MediaWiki\Specials\SpecialRandomInCategory::requiresPost ( )

Whether this action should using POST method to submit, default to true.

Since
1.40
Returns
bool

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 103 of file SpecialRandomInCategory.php.

◆ setCategory()

MediaWiki\Specials\SpecialRandomInCategory::setCategory ( Title $cat)

Set which category to use.

Parameters
Title$cat

Definition at line 83 of file SpecialRandomInCategory.php.

Referenced by MediaWiki\Specials\SpecialRandomInCategory\onSubmit().

Member Data Documentation

◆ $category

Title false MediaWiki\Specials\SpecialRandomInCategory::$category = false
protected

Title object of category.

Definition at line 61 of file SpecialRandomInCategory.php.

◆ $extra

string [] MediaWiki\Specials\SpecialRandomInCategory::$extra = []
protected

Extra SQL statements.

Definition at line 59 of file SpecialRandomInCategory.php.

◆ $maxOffset

int MediaWiki\Specials\SpecialRandomInCategory::$maxOffset = 30
protected

Max amount to fudge randomness by.

Definition at line 63 of file SpecialRandomInCategory.php.


The documentation for this class was generated from the following file: