CommentStoreComment.php

Go to the documentation of this file.

<?php
namespace MediaWiki\CommentStore;
 
use InvalidArgumentException;
use MediaWiki\Language\RawMessage;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
 
class CommentStoreComment {
 
    public $id;
 
    public $text;
 
    public $message;
 
    public $data;
 
    public function __construct( $id, string $text, ?Message $message = null, ?array $data = null ) {
        $this->id = (int)$id;
        $this->text = $text;
        $this->message = $message
            ?: new RawMessage(
                '$1',
                [ Message::plaintextParam( $this->text ) ]
            );
        $this->data = $data;
    }
 
    public static function newUnsavedComment( $comment, ?array $data = null ) {
        if ( $comment instanceof CommentStoreComment ) {
            return $comment;
        }
 
        if ( $data !== null ) {
            foreach ( $data as $k => $v ) {
                if ( str_starts_with( $k, '_' ) ) {
                    throw new InvalidArgumentException( 'Keys in $data beginning with "_" are reserved' );
                }
            }
        }
 
        if ( $comment instanceof Message ) {
            $message = clone $comment;
            // Avoid $wgForceUIMsgAsContentMsg
            $text = $message->inLanguage( MediaWikiServices::getInstance()->getContentLanguage() )
                ->setInterfaceMessageFlag( true )
                ->text();
            return new CommentStoreComment( null, $text, $message, $data );
        } else {
            return new CommentStoreComment( null, $comment, null, $data );
        }
    }
}
 
// This alias can not be removed, because serialized instances of this class are stored in Echo
// tables, until we either migrate to JSON serialization (T325703) or expire those events (T383948).
class_alias( CommentStoreComment::class, 'CommentStoreComment' );