MediaWiki  master
SpecialRandomInCategory Class Reference

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

Inheritance diagram for SpecialRandomInCategory:
Collaboration diagram for SpecialRandomInCategory:

Public Member Functions

 __construct ( $name='RandomInCategory')
 
 getRandomTitle ()
 Choose a random title. More...
 
 onSubmit (array $data)
 
 requiresUnblock ()
 
 requiresWrite ()
 
 setCategory (Title $cat)
 Set which category to use. More...
 
- Public Member Functions inherited from FormSpecialPage
 execute ( $par)
 Basic SpecialPage workflow: get a form, send it to the user; get some data back,. More...
 
 onSubmit (array $data)
 Process the form on POST submission. More...
 
 onSuccess ()
 Do something exciting on successful processing of the form, most likely to show a confirmation message. More...
 
 requiresUnblock ()
 Whether this action cannot be executed by a blocked user. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 
- 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. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $subPage)
 Default execute method Checks user permissions. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 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. More...
 
 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. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. More...
 
 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. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 alterForm (HTMLForm $form)
 
 getDisplayFormat ()
 
 getFormFields ()
 
 getGroupName ()
 
 getMinAndMaxForCat (Title $category)
 Get the lowest and highest timestamp for a category. More...
 
 getQueryInfo ( $rand, $offset, $up)
 
 getTimestampOffset ( $rand)
 
 setParameter ( $par)
 
- Protected Member Functions inherited from FormSpecialPage
 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 
 checkExecutePermissions (User $user)
 Called from execute() to check if the given user can perform this action. More...
 
 getDisplayFormat ()
 Get display format for the form. More...
 
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 
 getMessagePrefix ()
 Get message prefix for HTMLForm. More...
 
 postText ()
 Add post-text to the form. More...
 
 preText ()
 Add pre-text to the form. More...
 
 setParameter ( $par)
 Maybe do something interesting with the subpage parameter. More...
 
 setReauthPostData (array $data)
 Preserve POST data across reauthentication. More...
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 getCacheTTL ()
 
 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'. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

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. More...
 
array null $reauthPostData = null
 POST data preserved across re-authentication. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $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. More...
 
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. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
- 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). More...
 

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

Definition at line 101 of file SpecialRandomInCategory.php.

References HTMLForm\setSubmitTextMsg().

◆ getDisplayFormat()

SpecialRandomInCategory::getDisplayFormat ( )
protected

Definition at line 97 of file SpecialRandomInCategory.php.

◆ getFormFields()

SpecialRandomInCategory::getFormFields ( )
protected

Definition at line 75 of file SpecialRandomInCategory.php.

References SpecialPage\addHelpLink(), and NS_CATEGORY.

◆ getGroupName()

SpecialRandomInCategory::getGroupName ( )
protected

Definition at line 312 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
MWExceptionIf category has no entries.

Definition at line 266 of file SpecialRandomInCategory.php.

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

Referenced by getTimestampOffset().

◆ getQueryInfo()

SpecialRandomInCategory::getQueryInfo (   $rand,
  $offset,
  $up 
)
protected
Parameters
float$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
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 204 of file SpecialRandomInCategory.php.

References $dbr, $extra, 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 154 of file SpecialRandomInCategory.php.

References $title, Title\makeTitle(), selectRandomPageFromDB(), and wfRandom().

Referenced by onSubmit().

◆ getTimestampOffset()

SpecialRandomInCategory::getTimestampOffset (   $rand)
protected
Parameters
float$randRandom 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 241 of file SpecialRandomInCategory.php.

References $minTimestamp, and getMinAndMaxForCat().

Referenced by getQueryInfo().

◆ onSubmit()

◆ requiresUnblock()

SpecialRandomInCategory::requiresUnblock ( )

Definition at line 93 of file SpecialRandomInCategory.php.

◆ requiresWrite()

SpecialRandomInCategory::requiresWrite ( )

Definition at line 89 of file SpecialRandomInCategory.php.

◆ selectRandomPageFromDB()

SpecialRandomInCategory::selectRandomPageFromDB (   $rand,
  $offset,
  $up,
  $fname = __METHOD__ 
)
private
Parameters
float$randA random number that is converted to a random timestamp
int$offsetA small offset to make the result seem more "random"
bool$upGet the result above the random value
string$fnameThe name of the calling method
Returns
stdClass|false Info for the title selected.

Definition at line 296 of file SpecialRandomInCategory.php.

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

Referenced by getRandomTitle().

◆ setCategory()

SpecialRandomInCategory::setCategory ( Title  $cat)

Set which category to use.

Parameters
Title$cat

Definition at line 69 of file SpecialRandomInCategory.php.

Referenced by onSubmit().

◆ setParameter()

SpecialRandomInCategory::setParameter (   $par)
protected

Definition at line 105 of file SpecialRandomInCategory.php.

References FormSpecialPage\$par, and onSubmit().

Member Data Documentation

◆ $category

Title false SpecialRandomInCategory::$category = false
protected

Definition at line 53 of file SpecialRandomInCategory.php.

◆ $extra

string [] SpecialRandomInCategory::$extra = []
protected

Definition at line 51 of file SpecialRandomInCategory.php.

Referenced by getQueryInfo().

◆ $maxOffset

int SpecialRandomInCategory::$maxOffset = 30
protected

Definition at line 55 of file SpecialRandomInCategory.php.

◆ $maxTimestamp

int null SpecialRandomInCategory::$maxTimestamp = null
private

Definition at line 57 of file SpecialRandomInCategory.php.

◆ $minTimestamp

int null SpecialRandomInCategory::$minTimestamp = null
private

Definition at line 59 of file SpecialRandomInCategory.php.

Referenced by getTimestampOffset().


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