includes/CommentStoreComment.php

   1 <?php
   2 /**
   3  * Value object for CommentStore
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 use Wikimedia\Rdbms\IDatabase;
  24
  25 /**
  26  * CommentStoreComment represents a comment stored by CommentStore. The fields
  27  * should be considered read-only.
  28  * @since 1.30
  29  */
  30 class CommentStoreComment {
  31
  32         /** @var int|null Comment ID, if any */
  33         public $id;
  34
  35         /** @var string Text version of the comment */
  36         public $text;
  37
  38         /** @var Message Message version of the comment. Might be a RawMessage */
  39         public $message;
  40
  41         /** @var array|null Structured data of the comment */
  42         public $data;
  43
  44         /**
  45          * @private For use by CommentStore only
  46          * @param int|null $id
  47          * @param string $text
  48          * @param Message|null $message
  49          * @param array|null $data
  50          */
  51         public function __construct( $id, $text, Message $message = null, array $data = null ) {
  52                 $this->id = $id;
  53                 $this->text = $text;
  54                 $this->message = $message ?: new RawMessage( '$1', [ $text ] );
  55                 $this->data = $data;
  56         }
  57 }