Wikibase\EntityStore\Cache\EntityIdForQueryCache

Complexity

Total Complexity

8

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

96.15%

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	contains()	0	3	1
A	fetch()	0	9	2
A	save()	0	9	2
A	getCacheId()	0	10	2

<?php

namespace Wikibase\EntityStore\Cache;

use Ask\Language\Description\Description;
use Ask\Language\Option\QueryOptions;
use Doctrine\Common\Cache\Cache;
use OutOfBoundsException;
use RuntimeException;
use Wikibase\DataModel\Entity\EntityId;

/**
 * @licence GPLv2+
 * @author Thomas Pellissier Tanon
 */
class EntityIdForQueryCache {

	const CACHE_ID_PREFIX = 'wikibase-store-entityforquery-';

	const CACHE_LIFE_TIME = 86400;

	/**
	 * @var Cache
	 */
	private $cache;

	/**
	 * @var int
	 */
	private $lifeTime;

	/**
	 * @param Cache $cache
	 * @param int $lifeTime
	 */
	public function __construct( Cache $cache, $lifeTime = 0 ) {
		$this->cache = $cache;
		$this->lifeTime = $lifeTime;
	}

	/**
	 * @param Description $description
	 * @param QueryOptions $queryOptions
	 * @param string $entityType
	 * @return EntityId[]
	 */
	public function fetch( Description $description, QueryOptions $queryOptions = null, $entityType ) {
		$result = $this->cache->fetch( $this->getCacheId( $description, $queryOptions, $entityType ) );

		if( $result === false ) {
			throw new OutOfBoundsException( 'The search is not in the cache.' );
		}

		return $result;
	}

	/**
	 * @param Description $description
	 * @param QueryOptions $queryOptions
	 * @param string $entityType
	 * @return boolean
	 */
	public function contains( Description $description, QueryOptions $queryOptions = null, $entityType ) {
		return $this->cache->contains( $this->getCacheId( $description, $queryOptions, $entityType ) );
	}

	/**
	 * @param Description $description
	 * @param QueryOptions $queryOptions
	 * @param string $entityType
	 * @param EntityId[] $entityIds
	 */
	public function save( Description $description, QueryOptions $queryOptions = null, $entityType, array $entityIds ) {
		if( !$this->cache->save(
			$this->getCacheId( $description, $queryOptions, $entityType ),
			$entityIds,
			$this->lifeTime
		) ) {
			throw new RuntimeException( 'The cache failed to save.' );
		}
	}

	private function getCacheId( Description $description, QueryOptions $queryOptions = null, $entityType ) {
		$key = self::CACHE_ID_PREFIX . WIKIBASE_DATAMODEL_VERSION . '-' .
			$entityType . '-' . $description->getHash();

		if( $queryOptions !== null ) {
			$key .= '-' . $queryOptions->getOffset() . '-' . $queryOptions->getLimit();
		}

		return $key;
	}
}