LabelFetcher::setLabelCacheVersion() - Code Metrics - Inspection of "Add LabelFetcher with cache layer" - SemanticMediaWiki/SemanticExtraSpecialProperties - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#85)

by mw

created 2017-06-10 09:14 UTC

LabelFetcher::setLabelCacheVersion() A

↳ Parent: LabelFetcher

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace SESP;

use Onoi\Cache\Cache;
use Onoi\Cache\NullCache;
use SMW\Message;

/**
 * @ingroup SESP
 *
 * @license GNU GPL v2+
 * @since 2.0
 *
 * @author mwjames
 */
class LabelFetcher {

	/**
	 * Namespace of the cache instance
	 */
	const LABEL_CACHE_NAMESPACE = 'sesp:labels';

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

	/**
	 * @var string
	 */
	private $languageCode = 'en';

	/**
	 * @var string
	 */
	private $labelCacheVersion = 0;

	/**
	 * @since 2.0
	 *
	 * @param Cache|null $cache
	 * @param string $languageCode
	 */
	public function __construct( Cache $cache = null, $languageCode = 'en' ) {
		$this->cache = $cache;
		$this->languageCode = $languageCode;

		if ( $this->cache === null ) {
			$this->cache = new NullCache();
		}
	}

	/**
	 * @since 2.0
	 *
	 * @param integer|string $labelCacheVersion
	 */
	public function setLabelCacheVersion( $labelCacheVersion ) {
		$this->labelCacheVersion = $labelCacheVersion;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
	}

	/**
	 * @since 2.0
	 *
	 * @param string $key
	 *
	 * @return string
	 */
	public function getLabel( $key ) {
		return Message::get( $key, null, Message::USER_LANGUAGE );
	}

	/**
	 * @since 2.0
	 *
	 * @param PropertyDefinitions $propertyDefinitions
	 *
	 * @return array
	 */
	public function getLabelsFrom( PropertyDefinitions $propertyDefinitions ) {

		$hash = smwfCacheKey(
			self::LABEL_CACHE_NAMESPACE,
			array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				$propertyDefinitions,
				$this->languageCode,
				$this->labelCacheVersion
			)
		);

		if ( $this->labelCacheVersion !== false && ( $labels = $this->cache->fetch( $hash ) ) !== false ) {
			return $labels;
		}

		$labels = array();
		$exifDefinitions = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		foreach ( $propertyDefinitions as $key => $definition ) {
			$this->matchLabel( $labels, $definition );
		}

		foreach ( $propertyDefinitions->safeGet( '_EXIF', array() ) as $key => $definition ) {
			$this->matchLabel( $labels, $definition );
		}

		if ( $labels !== array() ) {
			$this->cache->save( $hash, $labels, 3600 * 24 );
		}

		return $labels;
	}

	private function matchLabel( &$labels, $definition ) {

		if ( !isset( $definition['id'] ) ) {
			return;
		}

		$alias = 'sesp-property-unknown-label';

		if ( isset( $definition['alias'] ) ) {
			$alias = $definition['alias'];
		}

		$labels[$definition['id']] = Message::get( $alias, null, $this->languageCode );
	}

}


1		<?php
2
3		namespace SESP;
4
5		use Onoi\Cache\Cache;
6		use Onoi\Cache\NullCache;
7		use SMW\Message;
8
9		/**
10		* @ingroup SESP
11		*
12		* @license GNU GPL v2+
13		* @since 2.0
14		*
15		* @author mwjames
16		*/
17		class LabelFetcher {
18
19		/**
20		* Namespace of the cache instance
21		*/
22		const LABEL_CACHE_NAMESPACE = 'sesp:labels';
23
24		/**
25		* @var Cache
26		*/
27		private $cache;
28
29		/**
30		* @var string
31		*/
32		private $languageCode = 'en';
33
34		/**
35		* @var string
36		*/
37		private $labelCacheVersion = 0;
38
39		/**
40		* @since 2.0
41		*
42		* @param Cache\|null $cache
43		* @param string $languageCode
44		*/
45	5	public function __construct( Cache $cache = null, $languageCode = 'en' ) {
46	5	$this->cache = $cache;
47	5	$this->languageCode = $languageCode;
48
49	5	if ( $this->cache === null ) {
50		$this->cache = new NullCache();
51		}
52	5	}
53
54		/**
55		* @since 2.0
56		*
57		* @param integer\|string $labelCacheVersion
58		*/
59	1	public function setLabelCacheVersion( $labelCacheVersion ) {
60	1	$this->labelCacheVersion = $labelCacheVersion;
		0 ignored issues – show Documentation Bug introduced 2017-06-10 09:12 UTC by Report Bug Copy Issue Report It seems like `$labelCacheVersion` can also be of type `integer`. However, the property `$labelCacheVersion` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
61	1	}
62
63		/**
64		* @since 2.0
65		*
66		* @param string $key
67		*
68		* @return string
69		*/
70	1	public function getLabel( $key ) {
71	1	return Message::get( $key, null, Message::USER_LANGUAGE );
72		}
73
74		/**
75		* @since 2.0
76		*
77		* @param PropertyDefinitions $propertyDefinitions
78		*
79		* @return array
80		*/
81	3	public function getLabelsFrom( PropertyDefinitions $propertyDefinitions ) {
82
83	3	$hash = smwfCacheKey(
84	3	self::LABEL_CACHE_NAMESPACE,
85		array(
		0 ignored issues – show Documentation introduced 2017-06-10 09:12 UTC by Report Bug Copy Issue Report `array($propertyDefinitio...his->labelCacheVersion)` is of type `array<integer,object<SES..."string","2":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
86	3	$propertyDefinitions,
87	3	$this->languageCode,
88	3	$this->labelCacheVersion
89	3	)
90	3	);
91
92	3	if ( $this->labelCacheVersion !== false && ( $labels = $this->cache->fetch( $hash ) ) !== false ) {
93	2	return $labels;
94		}
95
96	1	$labels = array();
97	1	$exifDefinitions = array();
		0 ignored issues – show Unused Code introduced 2017-06-10 09:12 UTC by Report Bug Copy Issue Report `$exifDefinitions` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
98
99	1	foreach ( $propertyDefinitions as $key => $definition ) {
100	1	$this->matchLabel( $labels, $definition );
101	1	}
102
103	1	foreach ( $propertyDefinitions->safeGet( '_EXIF', array() ) as $key => $definition ) {
104	1	$this->matchLabel( $labels, $definition );
105	1	}
106
107	1	if ( $labels !== array() ) {
108	1	$this->cache->save( $hash, $labels, 3600 * 24 );
109	1	}
110
111	1	return $labels;
112		}
113
114	1	private function matchLabel( &$labels, $definition ) {
115
116	1	if ( !isset( $definition['id'] ) ) {
117	1	return;
118		}
119
120	1	$alias = 'sesp-property-unknown-label';
121
122	1	if ( isset( $definition['alias'] ) ) {
123	1	$alias = $definition['alias'];
124	1	}
125
126	1	$labels[$definition['id']] = Message::get( $alias, null, $this->languageCode );
127	1	}
128
129		}
130

SemanticMediaWiki / SemanticExtraSpecialProperties

Pull Request — master (#85)

LabelFetcher::setLabelCacheVersion() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like