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 use MediaWiki\MediaWikiServices;
  23
  24 /**
  25  * CommentStoreComment represents a comment stored by CommentStore. The fields
  26  * should be considered read-only.
  27  * @since 1.30
  28  */
  29 class CommentStoreComment {
  30
  31         /** @var int|null Comment ID, if any */
  32         public $id;
  33
  34         /** @var string Text version of the comment */
  35         public $text;
  36
  37         /** @var Message Message version of the comment. Might be a RawMessage */
  38         public $message;
  39
  40         /** @var array|null Structured data of the comment */
  41         public $data;
  42
  43         /**
  44          * @private For use by CommentStore only. Use self::newUnsavedComment() instead.
  45          * @param int|null $id
  46          * @param string $text
  47          * @param Message|null $message
  48          * @param array|null $data
  49          */
  50         public function __construct( $id, $text, Message $message = null, array $data = null ) {
  51                 $this->id = $id;
  52                 $this->text = $text;
  53                 $this->message = $message ?: new RawMessage( '$1', [ Message::plaintextParam( $text ) ] );
  54                 $this->data = $data;
  55         }
  56
  57         /**
  58          * Create a new, unsaved CommentStoreComment
  59          *
  60          * @param string|Message|CommentStoreComment $comment Comment text or Message object.
  61          *  A CommentStoreComment is also accepted here, in which case it is returned unchanged.
  62          * @param array|null $data Structured data to store. Keys beginning with '_' are reserved.
  63          *  Ignored if $comment is a CommentStoreComment.
  64          * @return CommentStoreComment
  65          */
  66         public static function newUnsavedComment( $comment, array $data = null ) {
  67                 if ( $comment instanceof CommentStoreComment ) {
  68                         return $comment;
  69                 }
  70
  71                 if ( $data !== null ) {
  72                         foreach ( $data as $k => $v ) {
  73                                 if ( substr( $k, 0, 1 ) === '_' ) {
  74                                         throw new InvalidArgumentException( 'Keys in $data beginning with "_" are reserved' );
  75                                 }
  76                         }
  77                 }
  78
  79                 if ( $comment instanceof Message ) {
  80                         $message = clone $comment;
  81                         // Avoid $wgForceUIMsgAsContentMsg
  82                         $text = $message->inLanguage( MediaWikiServices::getInstance()->getContentLanguage() )
  83                                 ->setInterfaceMessageFlag( true )
  84                                 ->text();
  85                         return new CommentStoreComment( null, $text, $message, $data );
  86                 } else {
  87                         return new CommentStoreComment( null, $comment, null, $data );
  88                 }
  89         }
  90 }