includes/CommentStoreComment.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 use MediaWiki\MediaWikiServices;
  21
  22 /**
  23  * Value object for a comment stored by CommentStore.
  24  *
  25  * The fields should be considered read-only.
  26  *
  27  * @ingroup CommentStore
  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          * @internal For use by CommentStore only. Use self::newUnsavedComment() instead.
  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', [ Message::plaintextParam( $text ) ] );
  55                 $this->data = $data;
  56         }
  57
  58         /**
  59          * Create a new, unsaved CommentStoreComment
  60          *
  61          * @param string|Message|CommentStoreComment $comment Comment text or Message object.
  62          *  A CommentStoreComment is also accepted here, in which case it is returned unchanged.
  63          * @param array|null $data Structured data to store. Keys beginning with '_' are reserved.
  64          *  Ignored if $comment is a CommentStoreComment.
  65          * @return CommentStoreComment
  66          */
  67         public static function newUnsavedComment( $comment, array $data = null ) {
  68                 if ( $comment instanceof CommentStoreComment ) {
  69                         return $comment;
  70                 }
  71
  72                 if ( $data !== null ) {
  73                         foreach ( $data as $k => $v ) {
  74                                 if ( substr( $k, 0, 1 ) === '_' ) {
  75                                         throw new InvalidArgumentException( 'Keys in $data beginning with "_" are reserved' );
  76                                 }
  77                         }
  78                 }
  79
  80                 if ( $comment instanceof Message ) {
  81                         $message = clone $comment;
  82                         // Avoid $wgForceUIMsgAsContentMsg
  83                         $text = $message->inLanguage( MediaWikiServices::getInstance()->getContentLanguage() )
  84                                 ->setInterfaceMessageFlag( true )
  85                                 ->text();
  86                         return new CommentStoreComment( null, $text, $message, $data );
  87                 } else {
  88                         return new CommentStoreComment( null, $comment, null, $data );
  89                 }
  90         }
  91 }