Represents a revision, log entry or upload during the import process. More...

Inherits MediaWiki\Import\ImportableUploadRevision, and MediaWiki\Import\ImportableOldRevision.

Collaboration diagram for MediaWiki\Import\WikiRevision:

[legend]

Public Member Functions
	__construct ()

	getAction ()

	getArchiveName ()

	getComment ()

	getContent ( $role=SlotRecord::MAIN)

	getContentHandler ()

	getFilename ()

	getFileSrc ()

	getFormat ()

	getID ()

	getMinor ()

	getModel ()

	getParams ()

	getSha1 ()

	getSha1Base36 ()

	getSize ()

	getSlot ( $role)

	getSlotRoles ()

	getSrc ()

	getTags ()

	getText ()

	getTimestamp ()

	getTitle ()

	getType ()

	getUser ()

	getUserObj ()

	importLogItem ()

	importOldRevision ()

	isTempSrc ()

	setAction ( $action)

	setArchiveName ( $archiveName)

	setComment (string $text)

	setContent ( $role, $content)

	setFilename ( $filename)

	setFileSrc ( $src, $isTemp)

	setFormat ( $format)

	setID ( $id)

	setMinor ( $minor)

	setModel ( $model)

	setNoUpdates ( $noupdates)

	setParams ( $params)

	setSha1Base36 ( $sha1base36)

	setSize ( $size)

	setSrc ( $src)

	setTags (array $tags)

	setText ( $text)

	setTimestamp ( $ts)

	setTitle (Title $title)

	setType ( $type)

	setUserIP ( $ip)

	setUsername ( $user)

	setUserObj ( $user)

Public Attributes
string	$action = ""

string	$archiveName = ''

string	$comment = ""

Content	$content = null

string	$fileSrc = ''

string	$format = null

int	$id = 0

bool	$isTemp = false

bool	$minor = false

string	$model = null

string	$params = ""

string	$text = ""

string	$timestamp = "20010115000000"

Title	$title = null

string	$type = ""

string	$user_text = ""

User null	$userObj = null

Protected Attributes
ContentHandler	$contentHandler = null

string null	$filename

int	$size

string null	$src = null

string[]	$tags = []

Detailed Description

Represents a revision, log entry or upload during the import process.

This class sticks closely to the structure of the XML dump.

Since: 1.2

Definition at line 36 of file WikiRevision.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Import\WikiRevision::__construct ( )

Definition at line 186 of file WikiRevision.php.

Member Function Documentation

◆ getAction()

MediaWiki\Import\WikiRevision::getAction ( )

Since: 1.12.2

Returns: string

Definition at line 607 of file WikiRevision.php.

◆ getArchiveName()

MediaWiki\Import\WikiRevision::getArchiveName ( )

Since: 1.17

Returns: string

Implements MediaWiki\Import\ImportableUploadRevision.

Definition at line 583 of file WikiRevision.php.

◆ getComment()

MediaWiki\Import\WikiRevision::getComment ( )

Since: 1.2.6

Returns: string

Implements MediaWiki\Import\ImportableUploadRevision.

Definition at line 508 of file WikiRevision.php.

◆ getContent()

MediaWiki\Import\WikiRevision::getContent ( $role = SlotRecord::MAIN )

Since: 1.21

Parameters

string $role added in 1.35

Returns: Content

Implements MediaWiki\Import\ImportableOldRevision.

Definition at line 461 of file WikiRevision.php.

Referenced by DumpRenderer\handleRevision(), and CompareParsers\processRevision().

◆ getContentHandler()

MediaWiki\Import\WikiRevision::getContentHandler ( )

Since: 1.24

Deprecated: since 1.35, use getContent

Returns: ContentHandler

Exceptions

UnknownContentModelException

Definition at line 448 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$contentHandler, MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Import\WikiRevision\getModel().

Referenced by MediaWiki\Import\WikiRevision\getFormat(), and MediaWiki\Import\WikiRevision\setText().

◆ getFilename()

MediaWiki\Import\WikiRevision::getFilename ( )

Since: 1.12.2

Returns: mixed

Definition at line 575 of file WikiRevision.php.

Referenced by BackupReader\handleUpload().

◆ getFileSrc()

MediaWiki\Import\WikiRevision::getFileSrc ( )

Since: 1.17

Returns: string

Implements MediaWiki\Import\ImportableUploadRevision.

Definition at line 559 of file WikiRevision.php.

◆ getFormat()

MediaWiki\Import\WikiRevision::getFormat ( )

Since: 1.21

Deprecated: since 1.35, use getContent

Returns: string

Implements MediaWiki\Import\ImportableOldRevision.

Definition at line 498 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$format, and MediaWiki\Import\WikiRevision\getContentHandler().

◆ getID()

MediaWiki\Import\WikiRevision::getID ( )

Since: 1.6.4

Returns: int

Definition at line 405 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$id.

Referenced by DumpRenderer\handleRevision().

◆ getMinor()

MediaWiki\Import\WikiRevision::getMinor ( )

Since: 1.5.7

Returns: bool

Implements MediaWiki\Import\ImportableOldRevision.

Definition at line 516 of file WikiRevision.php.

◆ getModel()

MediaWiki\Import\WikiRevision::getModel ( )

Since: 1.21

Deprecated: since 1.35, use getContent

Returns: string

Implements MediaWiki\Import\ImportableOldRevision.

Definition at line 487 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$model, and MediaWiki\Import\WikiRevision\getTitle().

Referenced by MediaWiki\Import\WikiRevision\getContentHandler().

◆ getParams()

MediaWiki\Import\WikiRevision::getParams ( )

Since: 1.12.2

Returns: string

Definition at line 615 of file WikiRevision.php.

◆ getSha1()

MediaWiki\Import\WikiRevision::getSha1 ( )

Since: 1.17

Returns: string|false

Implements MediaWiki\Import\ImportableUploadRevision.

Definition at line 532 of file WikiRevision.php.

◆ getSha1Base36()

MediaWiki\Import\WikiRevision::getSha1Base36 ( )

Since: 1.31

Returns: string|false

Implements MediaWiki\Import\ImportableOldRevision.

Definition at line 543 of file WikiRevision.php.

◆ getSize()

MediaWiki\Import\WikiRevision::getSize ( )

Since: 1.12.2

Returns: mixed

Definition at line 591 of file WikiRevision.php.

◆ getSlot()

MediaWiki\Import\WikiRevision::getSlot ( $role )

Since: 1.35

Parameters

string $role

Returns: SlotRecord

Implements MediaWiki\Import\ImportableOldRevision.

Definition at line 470 of file WikiRevision.php.

◆ getSlotRoles()

MediaWiki\Import\WikiRevision::getSlotRoles ( )

Since: 1.35

Returns: string[]

Implements MediaWiki\Import\ImportableOldRevision.

Definition at line 478 of file WikiRevision.php.

◆ getSrc()

MediaWiki\Import\WikiRevision::getSrc ( )

Since: 1.12.2

Returns: string|null

Implements MediaWiki\Import\ImportableUploadRevision.

Definition at line 524 of file WikiRevision.php.

◆ getTags()

MediaWiki\Import\WikiRevision::getTags ( )

Since: 1.34

Returns: string[]

Implements MediaWiki\Import\ImportableOldRevision.

Definition at line 551 of file WikiRevision.php.

◆ getText()

MediaWiki\Import\WikiRevision::getText ( )

Since: 1.2

Returns: string

Definition at line 438 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$text.

◆ getTimestamp()

MediaWiki\Import\WikiRevision::getTimestamp ( )

Since: 1.2

Returns: string TS::MW timestamp, a string with 14 digits

Implements MediaWiki\Import\ImportableUploadRevision.

Definition at line 413 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$timestamp.

Referenced by DumpRenderer\handleRevision().

◆ getTitle()

MediaWiki\Import\WikiRevision::getTitle ( )

Since: 1.2

Returns: Title

Implements MediaWiki\Import\ImportableUploadRevision.

Definition at line 397 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$title.

Referenced by MediaWiki\Import\WikiRevision\getModel(), BackupReader\handleLogItem(), BackupReader\handleRevision(), DumpRenderer\handleRevision(), BackupReader\handleUpload(), and CompareParsers\processRevision().

◆ getType()

MediaWiki\Import\WikiRevision::getType ( )

Since: 1.12.2

Returns: string

Definition at line 599 of file WikiRevision.php.

◆ getUser()

MediaWiki\Import\WikiRevision::getUser ( )

Since: 1.2

Returns: string

Implements MediaWiki\Import\ImportableUploadRevision.

Definition at line 421 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$user_text.

◆ getUserObj()

MediaWiki\Import\WikiRevision::getUserObj ( )

Deprecated: since 1.39, use {

See also: getUser} instead; this is almost always null anyway

Since: 1.27

Returns: User|null Typically null, use {

See also: getUser} instead

Implements MediaWiki\Import\ImportableUploadRevision.

Definition at line 430 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$userObj.

◆ importLogItem()

MediaWiki\Import\WikiRevision::importLogItem ( )

Since: 1.12.2

Returns: bool

Definition at line 637 of file WikiRevision.php.

References MediaWiki\MediaWikiServices\getInstance(), and wfDebug().

◆ importOldRevision()

MediaWiki\Import\WikiRevision::importOldRevision ( )

Since: 1.4.1

Deprecated: since 1.31. Use OldRevisionImporter::import

Returns: bool

Definition at line 624 of file WikiRevision.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ isTempSrc()

MediaWiki\Import\WikiRevision::isTempSrc ( )

Since: 1.17

Returns: bool

Implements MediaWiki\Import\ImportableUploadRevision.

Definition at line 567 of file WikiRevision.php.

◆ setAction()

MediaWiki\Import\WikiRevision::setAction ( $action )

Since: 1.12.2

Parameters

string $action

Definition at line 373 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$action.

◆ setArchiveName()

MediaWiki\Import\WikiRevision::setArchiveName ( $archiveName )

Since: 1.17

Parameters

string $archiveName

Definition at line 349 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$archiveName.

◆ setComment()

MediaWiki\Import\WikiRevision::setComment ( string $text )

Since: 1.2.6

Parameters

string $text

Definition at line 291 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$text.

◆ setContent()

MediaWiki\Import\WikiRevision::setContent	(		$role,
			$content )

Since: 1.35

Parameters

string	$role
Content	$content

Definition at line 275 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$content, MediaWiki\Content\Content\getDefaultFormat(), MediaWiki\Content\Content\getModel(), and MediaWiki\Content\Content\serialize().

Referenced by MediaWiki\Import\WikiRevision\setText().

◆ setFilename()

MediaWiki\Import\WikiRevision::setFilename ( $filename )

Since: 1.12.2

Parameters

string $filename

Definition at line 341 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$filename.

◆ setFileSrc()

MediaWiki\Import\WikiRevision::setFileSrc	(		$src,
			$isTemp )

Since: 1.17

Parameters

string	$src
bool	$isTemp

Definition at line 316 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$isTemp, and MediaWiki\Import\WikiRevision\$src.

◆ setFormat()

MediaWiki\Import\WikiRevision::setFormat ( $format )

Since: 1.21

Deprecated: since 1.35, use setContent instead.

Parameters

string $format

Definition at line 255 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$format.

◆ setID()

MediaWiki\Import\WikiRevision::setID ( $id )

Since: 1.6.4

Parameters

int $id

Definition at line 198 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$id.

◆ setMinor()

MediaWiki\Import\WikiRevision::setMinor ( $minor )

Since: 1.5.7

Parameters

bool $minor

Definition at line 299 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$minor.

◆ setModel()

MediaWiki\Import\WikiRevision::setModel ( $model )

Since: 1.21

Deprecated: since 1.35, use setContent instead.

Parameters

string $model

Definition at line 246 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$model.

◆ setNoUpdates()

MediaWiki\Import\WikiRevision::setNoUpdates ( $noupdates )

Since: 1.18

Parameters

bool $noupdates

Definition at line 389 of file WikiRevision.php.

◆ setParams()

MediaWiki\Import\WikiRevision::setParams ( $params )

Since: 1.12.2

Parameters

string $params

Definition at line 381 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$params.

◆ setSha1Base36()

MediaWiki\Import\WikiRevision::setSha1Base36 ( $sha1base36 )

Since: 1.17

Parameters

string $sha1base36

Definition at line 325 of file WikiRevision.php.

◆ setSize()

MediaWiki\Import\WikiRevision::setSize ( $size )

Since: 1.12.2

Parameters

int $size

Definition at line 357 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$size.

◆ setSrc()

MediaWiki\Import\WikiRevision::setSrc ( $src )

Since: 1.12.2

Parameters

string | null $src

Definition at line 307 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$src.

◆ setTags()

MediaWiki\Import\WikiRevision::setTags ( array $tags )

Since: 1.34

Parameters

string[] $tags

Definition at line 333 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$tags.

◆ setText()

MediaWiki\Import\WikiRevision::setText ( $text )

Since: 1.2

Deprecated: since 1.35, use setContent instead.

Parameters

string $text

Definition at line 264 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$content, MediaWiki\Import\WikiRevision\$text, MediaWiki\Import\WikiRevision\getContentHandler(), and MediaWiki\Import\WikiRevision\setContent().

◆ setTimestamp()

MediaWiki\Import\WikiRevision::setTimestamp ( $ts )

Since: 1.2

Parameters

string $ts

Definition at line 206 of file WikiRevision.php.

References wfTimestamp().

◆ setTitle()

MediaWiki\Import\WikiRevision::setTitle ( Title $title )

Definition at line 190 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$title.

◆ setType()

MediaWiki\Import\WikiRevision::setType ( $type )

Since: 1.12.2

Parameters

string $type

Definition at line 365 of file WikiRevision.php.

References MediaWiki\Import\WikiRevision\$type.

◆ setUserIP()

MediaWiki\Import\WikiRevision::setUserIP ( $ip )

Deprecated: since 1.39, use {

See also: setUsername} instead, it does the same anyway

Since: 1.2

Parameters

string $ip

Definition at line 237 of file WikiRevision.php.

◆ setUsername()

MediaWiki\Import\WikiRevision::setUsername ( $user )

Since: 1.2

Parameters

string $user

Definition at line 215 of file WikiRevision.php.

◆ setUserObj()

MediaWiki\Import\WikiRevision::setUserObj ( $user )

Deprecated: since 1.39, use {

See also: setUsername} instead

Since: 1.27

Parameters

User $user

Definition at line 224 of file WikiRevision.php.

Member Data Documentation

◆ $action

string MediaWiki\Import\WikiRevision::$action = ""

Since: 1.12.2

Definition at line 133 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setAction().

◆ $archiveName

string MediaWiki\Import\WikiRevision::$archiveName = ''

Since: 1.17

Definition at line 162 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setArchiveName().

◆ $comment

string MediaWiki\Import\WikiRevision::$comment = ""

Since: 1.2.6

Definition at line 113 of file WikiRevision.php.

◆ $content

Content MediaWiki\Import\WikiRevision::$content = null

Since: 1.21

Deprecated: since 1.35, use getContent

Definition at line 101 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setContent(), and MediaWiki\Import\WikiRevision\setText().

◆ $contentHandler

ContentHandler MediaWiki\Import\WikiRevision::$contentHandler = null

protected

Since: 1.24

Definition at line 107 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\getContentHandler().

◆ $filename

string null MediaWiki\Import\WikiRevision::$filename

protected

Since: 1.12.2

Definition at line 168 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setFilename().

◆ $fileSrc

string MediaWiki\Import\WikiRevision::$fileSrc = ''

Since: 1.17

Definition at line 145 of file WikiRevision.php.

◆ $format

string MediaWiki\Import\WikiRevision::$format = null

Since: 1.21

Deprecated: since 1.35, use getContent

Definition at line 81 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\getFormat(), and MediaWiki\Import\WikiRevision\setFormat().

◆ $id

int MediaWiki\Import\WikiRevision::$id = 0

Since: 1.6.4

Definition at line 48 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\getID(), and MediaWiki\Import\WikiRevision\setID().

◆ $isTemp

bool MediaWiki\Import\WikiRevision::$isTemp = false

Since: 1.18

Todo: Unused?

Definition at line 181 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setFileSrc().

◆ $minor

bool MediaWiki\Import\WikiRevision::$minor = false

Since: 1.5.7

Definition at line 121 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setMinor().

◆ $model

string MediaWiki\Import\WikiRevision::$model = null

Since: 1.21

Deprecated: since 1.35, use getContent

Definition at line 74 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\getModel(), and MediaWiki\Import\WikiRevision\setModel().

◆ $params

string MediaWiki\Import\WikiRevision::$params = ""

Since: 1.12.2

Definition at line 139 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setParams().

◆ $size

int MediaWiki\Import\WikiRevision::$size

protected

Since: 1.12.2

Definition at line 94 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setSize().

◆ $src

string null MediaWiki\Import\WikiRevision::$src = null

protected

Since: 1.12.2

Definition at line 174 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setFileSrc(), and MediaWiki\Import\WikiRevision\setSrc().

◆ $tags

string [] MediaWiki\Import\WikiRevision::$tags = []

protected

Since: 1.34

Definition at line 156 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setTags().

◆ $text

string MediaWiki\Import\WikiRevision::$text = ""

Since: 1.2

Deprecated: since 1.35, use getContent

Definition at line 88 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\getText(), MediaWiki\Import\WikiRevision\setComment(), and MediaWiki\Import\WikiRevision\setText().

◆ $timestamp

string MediaWiki\Import\WikiRevision::$timestamp = "20010115000000"

Since: 1.2 TS::MW timestamp, a string with 14 digits

Definition at line 54 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\getTimestamp().

◆ $title

Title MediaWiki\Import\WikiRevision::$title = null

Since: 1.2

Definition at line 42 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\getTitle(), and MediaWiki\Import\WikiRevision\setTitle().

◆ $type

string MediaWiki\Import\WikiRevision::$type = ""

Since: 1.12.2

Definition at line 127 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\setType().

◆ $user_text

string MediaWiki\Import\WikiRevision::$user_text = ""

Since: 1.2

Definition at line 60 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\getUser().

◆ $userObj

User null MediaWiki\Import\WikiRevision::$userObj = null

Deprecated: since 1.39, use {

See also: $user_text} instead

Since: 1.27

Definition at line 67 of file WikiRevision.php.

Referenced by MediaWiki\Import\WikiRevision\getUserObj().

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

includes/Import/WikiRevision.php

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAction()

◆ getArchiveName()

◆ getComment()

◆ getContent()

◆ getContentHandler()

◆ getFilename()

◆ getFileSrc()

◆ getFormat()

◆ getID()

◆ getMinor()

◆ getModel()

◆ getParams()

◆ getSha1()

◆ getSha1Base36()

◆ getSize()

◆ getSlot()

◆ getSlotRoles()

◆ getSrc()

◆ getTags()

◆ getText()

◆ getTimestamp()

◆ getTitle()

◆ getType()

◆ getUser()

◆ getUserObj()

◆ importLogItem()

◆ importOldRevision()

◆ isTempSrc()

◆ setAction()

◆ setArchiveName()

◆ setComment()

◆ setContent()

◆ setFilename()

◆ setFileSrc()

◆ setFormat()

◆ setID()

◆ setMinor()

◆ setModel()

◆ setNoUpdates()

◆ setParams()

◆ setSha1Base36()

◆ setSize()

◆ setSrc()

◆ setTags()

◆ setText()

◆ setTimestamp()

◆ setTitle()

◆ setType()

◆ setUserIP()

◆ setUsername()

◆ setUserObj()

Member Data Documentation

◆ $action

◆ $archiveName

◆ $comment

◆ $content

◆ $contentHandler

◆ $filename

◆ $fileSrc

◆ $format

◆ $id

◆ $isTemp

◆ $minor

◆ $model

◆ $params

◆ $size

◆ $src

◆ $tags

◆ $text

◆ $timestamp

◆ $title

◆ $type

◆ $user_text