includes/edit/PreparedEdit.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 namespace MediaWiki\Edit;
  22
  23 use Content;
  24 use ParserOptions;
  25 use ParserOutput;
  26
  27 /**
  28  * Represents information returned by WikiPage::prepareContentForEdit()
  29  *
  30  * @since 1.30
  31  */
  32 class PreparedEdit {
  33
  34         /**
  35          * Time this prepared edit was made
  36          *
  37          * @var string
  38          */
  39         public $timestamp;
  40
  41         /**
  42          * Revision ID
  43          *
  44          * @var int|null
  45          */
  46         public $revid;
  47
  48         /**
  49          * Content after going through pre-save transform
  50          *
  51          * @var Content|null
  52          */
  53         public $pstContent;
  54
  55         /**
  56          * Content format
  57          *
  58          * @var string
  59          */
  60         public $format;
  61
  62         /**
  63          * Parser options used to get parser output
  64          *
  65          * @var ParserOptions
  66          */
  67         public $popts;
  68
  69         /**
  70          * Parser output
  71          *
  72          * @var ParserOutput|null
  73          */
  74         public $output;
  75
  76         /**
  77          * Content that is being saved (before PST)
  78          *
  79          * @var Content
  80          */
  81         public $newContent;
  82
  83         /**
  84          * Current content of the page, if any
  85          *
  86          * @var Content|null
  87          */
  88         public $oldContent;
  89
  90         /**
  91          * $newContent in text form
  92          *
  93          * @var string
  94          * @deprecated since 1.21
  95          */
  96         public $newText;
  97
  98         /**
  99          * $oldContent in text from
 100          *
 101          * @var string
 102          * @deprecated since 1.21
 103          */
 104         public $oldText;
 105
 106         /**
 107          * $pstContent in text form
 108          *
 109          * @var string
 110          * @deprecated since 1.21
 111          */
 112         public $pst;
 113 }