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, $text, Message $message = null, array $data = null ) {
        if ( $text === null ) {
            // TODO: Turn this warning into a proper type hint once we have
            // found and fixed any offenders (T355751).
            wfLogWarning( 'Comment text should not be null!' );
            $text = '';
        }
 
        $this->id = (int)$id;
        $this->text = (string)$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 ( substr( $k, 0, 1 ) === '_' ) {
                    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 );
        }
    }
}
 
class_alias( CommentStoreComment::class, 'CommentStoreComment' );