PageContributorsPropertyAnnotator::isAnnotatorFor() - Code Metrics - SemanticMediaWiki/SemanticExtraSpecialProperties - Measure and Improve Code Quality continuously with Scrutinizer

isAnnotatorFor() A
last analyzed 2021-05-24 12:18 UTC

↳ Parent: PageContributorsPropertyAnnotator

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace SESP\PropertyAnnotators;

use SMW\DIProperty;
use SMW\DIWikiPage;
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 PageContributorsPropertyAnnotator implements PropertyAnnotator {

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

	/**
	 * @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 ) {

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

		$user = $this->appFactory->newUserFromID( $page->getUser() );
		$authors = $page->getContributors();

		$dataItem = null;
$myVar = 'Value';
$higher = false;

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

		while ( $user ) {
			 //no anonymous users (hidden users are not returned)
			if ( $this->isNotAnonymous( $user ) ) {
				$semanticData->addPropertyObjectValue(
					$property,
					DIWikiPage::newFromTitle( $user->getUserPage() )
				);
			}

			$user = $authors->current();
			$authors->next();
		}
	}

	private function isNotAnonymous( $user ) {
		return !( in_array( 'bot', $user->getRights() ) && $this->appFactory->getOption( 'sespgExcludeBotEdits' ) ) && !$user->isAnon();
	}

}


1		<?php
2
3		namespace SESP\PropertyAnnotators;
4
5		use SMW\DIProperty;
6		use SMW\DIWikiPage;
7		use SMW\SemanticData;
8		use SMWDataItem as DataItem;
9		use SMWDINumber as DINumber;
10		use SESP\PropertyAnnotator;
11		use SESP\AppFactory;
12
13		/**
14		* @private
15		* @ingroup SESP
16		*
17		* @license GNU GPL v2+
18		* @since 2.0
19		*
20		* @author mwjames
21		*/
22		class PageContributorsPropertyAnnotator implements PropertyAnnotator {
23
24		/**
25		* Predefined property ID
26		*/
27		const PROP_ID = '___EUSER';
28
29		/**
30		* @var AppFactory
31		*/
32		private $appFactory;
33
34		/**
35		* @since 2.0
36		*
37		* @param AppFactory $appFactory
38		*/
39	3	public function __construct( AppFactory $appFactory ) {
40	3	$this->appFactory = $appFactory;
41	3	}
42
43		/**
44		* @since 2.0
45		*
46		* {@inheritDoc}
47		*/
48	1	public function isAnnotatorFor( DIProperty $property ) {
49	1	return $property->getKey() === self::PROP_ID;
50		}
51
52		/**
53		* @since 2.0
54		*
55		* {@inheritDoc}
56		*/
57	1	public function addAnnotation( DIProperty $property, SemanticData $semanticData ) {
58
59	1	$title = $semanticData->getSubject()->getTitle();
60	1	$page = $this->appFactory->newWikiPage( $title );
		0 ignored issues – show Bug introduced 2017-06-03 14:08 UTC by Report Bug Copy Issue Report It seems like `$title` defined by `$semanticData->getSubject()->getTitle()` on line `59` can be `null`; however, `SESP\AppFactory::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...
61
62	1	$user = $this->appFactory->newUserFromID( $page->getUser() );
63	1	$authors = $page->getContributors();
64
65	1	$dataItem = null;
		0 ignored issues – show Unused Code introduced 2017-06-03 14:08 UTC by Report Bug Copy Issue Report `$dataItem` 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...
66
67	1	while ( $user ) {
68		//no anonymous users (hidden users are not returned)
69	1	if ( $this->isNotAnonymous( $user ) ) {
70	1	$semanticData->addPropertyObjectValue(
71	1	$property,
72	1	DIWikiPage::newFromTitle( $user->getUserPage() )
73	1	);
74	1	}
75
76	1	$user = $authors->current();
77	1	$authors->next();
78	1	}
79	1	}
80
81	1	private function isNotAnonymous( $user ) {
82	1	return !( in_array( 'bot', $user->getRights() ) && $this->appFactory->getOption( 'sespgExcludeBotEdits' ) ) && !$user->isAnon();
83		}
84
85		}
86

SemanticMediaWiki / SemanticExtraSpecialProperties

isAnnotatorFor() A last analyzed 2021-05-24 12:18 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

isAnnotatorFor() A
last analyzed 2021-05-24 12:18 UTC