MediaWiki  master
WikiRevision Class Reference

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

Inheritance diagram for WikiRevision:
Collaboration diagram for WikiRevision:

Public Member Functions

 __construct (Config $config)
 
 downloadSource ()
 
 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 ()
 
 importUpload ()
 
 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)
 
 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 = ""
 
bool string $sha1base36 = false
 
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 40 of file WikiRevision.php.

Constructor & Destructor Documentation

◆ __construct()

WikiRevision::__construct ( Config  $config)
Parameters
Config$configDeprecated since 1.31, along with self::downloadSource(). Just pass an empty HashConfig.

Definition at line 213 of file WikiRevision.php.

References deprecatePublicProperty().

Member Function Documentation

◆ downloadSource()

WikiRevision::downloadSource ( )
Since
1.12.2
Deprecated:
in 1.31. No replacement. Hard deprecated in 1.39.
Returns
bool|string

Definition at line 752 of file WikiRevision.php.

References wfDeprecated().

◆ getAction()

WikiRevision::getAction ( )
Since
1.12.2
Returns
string

Definition at line 659 of file WikiRevision.php.

◆ getArchiveName()

WikiRevision::getArchiveName ( )
Since
1.17
Returns
string

Implements ImportableUploadRevision.

Definition at line 635 of file WikiRevision.php.

◆ getComment()

WikiRevision::getComment ( )
Since
1.2.6
Returns
string

Implements ImportableOldRevision.

Definition at line 557 of file WikiRevision.php.

◆ getContent()

WikiRevision::getContent (   $role = SlotRecord::MAIN)
Since
1.21
Parameters
string$roleadded in 1.35
Returns
Content

Implements ImportableOldRevision.

Definition at line 506 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 491 of file WikiRevision.php.

References $contentHandler, and getModel().

Referenced by getFormat().

◆ getFilename()

WikiRevision::getFilename ( )
Since
1.12.2
Returns
mixed

Definition at line 627 of file WikiRevision.php.

Referenced by BackupReader\handleUpload().

◆ getFileSrc()

WikiRevision::getFileSrc ( )
Since
1.17
Returns
string

Implements ImportableUploadRevision.

Definition at line 611 of file WikiRevision.php.

◆ getFormat()

WikiRevision::getFormat ( )
Since
1.21
Deprecated:
since 1.35, use getContent
Returns
string

Implements ImportableOldRevision.

Definition at line 545 of file WikiRevision.php.

References $format, and getContentHandler().

◆ getID()

WikiRevision::getID ( )
Since
1.6.4
Returns
int

Definition at line 448 of file WikiRevision.php.

References $id.

◆ getMinor()

WikiRevision::getMinor ( )
Since
1.5.7
Returns
bool

Implements ImportableOldRevision.

Definition at line 565 of file WikiRevision.php.

◆ getModel()

WikiRevision::getModel ( )
Since
1.21
Deprecated:
since 1.35, use getContent
Returns
string

Implements ImportableOldRevision.

Definition at line 532 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 667 of file WikiRevision.php.

◆ getSha1()

WikiRevision::getSha1 ( )
Since
1.17
Returns
bool|string

Implements ImportableUploadRevision.

Definition at line 581 of file WikiRevision.php.

◆ getSha1Base36()

WikiRevision::getSha1Base36 ( )
Since
1.31
Returns
bool|string

Implements ImportableOldRevision.

Definition at line 592 of file WikiRevision.php.

◆ getSize()

WikiRevision::getSize ( )
Since
1.12.2
Returns
mixed

Definition at line 643 of file WikiRevision.php.

◆ getSlot()

WikiRevision::getSlot (   $role)
Since
1.35
Parameters
string$role
Returns
SlotRecord

Implements ImportableOldRevision.

Definition at line 515 of file WikiRevision.php.

◆ getSlotRoles()

WikiRevision::getSlotRoles ( )
Since
1.35
Returns
string[]

Implements ImportableOldRevision.

Definition at line 523 of file WikiRevision.php.

◆ getSrc()

WikiRevision::getSrc ( )
Since
1.12.2
Returns
string|null

Implements ImportableUploadRevision.

Definition at line 573 of file WikiRevision.php.

◆ getTags()

WikiRevision::getTags ( )
Since
1.34
Returns
string[]

Implements ImportableOldRevision.

Definition at line 603 of file WikiRevision.php.

◆ getText()

WikiRevision::getText ( )
Since
1.2
Returns
string

Definition at line 481 of file WikiRevision.php.

References $text.

◆ getTimestamp()

WikiRevision::getTimestamp ( )
Since
1.2
Returns
string

Implements ImportableOldRevision.

Definition at line 456 of file WikiRevision.php.

References $timestamp.

Referenced by SearchDump\processRevision().

◆ getTitle()

◆ getType()

WikiRevision::getType ( )
Since
1.12.2
Returns
string

Definition at line 651 of file WikiRevision.php.

References $type.

◆ getUser()

WikiRevision::getUser ( )
Since
1.2
Returns
string

Implements ImportableOldRevision.

Definition at line 464 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 ImportableOldRevision.

Definition at line 473 of file WikiRevision.php.

References $userObj.

◆ importLogItem()

WikiRevision::importLogItem ( )
Since
1.12.2
Returns
bool

Definition at line 689 of file WikiRevision.php.

References $type, DB_PRIMARY, CommentStore\getStore(), getTitle(), getUser(), User\newFromName(), wfDebug(), and wfGetDB().

◆ importOldRevision()

WikiRevision::importOldRevision ( )
Since
1.4.1
Deprecated:
in 1.31. Use OldRevisionImporter::import
Returns
bool

Definition at line 676 of file WikiRevision.php.

◆ importUpload()

WikiRevision::importUpload ( )
Since
1.12.2
Deprecated:
in 1.31. Use UploadRevisionImporter::import
Returns
bool

Definition at line 739 of file WikiRevision.php.

References wfDeprecated().

◆ isTempSrc()

WikiRevision::isTempSrc ( )
Since
1.17
Returns
bool

Implements ImportableUploadRevision.

Definition at line 619 of file WikiRevision.php.

◆ setAction()

WikiRevision::setAction (   $action)
Since
1.12.2
Parameters
string$action

Definition at line 416 of file WikiRevision.php.

References $action.

◆ setArchiveName()

WikiRevision::setArchiveName (   $archiveName)
Since
1.17
Parameters
string$archiveName

Definition at line 392 of file WikiRevision.php.

References $archiveName.

◆ setComment()

WikiRevision::setComment ( string  $text)
Since
1.2.6
Parameters
string$text

Definition at line 333 of file WikiRevision.php.

References $text.

◆ setContent()

WikiRevision::setContent (   $role,
  $content 
)
Since
1.35
Parameters
string$role
Content$content

Definition at line 317 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 384 of file WikiRevision.php.

References $filename.

◆ setFileSrc()

WikiRevision::setFileSrc (   $src,
  $isTemp 
)
Since
1.17
Parameters
string$src
bool$isTemp

Definition at line 358 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 297 of file WikiRevision.php.

References $format.

◆ setID()

WikiRevision::setID (   $id)
Since
1.6.4
Parameters
int$id

Definition at line 240 of file WikiRevision.php.

References $id.

◆ setMinor()

WikiRevision::setMinor (   $minor)
Since
1.5.7
Parameters
bool$minor

Definition at line 341 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 288 of file WikiRevision.php.

References $model.

◆ setNoUpdates()

WikiRevision::setNoUpdates (   $noupdates)
Since
1.18
Parameters
bool$noupdates

Definition at line 432 of file WikiRevision.php.

◆ setParams()

WikiRevision::setParams (   $params)
Since
1.12.2
Parameters
string$params

Definition at line 424 of file WikiRevision.php.

References $params.

◆ setSha1Base36()

WikiRevision::setSha1Base36 (   $sha1base36)
Since
1.17
Parameters
string$sha1base36

Definition at line 368 of file WikiRevision.php.

References $sha1base36.

◆ setSize()

WikiRevision::setSize (   $size)
Since
1.12.2
Parameters
int$size

Definition at line 400 of file WikiRevision.php.

References $size.

◆ setSrc()

WikiRevision::setSrc (   $src)
Since
1.12.2
Parameters
string | null$src

Definition at line 349 of file WikiRevision.php.

References $src.

◆ setTags()

WikiRevision::setTags ( array  $tags)
Since
1.34
Parameters
string[]$tags

Definition at line 376 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 306 of file WikiRevision.php.

References $content, $text, ContentHandler\getForModelID(), getModel(), and setContent().

◆ setTimestamp()

WikiRevision::setTimestamp (   $ts)
Since
1.2
Parameters
string$ts

Definition at line 248 of file WikiRevision.php.

References wfTimestamp().

◆ setTitle()

WikiRevision::setTitle (   $title)
Since
1.7 taking a Title object (string before)
Parameters
Title$title
Exceptions
MWException

Definition at line 225 of file WikiRevision.php.

References $title.

◆ setType()

WikiRevision::setType (   $type)
Since
1.12.2
Parameters
string$type

Definition at line 408 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 279 of file WikiRevision.php.

◆ setUsername()

WikiRevision::setUsername (   $user)
Since
1.2
Parameters
string$user

Definition at line 257 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 266 of file WikiRevision.php.

Member Data Documentation

◆ $action

string WikiRevision::$action = ""
Since
1.12.2

Definition at line 141 of file WikiRevision.php.

Referenced by setAction().

◆ $archiveName

string WikiRevision::$archiveName = ''
Since
1.17

Definition at line 171 of file WikiRevision.php.

Referenced by setArchiveName().

◆ $comment

string WikiRevision::$comment = ""
Since
1.2.6

Definition at line 118 of file WikiRevision.php.

◆ $content

Content WikiRevision::$content = null
Since
1.21
Deprecated:
since 1.35, use getContent

Definition at line 106 of file WikiRevision.php.

Referenced by setContent(), and setText().

◆ $contentHandler

ContentHandler WikiRevision::$contentHandler = null
protected
Since
1.24

Definition at line 112 of file WikiRevision.php.

Referenced by getContentHandler().

◆ $filename

string null WikiRevision::$filename
protected
Since
1.12.2

Definition at line 177 of file WikiRevision.php.

Referenced by setFilename().

◆ $fileSrc

string WikiRevision::$fileSrc = ''
Since
1.17

Definition at line 153 of file WikiRevision.php.

◆ $format

string WikiRevision::$format = null
Since
1.21
Deprecated:
since 1.35, use getContent

Definition at line 86 of file WikiRevision.php.

Referenced by getFormat(), and setFormat().

◆ $id

int WikiRevision::$id = 0
Since
1.6.4

Definition at line 53 of file WikiRevision.php.

Referenced by getID(), and setID().

◆ $isTemp

bool WikiRevision::$isTemp = false
Since
1.18
Todo:
Unused?

Definition at line 190 of file WikiRevision.php.

Referenced by setFileSrc().

◆ $minor

bool WikiRevision::$minor = false
Since
1.5.7

Definition at line 129 of file WikiRevision.php.

Referenced by setMinor().

◆ $model

string WikiRevision::$model = null
Since
1.21
Deprecated:
since 1.35, use getContent

Definition at line 79 of file WikiRevision.php.

Referenced by getModel(), and setModel().

◆ $params

string WikiRevision::$params = ""
Since
1.12.2

Definition at line 147 of file WikiRevision.php.

Referenced by setParams().

◆ $sha1base36

bool string WikiRevision::$sha1base36 = false
Since
1.17

Definition at line 159 of file WikiRevision.php.

Referenced by setSha1Base36().

◆ $size

int WikiRevision::$size
protected
Since
1.12.2

Definition at line 99 of file WikiRevision.php.

Referenced by setSize().

◆ $src

string null WikiRevision::$src = null
protected
Since
1.12.2

Definition at line 183 of file WikiRevision.php.

Referenced by setFileSrc(), and setSrc().

◆ $tags

string [] WikiRevision::$tags = []
protected
Since
1.34

Definition at line 165 of file WikiRevision.php.

Referenced by setTags().

◆ $text

string WikiRevision::$text = ""
Since
1.2
Deprecated:
since 1.35, use getContent

Definition at line 93 of file WikiRevision.php.

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

◆ $timestamp

string WikiRevision::$timestamp = "20010115000000"
Since
1.2

Definition at line 59 of file WikiRevision.php.

Referenced by getTimestamp().

◆ $title

Title WikiRevision::$title = null
Since
1.2

Definition at line 47 of file WikiRevision.php.

Referenced by getTitle(), and setTitle().

◆ $type

string WikiRevision::$type = ""
Since
1.12.2

Definition at line 135 of file WikiRevision.php.

Referenced by setType().

◆ $user_text

string WikiRevision::$user_text = ""
Since
1.2

Definition at line 65 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 72 of file WikiRevision.php.

Referenced by getUserObj().


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