PageViewsPropertyAnnotator::addAnnotation() - Code Metrics - Inspection of "2.0 refactoring" - SemanticMediaWiki/SemanticExtraSpecialProperties - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#75)

by mw

created 2017-06-04 11:00 UTC

PageViewsPropertyAnnotator::addAnnotation() A

↳ Parent: PageViewsPropertyAnnotator

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes

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

<?php

namespace SESP\PropertyAnnotators;

use SMW\DIProperty;
use SMW\SemanticData;
use SMWDataItem as DataItem;
use SMWDINumber as DINumber;
use SESP\PropertyAnnotator;
use SESP\AppFactory;

/**
 * @private
 * @ingroup SESP
 *
 * @license GNU GPL v2+
 * @since 2.0
 *
 * @author mwjames
 */
class PageViewsPropertyAnnotator implements PropertyAnnotator {

	/**
	 * Predefined property ID
	 */
	const PROP_ID = '___VIEWS';

	/**
	 * @var AppFactory
	 */
	private $appFactory;

	/**
	 * @since 2.0
	 *
	 * @param AppFactory $appFactory
	 */
	public function __construct( AppFactory $appFactory ) {
		$this->appFactory = $appFactory;
	}

	/**
	 * @since 2.0
	 *
	 * {@inheritDoc}
	 */
	public function isAnnotatorFor( DIProperty $property ) {
		return $property->getKey() === self::PROP_ID;
	}

	/**
	 * @since 2.0
	 *
	 * {@inheritDoc}
	 */
	public function addAnnotation( DIProperty $property, SemanticData $semanticData ) {

		if ( $this->appFactory->getOption( 'wgDisableCounters' ) ) {
			return null;
		}

		$page = $this->appFactory->newWikiPage( $semanticData->getSubject()->getTitle() );
/** @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);
    }
}
		$count = $this->getPageViewCount( $page );

		if ( is_numeric( $count ) ) {
			$semanticData->addPropertyObjectValue( $property, new DINumber( $count ) );
		}
	}

	private function getPageViewCount( $page ) {

		if ( class_exists( '\HitCounters\HitCounters' ) ) {
			return \HitCounters\HitCounters::getCount( $page->getTitle() );
		}

		if ( method_exists( $page, 'getCount' ) ) {
			return $page->getCount();
		}

		return null;
	}

}


1		<?php
2
3		namespace SESP\PropertyAnnotators;
4
5		use SMW\DIProperty;
6		use SMW\SemanticData;
7		use SMWDataItem as DataItem;
8		use SMWDINumber as DINumber;
9		use SESP\PropertyAnnotator;
10		use SESP\AppFactory;
11
12		/**
13		* @private
14		* @ingroup SESP
15		*
16		* @license GNU GPL v2+
17		* @since 2.0
18		*
19		* @author mwjames
20		*/
21		class PageViewsPropertyAnnotator implements PropertyAnnotator {
22
23		/**
24		* Predefined property ID
25		*/
26		const PROP_ID = '___VIEWS';
27
28		/**
29		* @var AppFactory
30		*/
31		private $appFactory;
32
33		/**
34		* @since 2.0
35		*
36		* @param AppFactory $appFactory
37		*/
38	4	public function __construct( AppFactory $appFactory ) {
39	4	$this->appFactory = $appFactory;
40	4	}
41
42		/**
43		* @since 2.0
44		*
45		* {@inheritDoc}
46		*/
47	1	public function isAnnotatorFor( DIProperty $property ) {
48	1	return $property->getKey() === self::PROP_ID;
49		}
50
51		/**
52		* @since 2.0
53		*
54		* {@inheritDoc}
55		*/
56	2	public function addAnnotation( DIProperty $property, SemanticData $semanticData ) {
57
58	2	if ( $this->appFactory->getOption( 'wgDisableCounters' ) ) {
59	1	return null;
60		}
61
62	1	$page = $this->appFactory->newWikiPage( $semanticData->getSubject()->getTitle() );
		0 ignored issues – show Bug introduced 2017-06-03 14:08 UTC by Report Bug Copy Issue Report It seems like `$semanticData->getSubject()->getTitle()` can be `null`; however, `newWikiPage()` 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...
63	1	$count = $this->getPageViewCount( $page );
64
65	1	if ( is_numeric( $count ) ) {
66	1	$semanticData->addPropertyObjectValue( $property, new DINumber( $count ) );
67	1	}
68	1	}
69
70	1	private function getPageViewCount( $page ) {
71
72	1	if ( class_exists( '\HitCounters\HitCounters' ) ) {
73		return \HitCounters\HitCounters::getCount( $page->getTitle() );
74		}
75
76	1	if ( method_exists( $page, 'getCount' ) ) {
77	1	return $page->getCount();
78		}
79
80		return null;
81		}
82
83		}
84

SemanticMediaWiki / SemanticExtraSpecialProperties

Pull Request — master (#75)

PageViewsPropertyAnnotator::addAnnotation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like