MediaWiki  1.23.13
SpecialBookSources Class Reference

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:
Collaboration diagram for SpecialBookSources:

Public Member Functions

 __construct ()
 Constructor. More...
 
 execute ( $isbn)
 Show the special page. More...
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='default', $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...
 
 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...
 
 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...
 
 getFile ()
 Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. 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...
 
 getLang ()
 Shortcut to get user's language. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 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...
 
 getTitle ( $subpage=false)
 Get a self-referential title object. 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...
 
 msg ()
 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...
 
 requireLogin ( $reasonMsg=null, $titleMsg=null)
 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...
 
 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...
 

Static Public Member Functions

static isValidISBN ( $isbn)
 Returns whether a given ISBN (10 or 13) is valid. More...
 
- 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. More...
 

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'. 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...
 
 getRobotPolicy ()
 Return the robot policy. More...
 

Private Member Functions

 makeForm ()
 Generate a form to allow users to enter an ISBN. More...
 
 makeListItem ( $label, $url)
 Format a book source list item. More...
 
 showList ()
 Determine where to get the list of book sources from, format and output them. More...
 

Static Private Member Functions

static cleanIsbn ( $isbn)
 Trim ISBN and remove characters which aren't required. More...
 

Private Attributes

 $isbn = ''
 ISBN passed to the page, if any. More...
 

Additional Inherited Members

- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 

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
Todo:
Validate ISBNs using the standard check-digit method

Definition at line 32 of file SpecialBooksources.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialBookSources::__construct ( )

Constructor.

Definition at line 42 of file SpecialBooksources.php.

Member Function Documentation

◆ cleanIsbn()

static SpecialBookSources::cleanIsbn (   $isbn)
staticprivate

Trim ISBN and remove characters which aren't required.

Parameters
string$isbnUnclean ISBN
Returns
string

Definition at line 108 of file SpecialBooksources.php.

References $isbn.

Referenced by execute(), and isValidISBN().

◆ execute()

SpecialBookSources::execute (   $isbn)

Show the special page.

Parameters
string$isbnISBN passed as a subpage parameter

Reimplemented from SpecialPage.

Definition at line 51 of file SpecialBooksources.php.

References $isbn, cleanIsbn(), SpecialPage\getOutput(), SpecialPage\getRequest(), makeForm(), 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 191 of file SpecialBooksources.php.

◆ isValidISBN()

static SpecialBookSources::isValidISBN (   $isbn)
static

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

True indicates validity.

Parameters
string$isbnISBN passed for check
Returns
bool

Definition at line 69 of file SpecialBooksources.php.

References $isbn, and cleanIsbn().

◆ makeForm()

SpecialBookSources::makeForm ( )
private

Generate a form to allow users to enter an ISBN.

Returns
string

Definition at line 117 of file SpecialBooksources.php.

References $form, array(), Html\closeElement(), Html\element(), SpecialPage\getPageTitle(), global, Html\hidden(), Xml\inputLabel(), SpecialPage\msg(), Html\openElement(), Xml\submitButton(), and text.

Referenced by execute().

◆ makeListItem()

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

Format a book source list item.

Parameters
string$labelBook source label
string$urlBook source URL
Returns
string

Definition at line 184 of file SpecialBooksources.php.

References array(), Html\element(), and Html\rawElement().

Referenced by showList().

◆ showList()

SpecialBookSources::showList ( )
private

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

Exceptions
MWException
Returns
string

Definition at line 139 of file SpecialBooksources.php.

References $rev, $title, $wgContLang, array(), as, content, SpecialPage\getOutput(), global, in, list, makeListItem(), Title\makeTitleSafe(), SpecialPage\msg(), Revision\newFromTitle(), NS_PROJECT, IDBAccessObject\READ_NORMAL, and wfRunHooks().

Referenced by execute().

Member Data Documentation

◆ $isbn

SpecialBookSources::$isbn = ''
private

ISBN passed to the page, if any.

Definition at line 37 of file SpecialBooksources.php.

Referenced by cleanIsbn(), execute(), and isValidISBN().


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