f6bd18d6c2
so that extensions (i.e. CheckUser) can implement their own comment store without having a lot of code duplication basically the comment store version of I3a6486532f2ef36 Bug: T233004 Change-Id: Ib40f99e00a514d41776ce521baf113e46d37e9cd
87 lines
2.8 KiB
PHP
87 lines
2.8 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\CommentStore;
|
|
|
|
use Language;
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
/**
|
|
* @defgroup CommentStore CommentStore
|
|
*
|
|
* The Comment store in MediaWiki is responsible for storing edit summaries,
|
|
* log action comments and other such short strings (referred to as "comments").
|
|
*
|
|
* The CommentStore class handles the database abstraction for reading
|
|
* and writing comments, which are represented by CommentStoreComment objects.
|
|
*
|
|
* Data is internally stored in the `comment` table.
|
|
*/
|
|
|
|
/**
|
|
* Handle database storage of comments such as edit summaries and log reasons.
|
|
*
|
|
* @ingroup CommentStore
|
|
* @since 1.30
|
|
*/
|
|
class CommentStore extends CommentStoreBase {
|
|
/**
|
|
* Define fields that use temporary tables for transitional purposes
|
|
* Array keys are field names, values are arrays with these possible fields:
|
|
* - table: Temporary table name
|
|
* - pk: Temporary table column referring to the main table's primary key
|
|
* - field: Temporary table column referring comment.comment_id
|
|
* - joinPK: Main table's primary key
|
|
* - stage: Migration stage
|
|
* - deprecatedIn: Version when using insertWithTempTable() was deprecated
|
|
*/
|
|
protected const TEMP_TABLES = [
|
|
'rev_comment' => [
|
|
'table' => 'revision_comment_temp',
|
|
'pk' => 'revcomment_rev',
|
|
'field' => 'revcomment_comment_id',
|
|
'joinPK' => 'rev_id',
|
|
'stage' => MIGRATION_OLD,
|
|
'deprecatedIn' => null,
|
|
],
|
|
];
|
|
|
|
/**
|
|
* @param Language $lang Language to use for comment truncation. Defaults
|
|
* to content language.
|
|
* @param int $stage One of the MIGRATION_* constants, or an appropriate
|
|
* combination of SCHEMA_COMPAT_* constants. Always MIGRATION_NEW for
|
|
* MediaWiki core since 1.33.
|
|
*/
|
|
public function __construct( Language $lang, $stage ) {
|
|
parent::__construct( self::TEMP_TABLES, $lang, $stage );
|
|
}
|
|
|
|
/**
|
|
* @since 1.31
|
|
* @deprecated in 1.31 Use DI to inject a CommentStore instance into your class.
|
|
* @return CommentStore
|
|
*/
|
|
public static function getStore() {
|
|
return MediaWikiServices::getInstance()->getCommentStore();
|
|
}
|
|
}
|
|
|
|
class_alias( CommentStore::class, 'CommentStore' );
|