EntityDocumentCache::__construct() - Code Metrics - Inspection of "Merge pull request #16 from ProjetPP/datamodel-4" - ProjetPP/WikibaseEntityStore - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 388143...889690 )

by Thomas

created 2015-12-17 21:03 UTC

EntityDocumentCache::__construct() A

↳ Parent: EntityDocumentCache

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	4
cts	4
cp	1
rs	10
cc	1
eloc	3
nc	1
nop	2
crap	1

<?php

namespace Wikibase\EntityStore\Cache;

use Doctrine\Common\Cache\Cache;
use RuntimeException;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\DataModel\Entity\EntityId;

/**
 * Cache of Entity objects.
 *
 * @licence GPLv2+
 * @author Thomas Pellissier Tanon
 */
class EntityDocumentCache {

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

	/**
	 * @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;
	}

	/**
	 * Returns an Entity from the cache
	 *
	 * @param EntityId $entityId
	 * @return EntityDocument|null
	 */
	public function fetch( EntityId $entityId ) {
		return $this->cache->fetch( $this->getCacheIdFromEntityId( $entityId ) ) ?: null;
	}

	/**
	 * Tests if an Entity exists in the cache.
	 *
	 * @param EntityId $entityId
	 * @return bool
	 */
	public function contains( $entityId ) {
		return $this->cache->contains( $this->getCacheIdFromEntityId( $entityId ) );
	}

	/**
	 * Save an Entity in the cache.
	 *
	 * @param EntityDocument $entity
	 */
	public function save( EntityDocument $entity ) {
		if( !$this->cache->save(
			$this->getCacheIdFromEntityId( $entity->getId() ),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			$entity,
			$this->lifeTime
		) ) {
			throw new RuntimeException( 'The cache failed to save for entity ' . $entity->getId()->getSerialization() );
		}
	}

	private function getCacheIdFromEntityId( EntityId $entityId ) {
		return self::CACHE_ID_PREFIX . WIKIBASE_DATAMODEL_VERSION . '-' . $entityId->getSerialization();
	}
}


1		<?php
2
3		namespace Wikibase\EntityStore\Cache;
4
5		use Doctrine\Common\Cache\Cache;
6		use RuntimeException;
7		use Wikibase\DataModel\Entity\EntityDocument;
8		use Wikibase\DataModel\Entity\EntityId;
9
10		/**
11		* Cache of Entity objects.
12		*
13		* @licence GPLv2+
14		* @author Thomas Pellissier Tanon
15		*/
16		class EntityDocumentCache {
17
18		const CACHE_ID_PREFIX = 'wikibase-store-entity-';
19
20		/**
21		* @var Cache
22		*/
23		private $cache;
24
25		/**
26		* @var int
27		*/
28		private $lifeTime;
29
30		/**
31		* @param Cache $cache
32		* @param int $lifeTime
33		*/
34	5	public function __construct( Cache $cache, $lifeTime = 0 ) {
35	5	$this->cache = $cache;
36	5	$this->lifeTime = $lifeTime;
37	5	}
38
39		/**
40		* Returns an Entity from the cache
41		*
42		* @param EntityId $entityId
43		* @return EntityDocument\|null
44		*/
45	3	public function fetch( EntityId $entityId ) {
46	3	return $this->cache->fetch( $this->getCacheIdFromEntityId( $entityId ) ) ?: null;
47		}
48
49		/**
50		* Tests if an Entity exists in the cache.
51		*
52		* @param EntityId $entityId
53		* @return bool
54		*/
55	2	public function contains( $entityId ) {
56	2	return $this->cache->contains( $this->getCacheIdFromEntityId( $entityId ) );
57		}
58
59		/**
60		* Save an Entity in the cache.
61		*
62		* @param EntityDocument $entity
63		*/
64	3	public function save( EntityDocument $entity ) {
65	3	if( !$this->cache->save(
66	3	$this->getCacheIdFromEntityId( $entity->getId() ),
		0 ignored issues – show Bug introduced 2015-12-16 10:04 UTC by Report Bug Copy Issue Report It seems like `$entity->getId()` can be `null`; however, `getCacheIdFromEntityId()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
67	3	$entity,
68	3	$this->lifeTime
69	3	) ) {
70		throw new RuntimeException( 'The cache failed to save for entity ' . $entity->getId()->getSerialization() );
71		}
72	3	}
73
74	5	private function getCacheIdFromEntityId( EntityId $entityId ) {
75	5	return self::CACHE_ID_PREFIX . WIKIBASE_DATAMODEL_VERSION . '-' . $entityId->getSerialization();
76		}
77		}
78

ProjetPP / WikibaseEntityStore

Push — master ( 388143...889690 )

EntityDocumentCache::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like