MediaWiki  master
MediaWiki\Edit\PreparedEdit Class Reference

Represents information returned by WikiPage::prepareContentForEdit() More...

Collaboration diagram for MediaWiki\Edit\PreparedEdit:

Public Member Functions

 __get ( $name)
 Fetch the ParserOutput via a lazy-loaded callback (for backwards compatibility). More...
 
 getOutput ()
 

Public Attributes

string $format
 Content format. More...
 
Content $newContent
 Content that is being saved (before PST) More...
 
Content null $oldContent
 Current content of the page, if any. More...
 
callable $parserOutputCallback
 Lazy-loading callback to get canonical ParserOutput object. More...
 
ParserOptions $popts
 Parser options used to get parser output. More...
 
Content null $pstContent
 Content after going through pre-save transform. More...
 
int null $revid
 Revision ID. More...
 
string $timestamp
 Time this prepared edit was made. More...
 

Private Attributes

ParserOutput null $canonicalOutput
 Parser output. More...
 

Detailed Description

Represents information returned by WikiPage::prepareContentForEdit()

Deprecated:
since 1.32, use DerivedPageDataUpdater instead.
Since
1.30

Definition at line 35 of file PreparedEdit.php.

Member Function Documentation

◆ __get()

MediaWiki\Edit\PreparedEdit::__get (   $name)

Fetch the ParserOutput via a lazy-loaded callback (for backwards compatibility).

Deprecated:
since 1.33
Parameters
string$name
Returns
mixed

Definition at line 117 of file PreparedEdit.php.

References $name, and MediaWiki\Edit\PreparedEdit\getOutput().

◆ getOutput()

MediaWiki\Edit\PreparedEdit::getOutput ( )
Returns
ParserOutput Canonical parser output

Definition at line 102 of file PreparedEdit.php.

References MediaWiki\Edit\PreparedEdit\$canonicalOutput.

Referenced by MediaWiki\Edit\PreparedEdit\__get().

Member Data Documentation

◆ $canonicalOutput

ParserOutput null MediaWiki\Edit\PreparedEdit::$canonicalOutput
private

Parser output.

Definition at line 76 of file PreparedEdit.php.

Referenced by MediaWiki\Edit\PreparedEdit\getOutput().

◆ $format

string MediaWiki\Edit\PreparedEdit::$format

Content format.

Definition at line 62 of file PreparedEdit.php.

◆ $newContent

Content MediaWiki\Edit\PreparedEdit::$newContent

Content that is being saved (before PST)

Definition at line 83 of file PreparedEdit.php.

◆ $oldContent

Content null MediaWiki\Edit\PreparedEdit::$oldContent

Current content of the page, if any.

Definition at line 90 of file PreparedEdit.php.

◆ $parserOutputCallback

callable MediaWiki\Edit\PreparedEdit::$parserOutputCallback

Lazy-loading callback to get canonical ParserOutput object.

Definition at line 97 of file PreparedEdit.php.

◆ $popts

ParserOptions MediaWiki\Edit\PreparedEdit::$popts

Parser options used to get parser output.

Definition at line 69 of file PreparedEdit.php.

◆ $pstContent

Content null MediaWiki\Edit\PreparedEdit::$pstContent

Content after going through pre-save transform.

Definition at line 55 of file PreparedEdit.php.

◆ $revid

int null MediaWiki\Edit\PreparedEdit::$revid

Revision ID.

Definition at line 48 of file PreparedEdit.php.

◆ $timestamp

string MediaWiki\Edit\PreparedEdit::$timestamp

Time this prepared edit was made.

Definition at line 41 of file PreparedEdit.php.


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