aboutsummaryrefslogtreecommitdiffstats
path: root/includes/deferred/MessageCacheUpdate.php
blob: a3a7a40f187446338e63d6b81ace338c1e1d31a8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?php
/**
 * Message cache purging and in-place update handler for specific message page changes
 *
 * 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
 */

use MediaWiki\MediaWikiServices;
use Wikimedia\Assert\Assert;

/**
 * Message cache purging and in-place update handler for specific message page changes
 *
 * @ingroup Cache
 * @since 1.32
 */
class MessageCacheUpdate implements DeferrableUpdate, MergeableUpdate {
	/** @var array[] Map of (language code => list of (DB key, DB key without code)) */
	private $replacements = [];

	/**
	 * @param string $code Language code
	 * @param string $title Message cache key with initial uppercase letter
	 * @param string $msg Message cache key with initial uppercase letter and without the code
	 */
	public function __construct( $code, $title, $msg ) {
		$this->replacements[$code][] = [ $title, $msg ];
	}

	public function merge( MergeableUpdate $update ) {
		/** @var self $update */
		Assert::parameterType( __CLASS__, $update, '$update' );
		'@phan-var self $update';

		foreach ( $update->replacements as $code => $messages ) {
			$this->replacements[$code] = array_merge( $this->replacements[$code] ?? [], $messages );
		}
	}

	public function doUpdate() {
		$messageCache = MediaWikiServices::getInstance()->getMessageCache();
		foreach ( $this->replacements as $code => $replacements ) {
			$messageCache->refreshAndReplaceInternal( $code, $replacements );
		}
	}
}