MediaWiki  master
CommentStoreComment Class Reference

CommentStoreComment represents a comment stored by CommentStore. More...

Collaboration diagram for CommentStoreComment:

Public Member Functions

 __construct ( $id, $text, Message $message=null, array $data=null)
 

Static Public Member Functions

static newUnsavedComment ( $comment, array $data=null)
 Create a new, unsaved CommentStoreComment. More...
 

Public Attributes

array null $data
 Structured data of the comment. More...
 
int null $id
 Comment ID, if any. More...
 
Message $message
 Message version of the comment. More...
 
string $text
 Text version of the comment. More...
 

Detailed Description

CommentStoreComment represents a comment stored by CommentStore.

The fields should be considered read-only.

Since
1.30

Definition at line 29 of file CommentStoreComment.php.

Constructor & Destructor Documentation

◆ __construct()

CommentStoreComment::__construct (   $id,
  $text,
Message  $message = null,
array  $data = null 
)
Access:
private For use by CommentStore only. Use self::newUnsavedComment() instead.
Parameters
int | null$id
string$text
Message | null$message
array | null$data

Definition at line 50 of file CommentStoreComment.php.

References $data, $id, $text, data, message, Message\plaintextParam(), and text.

Member Function Documentation

◆ newUnsavedComment()

static CommentStoreComment::newUnsavedComment (   $comment,
array  $data = null 
)
static

Create a new, unsaved CommentStoreComment.

Parameters
string | Message | CommentStoreComment$commentComment text or Message object. A CommentStoreComment is also accepted here, in which case it is returned unchanged.
array | null$dataStructured data to store. Keys beginning with '_' are reserved. Ignored if $comment is a CommentStoreComment.
Returns
CommentStoreComment

Definition at line 66 of file CommentStoreComment.php.

References as, Message\inLanguage(), and null.

Referenced by WikiPage\commitRollback(), CommentStore\createComment(), RefreshLinksJobTest\createPage(), WikiPageDbTestBase\createPage(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\createRevision(), MediaWiki\Tests\Storage\PageUpdaterTest\createRevision(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\createRevisionStoreCacheRecord(), WikiPage\doEditContent(), ApiQueryWatchlistIntegrationTest\doPatrolledPageEdit(), EditCLI\execute(), ArticleViewTest\getPage(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\getRandomCommentStoreComment(), MediaWiki\Storage\PageUpdater\makeAutoSummary(), PopulateArchiveRevId\makeDummyRevisionRow(), UserTest\makeEdit(), MediaWiki\Tests\Revision\makeHasSameContentTestRecord(), PoolWorkArticleViewTest\makeRevision(), MediaWiki\Tests\Storage\DerivedPageDataUpdaterTest\makeRevision(), Revision\RevisionStore\newMutableRevisionFromArray(), Revision\newNullRevision(), MediaWiki\Tests\Revision\RevisionStoreCacheRecordTest\newRevision(), MediaWiki\Tests\Revision\RevisionArchiveRecordTest\newRevision(), MediaWiki\Tests\Revision\RevisionStoreRecordTest\newRevision(), MediaWiki\Tests\Revision\MutableRevisionRecordTest\newRevision(), McrUndoAction\onSubmit(), MediaWiki\Tests\Revision\RevisionStoreRecordTest\provideConstructor(), MediaWiki\Tests\Revision\RevisionArchiveRecordTest\provideConstructor(), MediaWiki\Tests\Revision\RevisionArchiveRecordTest\provideConstructorFailure(), MediaWiki\Tests\Revision\RevisionStoreRecordTest\provideConstructorFailure(), MediaWiki\Tests\Revision\McrRevisionStoreDbTest\provideNewNullRevision(), MediaWiki\Tests\Revision\McrReadNewRevisionStoreDbTest\provideNewNullRevision(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\provideNewNullRevision(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\provideNonHistoryRevision(), MediaWiki\Tests\Storage\PageUpdaterTest\testCompareAndSwapFailure(), MediaWiki\Tests\Storage\PageUpdaterTest\testCreatePage(), MediaWiki\Tests\Storage\PageUpdaterTest\testFailureOnBadContentModel(), MediaWiki\Tests\Storage\PageUpdaterTest\testFailureOnEditFlags(), LinkerTest\testGenerateRollback(), MediaWiki\Tests\Revision\RevisionRendererTest\testGetRenderedRevision_current(), MediaWiki\Tests\Revision\RevisionRendererTest\testGetRenderedRevision_known(), MediaWiki\Tests\Revision\RevisionRendererTest\testGetRenderedRevision_master(), MediaWiki\Tests\Revision\RevisionRendererTest\testGetRenderedRevision_multi(), MediaWiki\Tests\Revision\RevisionRendererTest\testGetRenderedRevision_new(), MediaWiki\Tests\Revision\RevisionRendererTest\testGetRenderedRevision_old(), MediaWiki\Tests\Revision\RevisionRendererTest\testGetRenderedRevision_privileged(), MediaWiki\Tests\Revision\RevisionRendererTest\testGetRenderedRevision_raw(), MediaWiki\Tests\Revision\RevisionRendererTest\testGetRenderedRevision_suppressed(), MediaWiki\Tests\Storage\PageUpdaterTest\testInheritSlot(), MediaWiki\Tests\Revision\McrRevisionStoreDbTest\testInsertRevisionOn_T202032(), MediaWiki\Tests\Storage\PageUpdaterTest\testMagicWords(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testNewNullRevision(), MediaWiki\Tests\Revision\RevisionStoreDbTestBase\testNewNullRevision_nonExistingTitle(), MediaWiki\Tests\Storage\PageUpdaterTest\testSetRcPatrolStatus(), MediaWiki\Tests\Storage\PageUpdaterTest\testSetUseAutomaticEditSummaries(), MediaWiki\Tests\Storage\PageUpdaterTest\testSetUsePageCreationLog(), and MediaWiki\Tests\Storage\PageUpdaterTest\testUpdatePage().

Member Data Documentation

◆ $data

array null CommentStoreComment::$data

Structured data of the comment.

Definition at line 41 of file CommentStoreComment.php.

Referenced by __construct().

◆ $id

int null CommentStoreComment::$id

Comment ID, if any.

Definition at line 32 of file CommentStoreComment.php.

Referenced by __construct().

◆ $message

Message CommentStoreComment::$message

Message version of the comment.

Might be a RawMessage

Definition at line 38 of file CommentStoreComment.php.

◆ $text

string CommentStoreComment::$text

Text version of the comment.

Definition at line 35 of file CommentStoreComment.php.

Referenced by __construct().


The documentation for this class was generated from the following file: