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

Inherits ImportableUploadRevision, and ImportableOldRevision.

Collaboration diagram for 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 43 of file WikiRevision.php.

Constructor & Destructor Documentation

◆ __construct()

WikiRevision::__construct ( )

Definition at line 196 of file WikiRevision.php.

Member Function Documentation

◆ getAction()

WikiRevision::getAction ( )

Since: 1.12.2

Returns: string

Definition at line 620 of file WikiRevision.php.

◆ getArchiveName()

WikiRevision::getArchiveName ( )

Since: 1.17

Returns: string

Implements ImportableUploadRevision.

Definition at line 596 of file WikiRevision.php.

◆ getComment()

WikiRevision::getComment ( )

Since: 1.2.6

Returns: string

Implements ImportableUploadRevision.

Definition at line 521 of file WikiRevision.php.

◆ getContent()

WikiRevision::getContent ( $role = SlotRecord::MAIN )

Since: 1.21

Parameters

string $role added in 1.35

Returns: Content

Implements ImportableOldRevision.

Definition at line 474 of file WikiRevision.php.

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

◆ getContentHandler()

WikiRevision::getContentHandler ( )

Since: 1.24

Deprecated:: since 1.35, use getContent

Returns: ContentHandler

Exceptions

MWUnknownContentModelException

Definition at line 461 of file WikiRevision.php.

References $contentHandler, and getModel().

Referenced by getFormat().

◆ getFilename()

WikiRevision::getFilename ( )

Since: 1.12.2

Returns: mixed

Definition at line 588 of file WikiRevision.php.

Referenced by BackupReader\handleUpload().

◆ getFileSrc()

WikiRevision::getFileSrc ( )

Since: 1.17

Returns: string

Implements ImportableUploadRevision.

Definition at line 572 of file WikiRevision.php.

◆ getFormat()

WikiRevision::getFormat ( )

Since: 1.21

Deprecated:: since 1.35, use getContent

Returns: string

Implements ImportableOldRevision.

Definition at line 511 of file WikiRevision.php.

References $format, and getContentHandler().

◆ getID()

WikiRevision::getID ( )

Since: 1.6.4

Returns: int

Definition at line 418 of file WikiRevision.php.

References $id.

◆ getMinor()

WikiRevision::getMinor ( )

Since: 1.5.7

Returns: bool

Implements ImportableOldRevision.

Definition at line 529 of file WikiRevision.php.

◆ getModel()

WikiRevision::getModel ( )

Since: 1.21

Deprecated:: since 1.35, use getContent

Returns: string

Implements ImportableOldRevision.

Definition at line 500 of file WikiRevision.php.

References $model, and getTitle().

Referenced by getContentHandler(), and setText().

◆ getParams()

WikiRevision::getParams ( )

Since: 1.12.2

Returns: string

Definition at line 628 of file WikiRevision.php.

◆ getSha1()

WikiRevision::getSha1 ( )

Since: 1.17

Returns: string|false

Implements ImportableUploadRevision.

Definition at line 545 of file WikiRevision.php.

◆ getSha1Base36()

WikiRevision::getSha1Base36 ( )

Since: 1.31

Returns: string|false

Implements ImportableOldRevision.

Definition at line 556 of file WikiRevision.php.

◆ getSize()

WikiRevision::getSize ( )

Since: 1.12.2

Returns: mixed

Definition at line 604 of file WikiRevision.php.

◆ getSlot()

WikiRevision::getSlot ( $role )

Since: 1.35

Parameters

string $role

Returns: SlotRecord

Implements ImportableOldRevision.

Definition at line 483 of file WikiRevision.php.

◆ getSlotRoles()

WikiRevision::getSlotRoles ( )

Since: 1.35

Returns: string[]

Implements ImportableOldRevision.

Definition at line 491 of file WikiRevision.php.

◆ getSrc()

WikiRevision::getSrc ( )

Since: 1.12.2

Returns: string|null

Implements ImportableUploadRevision.

Definition at line 537 of file WikiRevision.php.

◆ getTags()

WikiRevision::getTags ( )

Since: 1.34

Returns: string[]

Implements ImportableOldRevision.

Definition at line 564 of file WikiRevision.php.

◆ getText()

WikiRevision::getText ( )

Since: 1.2

Returns: string

Definition at line 451 of file WikiRevision.php.

References $text.

◆ getTimestamp()

WikiRevision::getTimestamp ( )

Since: 1.2

Returns: string TS_MW timestamp, a string with 14 digits

Implements ImportableUploadRevision.

Definition at line 426 of file WikiRevision.php.

References $timestamp.

Referenced by SearchDump\processRevision().

◆ getTitle()

WikiRevision::getTitle ( )

Since: 1.2

Returns: Title

Implements ImportableUploadRevision.

Definition at line 410 of file WikiRevision.php.

References $title.

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

◆ getType()

WikiRevision::getType ( )

Since: 1.12.2

Returns: string

Definition at line 612 of file WikiRevision.php.

◆ getUser()

WikiRevision::getUser ( )

Since: 1.2

Returns: string

Implements ImportableUploadRevision.

Definition at line 434 of file WikiRevision.php.

References $user_text.

◆ getUserObj()

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 ImportableUploadRevision.

Definition at line 443 of file WikiRevision.php.

References $userObj.

◆ importLogItem()

WikiRevision::importLogItem ( )

Since: 1.12.2

Returns: bool

Definition at line 650 of file WikiRevision.php.

References getTitle(), getUser(), and wfDebug().

◆ importOldRevision()

WikiRevision::importOldRevision ( )

Since: 1.4.1

Deprecated:: in 1.31. Use OldRevisionImporter::import

Returns: bool

Definition at line 637 of file WikiRevision.php.

◆ isTempSrc()

WikiRevision::isTempSrc ( )

Since: 1.17

Returns: bool

Implements ImportableUploadRevision.

Definition at line 580 of file WikiRevision.php.

◆ setAction()

WikiRevision::setAction ( $action )

Since: 1.12.2

Parameters

string $action

Definition at line 386 of file WikiRevision.php.

References $action.

◆ setArchiveName()

WikiRevision::setArchiveName ( $archiveName )

Since: 1.17

Parameters

string $archiveName

Definition at line 362 of file WikiRevision.php.

References $archiveName.

◆ setComment()

WikiRevision::setComment ( string $text )

Since: 1.2.6

Parameters

string $text

Definition at line 304 of file WikiRevision.php.

References $text.

◆ setContent()

WikiRevision::setContent	(	$role,
		$content
	)

Since: 1.35

Parameters

string	$role
Content	$content

Definition at line 288 of file WikiRevision.php.

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

Referenced by setText().

◆ setFilename()

WikiRevision::setFilename ( $filename )

Since: 1.12.2

Parameters

string $filename

Definition at line 354 of file WikiRevision.php.

References $filename.

◆ setFileSrc()

WikiRevision::setFileSrc	(	$src,
		$isTemp
	)

Since: 1.17

Parameters

string	$src
bool	$isTemp

Definition at line 329 of file WikiRevision.php.

References $isTemp, and $src.

◆ setFormat()

WikiRevision::setFormat ( $format )

Since: 1.21

Deprecated:: since 1.35, use setContent instead.

Parameters

string $format

Definition at line 268 of file WikiRevision.php.

References $format.

◆ setID()

WikiRevision::setID ( $id )

Since: 1.6.4

Parameters

int $id

Definition at line 211 of file WikiRevision.php.

References $id.

◆ setMinor()

WikiRevision::setMinor ( $minor )

Since: 1.5.7

Parameters

bool $minor

Definition at line 312 of file WikiRevision.php.

References $minor.

◆ setModel()

WikiRevision::setModel ( $model )

Since: 1.21

Deprecated:: since 1.35, use setContent instead.

Parameters

string $model

Definition at line 259 of file WikiRevision.php.

References $model.

◆ setNoUpdates()

WikiRevision::setNoUpdates ( $noupdates )

Since: 1.18

Parameters

bool $noupdates

Definition at line 402 of file WikiRevision.php.

◆ setParams()

WikiRevision::setParams ( $params )

Since: 1.12.2

Parameters

string $params

Definition at line 394 of file WikiRevision.php.

References $params.

◆ setSha1Base36()

WikiRevision::setSha1Base36 ( $sha1base36 )

Since: 1.17

Parameters

string $sha1base36

Definition at line 338 of file WikiRevision.php.

◆ setSize()

WikiRevision::setSize ( $size )

Since: 1.12.2

Parameters

int $size

Definition at line 370 of file WikiRevision.php.

References $size.

◆ setSrc()

WikiRevision::setSrc ( $src )

Since: 1.12.2

Parameters

string | null $src

Definition at line 320 of file WikiRevision.php.

References $src.

◆ setTags()

WikiRevision::setTags ( array $tags )

Since: 1.34

Parameters

string[] $tags

Definition at line 346 of file WikiRevision.php.

References $tags.

◆ setText()

WikiRevision::setText ( $text )

Since: 1.2

Deprecated:: since 1.35, use setContent instead.

Parameters

string $text

Definition at line 277 of file WikiRevision.php.

References $content, $text, getModel(), and setContent().

◆ setTimestamp()

WikiRevision::setTimestamp ( $ts )

Since: 1.2

Parameters

string $ts

Definition at line 219 of file WikiRevision.php.

References wfTimestamp().

◆ setTitle()

WikiRevision::setTitle ( Title $title )

Parameters

Title $title

Definition at line 203 of file WikiRevision.php.

References $title.

◆ setType()

WikiRevision::setType ( $type )

Since: 1.12.2

Parameters

string $type

Definition at line 378 of file WikiRevision.php.

References $type.

◆ setUserIP()

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 250 of file WikiRevision.php.

◆ setUsername()

WikiRevision::setUsername ( $user )

Since: 1.2

Parameters

string $user

Definition at line 228 of file WikiRevision.php.

◆ setUserObj()

WikiRevision::setUserObj ( $user )

Deprecated:: since 1.39, use {

See also: setUsername} instead

Since: 1.27

Parameters

User $user

Definition at line 237 of file WikiRevision.php.

Member Data Documentation

◆ $action

string WikiRevision::$action = ""

Since: 1.12.2

Definition at line 143 of file WikiRevision.php.

Referenced by setAction().

◆ $archiveName

string WikiRevision::$archiveName = ''

Since: 1.17

Definition at line 172 of file WikiRevision.php.

Referenced by setArchiveName().

◆ $comment

string WikiRevision::$comment = ""

Since: 1.2.6

Definition at line 120 of file WikiRevision.php.

◆ $content

Content WikiRevision::$content = null

Since: 1.21

Deprecated:: since 1.35, use getContent

Definition at line 108 of file WikiRevision.php.

Referenced by setContent(), and setText().

◆ $contentHandler

ContentHandler WikiRevision::$contentHandler = null

protected

Since: 1.24

Definition at line 114 of file WikiRevision.php.

Referenced by getContentHandler().

◆ $filename

string null WikiRevision::$filename

protected

Since: 1.12.2

Definition at line 178 of file WikiRevision.php.

Referenced by setFilename().

◆ $fileSrc

string WikiRevision::$fileSrc = ''

Since: 1.17

Definition at line 155 of file WikiRevision.php.

◆ $format

string WikiRevision::$format = null

Since: 1.21

Deprecated:: since 1.35, use getContent

Definition at line 88 of file WikiRevision.php.

Referenced by getFormat(), and setFormat().

◆ $id

int WikiRevision::$id = 0

Since: 1.6.4

Definition at line 55 of file WikiRevision.php.

Referenced by getID(), and setID().

◆ $isTemp

bool WikiRevision::$isTemp = false

Since: 1.18

Todo:: Unused?

Definition at line 191 of file WikiRevision.php.

Referenced by setFileSrc().

◆ $minor

bool WikiRevision::$minor = false

Since: 1.5.7

Definition at line 131 of file WikiRevision.php.

Referenced by setMinor().

◆ $model

string WikiRevision::$model = null

Since: 1.21

Deprecated:: since 1.35, use getContent

Definition at line 81 of file WikiRevision.php.

Referenced by getModel(), and setModel().

◆ $params

string WikiRevision::$params = ""

Since: 1.12.2

Definition at line 149 of file WikiRevision.php.

Referenced by setParams().

◆ $size

int WikiRevision::$size

protected

Since: 1.12.2

Definition at line 101 of file WikiRevision.php.

Referenced by setSize().

◆ $src

string null WikiRevision::$src = null

protected

Since: 1.12.2

Definition at line 184 of file WikiRevision.php.

Referenced by setFileSrc(), and setSrc().

◆ $tags

string [] WikiRevision::$tags = []

protected

Since: 1.34

Definition at line 166 of file WikiRevision.php.

Referenced by setTags().

◆ $text

string WikiRevision::$text = ""

Since: 1.2

Deprecated:: since 1.35, use getContent

Definition at line 95 of file WikiRevision.php.

Referenced by getText(), setComment(), and setText().

◆ $timestamp

string WikiRevision::$timestamp = "20010115000000"

Since: 1.2 TS_MW timestamp, a string with 14 digits

Definition at line 61 of file WikiRevision.php.

Referenced by getTimestamp().

◆ $title

Title WikiRevision::$title = null

Since: 1.2

Definition at line 49 of file WikiRevision.php.

Referenced by getTitle(), and setTitle().

◆ $type

string WikiRevision::$type = ""

Since: 1.12.2

Definition at line 137 of file WikiRevision.php.

Referenced by setType().

◆ $user_text

string WikiRevision::$user_text = ""

Since: 1.2

Definition at line 67 of file WikiRevision.php.

Referenced by getUser().

◆ $userObj

User null WikiRevision::$userObj = null

Deprecated:: since 1.39, use {

See also: $user_text} instead

Since: 1.27

Definition at line 74 of file WikiRevision.php.

Referenced by 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