MediaWiki  master
SpecialExport Class Reference

A special page that allows users to export pages in a XML file. More...

Inheritance diagram for SpecialExport:
Collaboration diagram for SpecialExport:

Public Member Functions

 __construct (ILoadBalancer $loadBalancer, WikiExporterFactory $wikiExporterFactory)
 
 execute ( $par)
 Default execute method Checks user permissions. 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...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 getAuthority ()
 Shortcut to get the Authority executing this instance. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContentLanguage ()
 Shortcut to get content language. 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...
 
 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...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Public Attributes

 $doExport
 
 $pageLinkDepth
 
 $templates
 

Protected Member Functions

 doExport ( $page, $history, $list_authors, $exportall)
 Do the actual page exporting. More...
 
 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...
 
 getLinks ( $inputPages, $pageSet, $table, $fields, $join)
 Expand a list of pages to include items used in those pages. More...
 
 getPageLinks ( $inputPages, $pageSet, $depth)
 Expand a list of pages to include pages linked to from that page. More...
 
 getPagesFromCategory ( $title)
 
 getPagesFromNamespace ( $nsindex)
 
 getTemplates ( $inputPages, $pageSet)
 Expand a list of pages to include templates used in those pages. More...
 
 userCanOverrideExportDepth ()
 
 validateLinkDepth ( $depth)
 Validate link depth setting, if available. 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...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. 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...
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. 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...
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

 $curonly
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

Private Attributes

ILoadBalancer $loadBalancer
 
WikiExporterFactory $wikiExporterFactory
 

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

A special page that allows users to export pages in a XML file.

Definition at line 35 of file SpecialExport.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialExport::__construct ( ILoadBalancer  $loadBalancer,
WikiExporterFactory  $wikiExporterFactory 
)
Parameters
ILoadBalancer$loadBalancer
WikiExporterFactory$wikiExporterFactory

Definition at line 48 of file SpecialExport.php.

References $loadBalancer, and $wikiExporterFactory.

Member Function Documentation

◆ doExport()

SpecialExport::doExport (   $page,
  $history,
  $list_authors,
  $exportall 
)
protected

Do the actual page exporting.

Parameters
string$pageUser input on what page(s) to export
int$historyOne of the WikiExporter history export constants
bool$list_authorsWhether to add distinct author list (when not returning full history)
bool$exportallWhether to export everything

Definition at line 358 of file SpecialExport.php.

References $pageLinkDepth, $title, DB_REPLICA, WikiExporter\FULL, SpecialPage\getAuthority(), getPageLinks(), getTemplates(), and Title\newFromText().

Referenced by execute().

◆ execute()

SpecialExport::execute (   $subPage)

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stability: stable
to override
Parameters
string | null$subPage

Reimplemented from SpecialPage.

Definition at line 57 of file SpecialExport.php.

References $t, SpecialPage\addHelpLink(), WikiExporter\CURRENT, doExport(), HTMLForm\factory(), WikiExporter\FULL, SpecialPage\getConfig(), SpecialPage\getContext(), SpecialPage\getOutput(), getPagesFromCategory(), getPagesFromNamespace(), SpecialPage\getRequest(), Title\makeTitleSafe(), SpecialPage\msg(), NS_MAIN, SpecialPage\outputHeader(), SpecialPage\setHeaders(), validateLinkDepth(), wfResetOutputBuffers(), wfTimestamp(), and wfTimestampNow().

◆ getGroupName()

SpecialExport::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 SpecialPage.

Definition at line 581 of file SpecialExport.php.

◆ getLinks()

SpecialExport::getLinks (   $inputPages,
  $pageSet,
  $table,
  $fields,
  $join 
)
protected

Expand a list of pages to include items used in those pages.

Parameters
array$inputPagesArray of page titles
array$pageSet
string$table
array$fieldsArray of field names
array$join
Returns
array

Definition at line 548 of file SpecialExport.php.

References $dbr, $title, DB_REPLICA, Title\makeTitle(), and Title\newFromText().

Referenced by getPageLinks(), and getTemplates().

◆ getPageLinks()

SpecialExport::getPageLinks (   $inputPages,
  $pageSet,
  $depth 
)
protected

Expand a list of pages to include pages linked to from that page.

Parameters
array$inputPages
array$pageSet
int$depth
Returns
array

Definition at line 526 of file SpecialExport.php.

References getLinks().

Referenced by doExport().

◆ getPagesFromCategory()

SpecialExport::getPagesFromCategory (   $title)
protected
Parameters
Title$title
Returns
string[]

Definition at line 431 of file SpecialExport.php.

References $dbr, $res, $title, DB_REPLICA, SpecialPage\getConfig(), and Title\makeName().

Referenced by execute().

◆ getPagesFromNamespace()

SpecialExport::getPagesFromNamespace (   $nsindex)
protected
Parameters
int$nsindex
Returns
string[]

Definition at line 458 of file SpecialExport.php.

References $dbr, $res, DB_REPLICA, SpecialPage\getConfig(), and Title\makeName().

Referenced by execute().

◆ getTemplates()

SpecialExport::getTemplates (   $inputPages,
  $pageSet 
)
protected

Expand a list of pages to include templates used in those pages.

Parameters
array$inputPagesList of titles to look up
array$pageSetAssociative array indexed by titles for output
Returns
array Associative array index by titles

Definition at line 485 of file SpecialExport.php.

References getLinks().

Referenced by doExport().

◆ userCanOverrideExportDepth()

SpecialExport::userCanOverrideExportDepth ( )
protected
Returns
bool

Definition at line 345 of file SpecialExport.php.

References SpecialPage\getAuthority().

Referenced by validateLinkDepth().

◆ validateLinkDepth()

SpecialExport::validateLinkDepth (   $depth)
protected

Validate link depth setting, if available.

Parameters
int$depth
Returns
int

Definition at line 498 of file SpecialExport.php.

References SpecialPage\getConfig(), and userCanOverrideExportDepth().

Referenced by execute().

Member Data Documentation

◆ $curonly

SpecialExport::$curonly
protected

Definition at line 36 of file SpecialExport.php.

◆ $doExport

SpecialExport::$doExport

Definition at line 36 of file SpecialExport.php.

◆ $loadBalancer

ILoadBalancer SpecialExport::$loadBalancer
private

Definition at line 39 of file SpecialExport.php.

Referenced by __construct().

◆ $pageLinkDepth

SpecialExport::$pageLinkDepth

Definition at line 36 of file SpecialExport.php.

Referenced by doExport().

◆ $templates

SpecialExport::$templates

Definition at line 36 of file SpecialExport.php.

◆ $wikiExporterFactory

WikiExporterFactory SpecialExport::$wikiExporterFactory
private

Definition at line 42 of file SpecialExport.php.

Referenced by __construct().


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