MediaWiki  master
SpecialImport Class Reference

MediaWiki page data importer. More...

Inheritance diagram for SpecialImport:
Collaboration diagram for SpecialImport:

Public Member Functions

 __construct ()
 
 doesWrites ()
 
 execute ( $par)
 Execute. 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...
 
 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...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key)
 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

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

Private Member Functions

 doImport ()
 Do the actual import. More...
 
 getMappingFormPart ( $sourceName)
 
 showForm ()
 

Private Attributes

 $assignKnownUsers
 
 $frompage = ''
 
 $fullInterwikiPrefix
 
 $history = true
 
 $importSources
 
 $includeTemplates = false
 
 $interwiki = false
 
 $logcomment = false
 
 $mapping = 'default'
 
 $namespace
 
 $pageLinkDepth
 
 $rootpage = ''
 
 $sourceName = false
 
 $subproject
 
 $usernamePrefix
 

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...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

MediaWiki page data importer.

Definition at line 34 of file SpecialImport.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialImport::__construct ( )

Definition at line 51 of file SpecialImport.php.

Member Function Documentation

◆ doesWrites()

SpecialImport::doesWrites ( )

Definition at line 55 of file SpecialImport.php.

◆ doImport()

◆ execute()

◆ getGroupName()

SpecialImport::getGroupName ( )
protected

Definition at line 565 of file SpecialImport.php.

◆ getMappingFormPart()

SpecialImport::getMappingFormPart (   $sourceName)
private

◆ showForm()

Member Data Documentation

◆ $assignKnownUsers

SpecialImport::$assignKnownUsers
private

Definition at line 48 of file SpecialImport.php.

◆ $frompage

SpecialImport::$frompage = ''
private

Definition at line 42 of file SpecialImport.php.

◆ $fullInterwikiPrefix

SpecialImport::$fullInterwikiPrefix
private

Definition at line 38 of file SpecialImport.php.

◆ $history

SpecialImport::$history = true
private

Definition at line 44 of file SpecialImport.php.

◆ $importSources

SpecialImport::$importSources
private

Definition at line 47 of file SpecialImport.php.

◆ $includeTemplates

SpecialImport::$includeTemplates = false
private

Definition at line 45 of file SpecialImport.php.

◆ $interwiki

SpecialImport::$interwiki = false
private

Definition at line 36 of file SpecialImport.php.

◆ $logcomment

SpecialImport::$logcomment = false
private

Definition at line 43 of file SpecialImport.php.

◆ $mapping

SpecialImport::$mapping = 'default'
private

Definition at line 39 of file SpecialImport.php.

◆ $namespace

SpecialImport::$namespace
private

Definition at line 40 of file SpecialImport.php.

◆ $pageLinkDepth

SpecialImport::$pageLinkDepth
private

Definition at line 46 of file SpecialImport.php.

◆ $rootpage

SpecialImport::$rootpage = ''
private

Definition at line 41 of file SpecialImport.php.

◆ $sourceName

SpecialImport::$sourceName = false
private

Definition at line 35 of file SpecialImport.php.

Referenced by getMappingFormPart().

◆ $subproject

SpecialImport::$subproject
private

Definition at line 37 of file SpecialImport.php.

Referenced by showForm().

◆ $usernamePrefix

SpecialImport::$usernamePrefix
private

Definition at line 49 of file SpecialImport.php.


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