XML file reader for the page data importer. More...

Collaboration diagram for WikiImporter:

[legend]

Public Member Functions
	__construct (ImportSource $source, Config $config)
	Creates an ImportXMLReader drawing from the source provided.

	beforeImportPage ( $titleAndForeignTitle)
	Default per-page callback.

	debug ( $data)

	debugRevisionHandler (&$revision)
	Alternate per-revision callback, for debugging.

	disableStatisticsUpdate ()
	Statistics update can cause a lot of time.

	doImport ()
	Primary entry point.

	finishImportPage ( $title, $foreignTitle, $revCount, $sRevCount, $pageInfo)
	Mostly for hook use.

	getReader ()

	importLogItem ( $revision)
	Default per-revision callback, performs the import.

	importRevision ( $revision)
	Default per-revision callback, performs the import.

	importUpload ( $revision)
	Dummy for now...

	nodeAttribute ( $attr)
	Retrieves the contents of the named attribute of the current element.

	nodeContents ()
	Shouldn't something like this be built-in to XMLReader? Fetches text contents of the current element, assuming no sub-elements or such scary things.

	notice ( $msg,... $params)

	pageCallback ( $title)
	Notify the callback function when a new "<page>" is reached.

	setDebug ( $debug)
	Set debug mode...

	setImageBasePath ( $dir)

	setImportTitleFactory ( $factory)
	Sets the factory object to use to convert ForeignTitle objects into local Title objects.

	setImportUploads ( $import)

	setLogItemCallback ( $callback)
	Sets the action to perform as each log item reached.

	setNoticeCallback ( $callback)
	Set a callback that displays notice messages.

	setNoUpdates ( $noupdates)
	Set 'no updates' mode.

	setPageCallback ( $callback)
	Sets the action to perform as each new page in the stream is reached.

	setPageOffset ( $nthPage)
	Sets 'pageOffset' value.

	setPageOutCallback ( $callback)
	Sets the action to perform as each page in the stream is completed.

	setRevisionCallback ( $callback)
	Sets the action to perform as each page revision is reached.

	setSiteInfoCallback ( $callback)
	Sets the action to perform when site info is encountered.

	setTargetNamespace ( $namespace)
	Set a target namespace to override the defaults.

	setTargetRootPage ( $rootpage)
	Set a target root page under which all pages are imported.

	setUploadCallback ( $callback)
	Sets the action to perform as each file upload version is reached.

	setUsernamePrefix ( $usernamePrefix, $assignKnownUsers)

	throwXmlError ( $err)

	warn ( $data)

Private Member Functions
	dumpTemp ( $contents)

	getContentHandler ( $model)

	getDefaultContentModel ( $title, $role)

	handleContent ()

	handleContributor ()

	handleLogItem ()

	handlePage ()

	handleRevision (&$pageInfo)

	handleSiteInfo ()

	handleUpload (&$pageInfo)

	logItemCallback ( $revision)
	Notify the callback function of a new log item.

	makeContent (Title $title, $revisionId, $contentInfo)

	pageOutCallback ( $title, $foreignTitle, $revCount, $sucCount, $pageInfo)
	Notify the callback function when a "</page>" is closed.

	processLogItem ( $logInfo)

	processRevision ( $pageInfo, $revisionInfo)

	processTitle ( $text, $ns=null)

	processUpload ( $pageInfo, $uploadInfo)

	revisionCallback ( $revision)
	Notify the callback function of a revision.

	siteInfoCallback ( $siteInfo)
	Notify the callback function of site info.

Private Attributes
Config	$config

array	$countableCache = []

bool	$disableStatisticsUpdate = false

ExternalUserNames	$externalUserNames

	$foreignNamespaces = null

HookRunner	$hookRunner

ImportTitleFactory	$importTitleFactory

	$mDebug

	$mImageBasePath

	$mImportUploads

	$mLogItemCallback

	$mNoticeCallback

	$mNoUpdates = false

	$mPageCallback

	$mPageOutCallback

	$mRevisionCallback

	$mSiteInfoCallback

	$mUploadCallback

	$pageOffset = 0

XMLReader null	$reader

Detailed Description

XML file reader for the page data importer.

implements Special:Import

Definition at line 37 of file WikiImporter.php.

Constructor & Destructor Documentation

◆ __construct()

WikiImporter::__construct	(	ImportSource	$source,
		Config	$config
	)

Creates an ImportXMLReader drawing from the source provided.

Parameters

ImportSource	$source
Config	$config

Exceptions

Exception PhanStaticCallToNonStatic, UnusedSuppression – for PHP 7.4 support

Definition at line 67 of file WikiImporter.php.

References $reader, $source, UploadSourceAdapter\registerSource(), setLogItemCallback(), setPageCallback(), setPageOutCallback(), setRevisionCallback(), and setUploadCallback().

Member Function Documentation

◆ beforeImportPage()

WikiImporter::beforeImportPage ( $titleAndForeignTitle )

Default per-page callback.

Sets up some things related to site statistics

Parameters

array $titleAndForeignTitle Two-element array, with Title object at index 0 and ForeignTitle object at index 1

Returns: bool

Definition at line 361 of file WikiImporter.php.

References $title.

◆ debug()

WikiImporter::debug ( $data )

Definition at line 133 of file WikiImporter.php.

References wfDebug().

Referenced by debugRevisionHandler(), doImport(), handleContent(), handleContributor(), handleLogItem(), handlePage(), handleRevision(), handleSiteInfo(), handleUpload(), and throwXmlError().

◆ debugRevisionHandler()

WikiImporter::debugRevisionHandler ( & $revision )

Alternate per-revision callback, for debugging.

Parameters

WikiRevision &$revision

Definition at line 461 of file WikiImporter.php.

References debug().

◆ disableStatisticsUpdate()

WikiImporter::disableStatisticsUpdate ( )

Statistics update can cause a lot of time.

Since: 1.29

Definition at line 351 of file WikiImporter.php.

References disableStatisticsUpdate().

Referenced by disableStatisticsUpdate(), and finishImportPage().

◆ doImport()

WikiImporter::doImport ( )

Primary entry point.

Exceptions

Exception
MWException

Returns: bool

Definition at line 585 of file WikiImporter.php.

References $type, debug(), handleLogItem(), handlePage(), handleSiteInfo(), and warn().

◆ dumpTemp()

WikiImporter::dumpTemp ( $contents )

private

Parameters

string $contents

Returns: string

Definition at line 1070 of file WikiImporter.php.

References wfTempDir().

Referenced by handleUpload().

◆ finishImportPage()

WikiImporter::finishImportPage	(	$title,
		$foreignTitle,
		$revCount,
		$sRevCount,
		$pageInfo
	)

Mostly for hook use.

Parameters

Title	$title
ForeignTitle	$foreignTitle
int	$revCount
int	$sRevCount
array	$pageInfo

Returns: bool

Definition at line 424 of file WikiImporter.php.

References $content, $title, disableStatisticsUpdate(), and wfDebug().

◆ getContentHandler()

WikiImporter::getContentHandler ( $model )

private

Parameters

string $model

Returns: ContentHandler

Definition at line 1204 of file WikiImporter.php.

Referenced by makeContent().

◆ getDefaultContentModel()

WikiImporter::getDefaultContentModel	(	$title,
		$role
	)

private

Parameters

Title	$title
string	$role

Returns: string

Definition at line 1216 of file WikiImporter.php.

References $title.

Referenced by makeContent().

◆ getReader()

WikiImporter::getReader ( )

Returns: null|XMLReader

Definition at line 124 of file WikiImporter.php.

◆ handleContent()

WikiImporter::handleContent ( )

private

Definition at line 880 of file WikiImporter.php.

References debug(), nodeContents(), and warn().

Referenced by handleRevision().

◆ handleContributor()

WikiImporter::handleContributor ( )

private

Returns: array

Definition at line 1124 of file WikiImporter.php.

References debug(), and nodeContents().

Referenced by handleLogItem(), handleRevision(), and handleUpload().

◆ handleLogItem()

WikiImporter::handleLogItem ( )

private

Definition at line 682 of file WikiImporter.php.

References debug(), handleContributor(), nodeContents(), processLogItem(), and warn().

Referenced by doImport().

◆ handlePage()

WikiImporter::handlePage ( )

private

Definition at line 757 of file WikiImporter.php.

References $title, debug(), handleRevision(), handleUpload(), nodeAttribute(), nodeContents(), pageCallback(), pageOutCallback(), processTitle(), and warn().

Referenced by doImport().

◆ handleRevision()

WikiImporter::handleRevision ( & $pageInfo )

private

Parameters

array &$pageInfo

Definition at line 840 of file WikiImporter.php.

References debug(), handleContent(), handleContributor(), nodeContents(), processRevision(), and warn().

Referenced by handlePage().

◆ handleSiteInfo()

WikiImporter::handleSiteInfo ( )

private

Definition at line 655 of file WikiImporter.php.

References debug(), nodeAttribute(), nodeContents(), and siteInfoCallback().

Referenced by doImport().

◆ handleUpload()

WikiImporter::handleUpload ( & $pageInfo )

private

Parameters

array &$pageInfo

Returns: mixed

Definition at line 1017 of file WikiImporter.php.

References $path, debug(), dumpTemp(), handleContributor(), nodeContents(), processUpload(), and warn().

Referenced by handlePage().

◆ importLogItem()

WikiImporter::importLogItem ( $revision )

Default per-revision callback, performs the import.

Parameters

WikiRevision $revision

Returns: bool

Definition at line 402 of file WikiImporter.php.

◆ importRevision()

WikiImporter::importRevision ( $revision )

Default per-revision callback, performs the import.

Parameters

WikiRevision $revision

Returns: bool

Definition at line 373 of file WikiImporter.php.

References notice().

◆ importUpload()

WikiImporter::importUpload ( $revision )

Dummy for now...

Parameters

WikiRevision $revision

Returns: bool

Definition at line 411 of file WikiImporter.php.

◆ logItemCallback()

WikiImporter::logItemCallback ( $revision )

private

Notify the callback function of a new log item.

Parameters

WikiRevision $revision

Returns: bool|mixed

Definition at line 532 of file WikiImporter.php.

Referenced by processLogItem().

◆ makeContent()

WikiImporter::makeContent	(	Title	$title,
			$revisionId,
			$contentInfo
	)

private

Parameters

Title	$title
int	$revisionId
array	$contentInfo

Returns: Content

Exceptions

MWException

Definition at line 919 of file WikiImporter.php.

References $content, $title, $wgMaxArticleSize, getContentHandler(), and getDefaultContentModel().

Referenced by processRevision(), and processUpload().

◆ nodeAttribute()

WikiImporter::nodeAttribute ( $attr )

Retrieves the contents of the named attribute of the current element.

Parameters

string $attr The name of the attribute

Returns: string The value of the attribute or an empty string if it is not set in the current element.

Definition at line 547 of file WikiImporter.php.

Referenced by handlePage(), and handleSiteInfo().

◆ nodeContents()

WikiImporter::nodeContents ( )

Shouldn't something like this be built-in to XMLReader? Fetches text contents of the current element, assuming no sub-elements or such scary things.

Returns: string

Definition at line 558 of file WikiImporter.php.

Referenced by handleContent(), handleContributor(), handleLogItem(), handlePage(), handleRevision(), handleSiteInfo(), and handleUpload().

◆ notice()

WikiImporter::notice	(	$msg,
		$params
	)

Definition at line 143 of file WikiImporter.php.

References wfDebug(), and wfMessage().

Referenced by importRevision(), and processTitle().

◆ pageCallback()

WikiImporter::pageCallback ( $title )

Notify the callback function when a new "<page>" is reached.

Parameters

array $title

Definition at line 492 of file WikiImporter.php.

References $title.

Referenced by handlePage().

◆ pageOutCallback()

WikiImporter::pageOutCallback	(	$title,
		$foreignTitle,
		$revCount,
		$sucCount,
		$pageInfo
	)

private

Notify the callback function when a "</page>" is closed.

Parameters

Title	$title
ForeignTitle	$foreignTitle
int	$revCount
int	$sucCount	Number of revisions for which callback returned true
array	$pageInfo	Associative array of page information

Definition at line 506 of file WikiImporter.php.

Referenced by handlePage().

◆ processLogItem()

WikiImporter::processLogItem ( $logInfo )

private

Parameters

array $logInfo

Returns: bool|mixed

Definition at line 716 of file WikiImporter.php.

References logItemCallback().

Referenced by handleLogItem().

◆ processRevision()

WikiImporter::processRevision	(	$pageInfo,
		$revisionInfo
	)

private

Parameters

array	$pageInfo
array	$revisionInfo

Exceptions

MWException

Returns: bool|mixed

Definition at line 965 of file WikiImporter.php.

References $content, $title, makeContent(), revisionCallback(), and wfTimestampNow().

Referenced by handleRevision().

◆ processTitle()

WikiImporter::processTitle	(	$text,
		$ns = `null`
	)

private

Parameters

string	$text
string \| null	$ns

Returns: array|bool

Definition at line 1153 of file WikiImporter.php.

References $title, and notice().

Referenced by handlePage().

◆ processUpload()

WikiImporter::processUpload	(	$pageInfo,
		$uploadInfo
	)

private

Parameters

array	$pageInfo
array	$uploadInfo

Returns: mixed

Definition at line 1081 of file WikiImporter.php.

References $content, $title, and makeContent().

Referenced by handleUpload().

◆ revisionCallback()

WikiImporter::revisionCallback ( $revision )

private

Notify the callback function of a revision.

Parameters

WikiRevision $revision

Returns: bool|mixed

Definition at line 518 of file WikiImporter.php.

Referenced by processRevision().

◆ setDebug()

WikiImporter::setDebug ( $debug )

Set debug mode...

Parameters

bool $debug

Definition at line 157 of file WikiImporter.php.

References $debug.

◆ setImageBasePath()

WikiImporter::setImageBasePath ( $dir )

Parameters

string $dir

Definition at line 327 of file WikiImporter.php.

◆ setImportTitleFactory()

WikiImporter::setImportTitleFactory ( $factory )

Sets the factory object to use to convert ForeignTitle objects into local Title objects.

Parameters

ImportTitleFactory $factory

Definition at line 264 of file WikiImporter.php.

Referenced by setTargetNamespace(), and setTargetRootPage().

◆ setImportUploads()

WikiImporter::setImportUploads ( $import )

Parameters

bool $import

Definition at line 334 of file WikiImporter.php.

◆ setLogItemCallback()

WikiImporter::setLogItemCallback ( $callback )

Sets the action to perform as each log item reached.

Parameters

callable $callback

Returns: callable

Definition at line 242 of file WikiImporter.php.

Referenced by __construct().

◆ setNoticeCallback()

WikiImporter::setNoticeCallback ( $callback )

Set a callback that displays notice messages.

Parameters

callable $callback

Returns: callable

Definition at line 185 of file WikiImporter.php.

References wfSetVar().

◆ setNoUpdates()

WikiImporter::setNoUpdates ( $noupdates )

Set 'no updates' mode.

In this mode, the link tables will not be updated by the importer

Parameters

bool $noupdates

Definition at line 165 of file WikiImporter.php.

◆ setPageCallback()

WikiImporter::setPageCallback ( $callback )

Sets the action to perform as each new page in the stream is reached.

Parameters

callable $callback

Returns: callable

Definition at line 194 of file WikiImporter.php.

Referenced by __construct().

◆ setPageOffset()

WikiImporter::setPageOffset ( $nthPage )

Sets 'pageOffset' value.

So it will skip the first n-1 pages and start from the nth page. It's 1-based indexing.

Parameters

int $nthPage

Since: 1.29

Definition at line 175 of file WikiImporter.php.

◆ setPageOutCallback()

WikiImporter::setPageOutCallback ( $callback )

Sets the action to perform as each page in the stream is completed.

Callback accepts the page title (as a Title object), a second object with the original title form (in case it's been overridden into a local namespace), and a count of revisions.

Parameters

callable $callback

Returns: callable

Definition at line 209 of file WikiImporter.php.

Referenced by __construct().

◆ setRevisionCallback()

WikiImporter::setRevisionCallback ( $callback )

Sets the action to perform as each page revision is reached.

Parameters

callable $callback

Returns: callable

Definition at line 220 of file WikiImporter.php.

Referenced by __construct().

◆ setSiteInfoCallback()

WikiImporter::setSiteInfoCallback ( $callback )

Sets the action to perform when site info is encountered.

Parameters

callable $callback

Returns: callable

Definition at line 253 of file WikiImporter.php.

◆ setTargetNamespace()

WikiImporter::setTargetNamespace ( $namespace )

Set a target namespace to override the defaults.

Parameters

null | int $namespace

Returns: bool

Definition at line 273 of file WikiImporter.php.

References setImportTitleFactory().

Referenced by setTargetRootPage().

◆ setTargetRootPage()

WikiImporter::setTargetRootPage ( $rootpage )

Set a target root page under which all pages are imported.

Parameters

null | string $rootpage

Returns: Status

Definition at line 295 of file WikiImporter.php.

References $title, NS_MAIN, setImportTitleFactory(), setTargetNamespace(), and wfMessage().

◆ setUploadCallback()

WikiImporter::setUploadCallback ( $callback )

Sets the action to perform as each file upload version is reached.

Parameters

callable $callback

Returns: callable

Definition at line 231 of file WikiImporter.php.

Referenced by __construct().

◆ setUsernamePrefix()

WikiImporter::setUsernamePrefix	(	$usernamePrefix,
		$assignKnownUsers
	)

Since: 1.31

Parameters

string	$usernamePrefix	Prefix to apply to unknown (and possibly also known) usernames
bool	$assignKnownUsers	Whether to apply the prefix to usernames that exist locally

Definition at line 343 of file WikiImporter.php.

◆ siteInfoCallback()

WikiImporter::siteInfoCallback ( $siteInfo )

private

Notify the callback function of site info.

Parameters

array $siteInfo

Returns: bool|mixed

Definition at line 479 of file WikiImporter.php.

Referenced by handleSiteInfo().

◆ throwXmlError()

WikiImporter::throwXmlError ( $err )

Definition at line 128 of file WikiImporter.php.

References debug(), and wfDebug().

◆ warn()

WikiImporter::warn ( $data )

Definition at line 139 of file WikiImporter.php.

References wfDebug().

Referenced by doImport(), handleContent(), handleLogItem(), handlePage(), handleRevision(), and handleUpload().

Member Data Documentation

◆ $config

Config WikiImporter::$config

private

Definition at line 48 of file WikiImporter.php.

◆ $countableCache

array WikiImporter::$countableCache = []

private

Definition at line 54 of file WikiImporter.php.

◆ $disableStatisticsUpdate

bool WikiImporter::$disableStatisticsUpdate = false

private

Definition at line 56 of file WikiImporter.php.

◆ $externalUserNames

ExternalUserNames WikiImporter::$externalUserNames

private

Definition at line 58 of file WikiImporter.php.

◆ $foreignNamespaces

WikiImporter::$foreignNamespaces = null

private

Definition at line 40 of file WikiImporter.php.

◆ $hookRunner

HookRunner WikiImporter::$hookRunner

private

Definition at line 52 of file WikiImporter.php.

◆ $importTitleFactory

ImportTitleFactory WikiImporter::$importTitleFactory

private

Definition at line 50 of file WikiImporter.php.

◆ $mDebug

WikiImporter::$mDebug

private

Definition at line 43 of file WikiImporter.php.

◆ $mImageBasePath

WikiImporter::$mImageBasePath

private

Definition at line 44 of file WikiImporter.php.

◆ $mImportUploads

WikiImporter::$mImportUploads

private

Definition at line 44 of file WikiImporter.php.

◆ $mLogItemCallback

WikiImporter::$mLogItemCallback

private

Definition at line 41 of file WikiImporter.php.

◆ $mNoticeCallback

WikiImporter::$mNoticeCallback

private

Definition at line 43 of file WikiImporter.php.

◆ $mNoUpdates

WikiImporter::$mNoUpdates = false

private

Definition at line 45 of file WikiImporter.php.

◆ $mPageCallback

WikiImporter::$mPageCallback

private

Definition at line 41 of file WikiImporter.php.

◆ $mPageOutCallback

WikiImporter::$mPageOutCallback

private

Definition at line 42 of file WikiImporter.php.

◆ $mRevisionCallback

WikiImporter::$mRevisionCallback

private

Definition at line 41 of file WikiImporter.php.

◆ $mSiteInfoCallback

WikiImporter::$mSiteInfoCallback

private

Definition at line 42 of file WikiImporter.php.

◆ $mUploadCallback

WikiImporter::$mUploadCallback

private

Definition at line 41 of file WikiImporter.php.

◆ $pageOffset

WikiImporter::$pageOffset = 0

private

Definition at line 46 of file WikiImporter.php.

◆ $reader

XMLReader null WikiImporter::$reader

private

Definition at line 39 of file WikiImporter.php.

Referenced by __construct().

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

includes/import/WikiImporter.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ beforeImportPage()

◆ debug()

◆ debugRevisionHandler()

◆ disableStatisticsUpdate()

◆ doImport()

◆ dumpTemp()

◆ finishImportPage()

◆ getContentHandler()

◆ getDefaultContentModel()

◆ getReader()

◆ handleContent()

◆ handleContributor()

◆ handleLogItem()

◆ handlePage()

◆ handleRevision()

◆ handleSiteInfo()

◆ handleUpload()

◆ importLogItem()

◆ importRevision()

◆ importUpload()

◆ logItemCallback()

◆ makeContent()

◆ nodeAttribute()

◆ nodeContents()

◆ notice()

◆ pageCallback()

◆ pageOutCallback()

◆ processLogItem()

◆ processRevision()

◆ processTitle()

◆ processUpload()

◆ revisionCallback()

◆ setDebug()

◆ setImageBasePath()

◆ setImportTitleFactory()

◆ setImportUploads()

◆ setLogItemCallback()

◆ setNoticeCallback()

◆ setNoUpdates()

◆ setPageCallback()

◆ setPageOffset()

◆ setPageOutCallback()

◆ setRevisionCallback()

◆ setSiteInfoCallback()

◆ setTargetNamespace()

◆ setTargetRootPage()

◆ setUploadCallback()

◆ setUsernamePrefix()

◆ siteInfoCallback()

◆ throwXmlError()

◆ warn()

Member Data Documentation

◆ $config

◆ $countableCache

◆ $disableStatisticsUpdate

◆ $externalUserNames

◆ $foreignNamespaces

◆ $hookRunner

◆ $importTitleFactory

◆ $mDebug

◆ $mImageBasePath

◆ $mImportUploads

◆ $mLogItemCallback

◆ $mNoticeCallback

◆ $mNoUpdates

◆ $mPageCallback

◆ $mPageOutCallback

◆ $mRevisionCallback

◆ $mSiteInfoCallback

◆ $mUploadCallback

◆ $pageOffset

◆ $reader