Onoi\Cache\MediaWikiCache

Complexity

Total Complexity

11

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

93.75%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	contains()	0	10	4
A	save()	0	5	1
A	delete()	0	5	1
A	getStats()	0	8	1
A	getName()	0	3	1
A	fetch()	0	10	2

<?php

namespace Onoi\Cache;

use BagOStuff;

/**
 * MediaWiki BagOStuff decorator
 *
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class MediaWikiCache implements Cache {

	/**
	 * @var BagOStuff
	 */
	private $cache = null;

	/**
	 * @note MediaWiki's BagOStuff doesn't know any has/contains function therefore
	 * we need to use an internal array the fetch and temporarily store the results
	 * to ensure no expensive lookups occur for the same key
	 *
	 * @var array
	 */
	private $inMemoryCache = array();

	/**
	 * @var integer
	 */
	private $cacheInserts = 0;

	/**
	 * @var integer
	 */
	private $cacheDeletes = 0;

	/**
	 * @var integer
	 */
	private $cacheHits = 0;

	/**
	 * @var integer
	 */
	private $cacheMisses = 0;

	/**
	 * @since 1.0
	 *
	 * @param BagOStuff $cache
	 */
	public function __construct( BagOStuff $cache ) {
		$this->cache = $cache;
	}

	/**
	 * @since 1.0
	 *
	 * {@inheritDoc}
	 */
	public function fetch( $id ) {

		if ( $this->contains( $id ) ) {
			$this->cacheHits++;
			return $this->inMemoryCache[ $id ];
		}

		$this->cacheMisses++;
		return false;
	}

	/**
	 * @since 1.0
	 *
	 * {@inheritDoc}
	 */
	public function contains( $id ) {

		if ( isset ( $this->inMemoryCache[ $id ] ) || array_key_exists( $id, $this->inMemoryCache ) ) {
			return true;
		}

		$this->inMemoryCache[ $id ] = $this->cache->get( $id );

		return !$this->inMemoryCache[ $id ] ? false : true;
	}

	/**
	 * @since 1.0
	 *
	 * {@inheritDoc}
	 */
	public function save( $id, $data, $ttl = 0 ) {
		$this->cacheInserts++;
		$this->cache->set( $id, $data, $ttl );
		unset( $this->inMemoryCache[ $id ] );
	}

	/**
	 * @since 1.0
	 *
	 * {@inheritDoc}
	 */
	public function delete( $id ) {
		$this->cacheDeletes++;
		$this->cache->delete( $id );
		unset( $this->inMemoryCache[ $id ] );
	}

	/**
	 * @since 1.0
	 *
	 * {@inheritDoc}
	 */
	public function getStats() {
		return array(
			'inserts' => $this->cacheInserts,
			'deletes' => $this->cacheDeletes,
			'hits'    => $this->cacheHits,
			'misses'  => $this->cacheMisses
		);
	}

	/**
	 * @since  1.2
	 *
	 * {@inheritDoc}
	 */
	public function getName() {
		return __CLASS__ . '::' . get_class( $this->cache );
	}

}