SESP\Cache\MessageCache

Complexity

Total Complexity

25

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

98.41%

Importance

Changes	4
Bugs	1	Features	1

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setLanguage()	0	3	1
A	inUserLanguage()	0	4	1
A	clear()	0	3	1
A	purge()	0	4	1
A	setCacheTimeOffset()	0	4	1
A	setCache()	0	4	1
A	getCacheId()	0	3	1
A	get()	0	16	3
A	getTextMessage()	0	7	1
A	updateMessagesToCache()	0	9	1
A	fetchMessagesFromCache()	0	10	4
A	getCache()	0	8	2
A	getCachePrefix()	0	3	2
A	getTouched()	0	8	2
A	getMessageFileModificationTime()	0	8	2

<?php

namespace SESP\Cache;

use ObjectCache;
use Language;
use BagOStuff;

/**
 * @ingroup SESP
 *
 * @licence GNU GPL v2+
 * @since 1.2.0
 *
 * @author mwjames
 */
class MessageCache {

	/** @var MessageCache[] */
	private static $instance = array();

	/** @var Language */
	protected $language = null;

	protected $touched = null;
	protected $cacheTimeOffset = null;
	protected $messages = null;
	protected $cache = null;

	/**
	 * @since 1.2.0
	 *
	 * @param Language|null $language
	 * @param integer|null $cacheTimeOffset
	 */
	public function __construct( Language $language = null, $cacheTimeOffset = null ) {
		$this->language = $language;
		$this->cacheTimeOffset = $cacheTimeOffset;
	}

	/**
	 * @since 1.4
	 *
	 * @param Language $language
	 */
	public function setLanguage( Language $language ) {
		$this->language = $language;
	}

	/**
	 * @since 1.4
	 *
	 * @return MessageCache
	 */
	public function inUserLanguage() {
		$this->language = $GLOBALS['wgLang'];
		return $this;
	}

	/**
	 * @since 1.2.0
	 */
	public static function clear() {
		self::$instance = array();
	}

	/**
	 * @since 1.2.0
	 *
	 * MessageCache::ByLanguage( Language::factory( 'en' ) )->purge()
	 *
	 * @return MessageCache
	 */
	public function purge() {
		$this->getCache()->delete( $this->getCacheId() );
		return $this;
	}

	/**
	 * @since 1.2.0
	 *
	 * @param integer $cacheTimeOffset
	 *
	 * @return MessageCache
	 */
	public function setCacheTimeOffset( $cacheTimeOffset ) {
		$this->cacheTimeOffset = $cacheTimeOffset;
		return $this;
	}

	/**
	 * @since 1.2.0
	 *
	 * @param BagOStuff $cache
	 */
	public function setCache( BagOStuff $cache ) {
		$this->cache = $cache;
		return $this;
	}

	/**
	 * @since 1.2.0
	 *
	 * @return string
	 */
	public function getCacheId() {
		return $this->getCachePrefix() . ':sesp:mcache:' . $this->language->getCode();
	}

	/**
	 * @since 1.2.0
	 *
	 * @param string $key
	 *
	 * @return string
	 */
	public function get( $key /* arguments */ ) {

The parameter $key is not used and could be removed.

		$arguments = func_get_args();

		if ( $this->messages === null ) {
			$this->messages = $this->fetchMessagesFromCache();
		}

		$key = implode( '#', $arguments );

		if ( isset( $this->messages[ $key ] ) ) {
			return $this->messages[ $key ];
		}

		return $this->getTextMessage( $key, $arguments );
	}

	protected function getTextMessage( $key, $arguments ) {

		$this->messages[ $key ] = wfMessage( $arguments )->inLanguage( $this->language )->text();
		$this->updateMessagesToCache();

		return $this->messages[ $key ];
	}

	protected function updateMessagesToCache() {

		$messagesToBeCached = array(
			'touched'  => $this->getTouched(),
			'messages' => $this->messages
		);

		return $this->getCache()->set( $this->getCacheId(), $messagesToBeCached );
	}

	protected function fetchMessagesFromCache() {

		$cached = $this->getCache()->get( $this->getCacheId() );

		if ( isset( $cached['touched'] ) && isset( $cached['messages'] ) && $cached['touched'] === $this->getTouched() ) {
			return $cached['messages'];
		}

		return null;
	}

	protected function getCache() {

		if ( !$this->cache instanceOf BagOStuff ) {

The class BagOStuff does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json?

			$this->cache = ObjectCache::getInstance( $GLOBALS['sespCacheType'] );
		}

		return $this->cache;
	}

	protected function getCachePrefix() {
		return $GLOBALS['wgCachePrefix'] === false ? wfWikiID() : $GLOBALS['wgCachePrefix'];
	}

	protected function getTouched() {

		if ( $this->touched === null ) {
			$this->touched = $this->getMessageFileModificationTime() . $this->cacheTimeOffset;
		}

		return $this->touched;
	}

	protected function getMessageFileModificationTime() {

		if ( method_exists( $this->language, 'getJsonMessagesFileName' )  ) {
			return filemtime( $this->language->getJsonMessagesFileName( $this->language->getCode() ) );
		}

		return filemtime( $this->language->getMessagesFileName( $this->language->getCode() ) );
	}

}