Special page outputs information on sourcing a book with a particular ISBN The parser creates links to this page when dealing with ISBNs in wikitext. More...

Inheritance diagram for SpecialBookSources:

[legend]

Collaboration diagram for SpecialBookSources:

[legend]

Public Member Functions
	__construct ()

	execute ( $isbn)
	Show the special page.

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.

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

	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.

	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.

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

	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.

	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)
	Wrapper around wfMessage that sets the current context.

	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.

	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.

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

	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).

Static Public Member Functions
static	isValidISBN ( $isbn)
	Return whether a given ISBN (10 or 13) is valid.

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.

Protected Member Functions
	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'.

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

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

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

	getCacheTTL ()

	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.

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

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

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

Private Member Functions
	buildForm ( $isbn)
	Generate a form to allow users to enter an ISBN.

	makeListItem ( $isbn, $label, $url)
	Format a book source list item.

	showList ( $isbn)
	Determine where to get the list of book sources from, format and output them.

Static Private Member Functions
static	cleanIsbn ( $isbn)
	Trim ISBN and remove characters which aren't required.

Additional Inherited Members
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).

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Detailed Description

Special page outputs information on sourcing a book with a particular ISBN The parser creates links to this page when dealing with ISBNs in wikitext.

Author: Rob Church robch.nosp@m.ur@g.nosp@m.mail..nosp@m.com

Definition at line 31 of file SpecialBooksources.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialBookSources::__construct ( )

Definition at line 32 of file SpecialBooksources.php.

Member Function Documentation

◆ buildForm()

SpecialBookSources::buildForm ( $isbn )

private

Generate a form to allow users to enter an ISBN.

Parameters

string $isbn

Definition at line 124 of file SpecialBooksources.php.

References $context, SpecialPage\getContext(), and SpecialPage\getPageTitle().

Referenced by execute().

◆ cleanIsbn()

static SpecialBookSources::cleanIsbn ( $isbn )

staticprivate

Trim ISBN and remove characters which aren't required.

Parameters

string $isbn Unclean ISBN

Returns: string

Definition at line 115 of file SpecialBooksources.php.

Referenced by isValidISBN(), and showList().

◆ execute()

SpecialBookSources::execute ( $isbn )

Show the special page.

Parameters

string $isbn ISBN passed as a subpage parameter

Reimplemented from SpecialPage.

Definition at line 41 of file SpecialBooksources.php.

References $out, buildForm(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), and showList().

◆ getGroupName()

SpecialBookSources::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'.

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 211 of file SpecialBooksources.php.

◆ isValidISBN()

static SpecialBookSources::isValidISBN ( $isbn )

static

Return whether a given ISBN (10 or 13) is valid.

Parameters

string $isbn ISBN passed for check

Returns: bool

Definition at line 71 of file SpecialBooksources.php.

References cleanIsbn().

Referenced by SpecialBooksourcesTest\testIsValidISBN().

◆ makeListItem()

SpecialBookSources::makeListItem	(	$isbn,
		$label,
		$url )

private

Format a book source list item.

Parameters

string	$isbn
string	$label	Book source label
string	$url	Book source URL

Returns: string

Definition at line 203 of file SpecialBooksources.php.

Referenced by showList().

◆ showList()

SpecialBookSources::showList ( $isbn )

private

Determine where to get the list of book sources from, format and output them.

Parameters

string $isbn

Exceptions

MWException

Returns: bool

Definition at line 154 of file SpecialBooksources.php.

References $out, $rev, $wgContLang, cleanIsbn(), SpecialPage\getOutput(), language(), list, makeListItem(), SpecialPage\msg(), and NS_PROJECT.

Referenced by execute().

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

includes/specials/SpecialBooksources.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildForm()

◆ cleanIsbn()

◆ execute()

◆ getGroupName()

◆ isValidISBN()

◆ makeListItem()

◆ showList()