UserRightPropertyAnnotator::addAnnotation() - Code Metrics - Inspection of "Add User group, User right, and User block, refs 8..." - SemanticMediaWiki/SemanticExtraSpecialProperties - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6f7547...dda6b2 )

by mw

created 2018-03-24 15:15 UTC

UserRightPropertyAnnotator::addAnnotation() A

↳ Parent: UserRightPropertyAnnotator

Complexity

Conditions	4
Paths	4

Size

Total Lines	20
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4.074

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	20
ccs	10
cts	12
cp	0.8333
rs	9.2
cc	4
eloc	10
nc	4
nop	2
crap	4.074

<?php

namespace SESP\PropertyAnnotators;

use SMW\DIProperty;
use SMW\SemanticData;
use SMWDataItem as DataItem;
use SMWDIBlob as DIBlob;
use SESP\PropertyAnnotator;
use SESP\AppFactory;
use User;

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

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

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

		if ( !$title->inNamespace( NS_USER ) ) {
			return;
		}

		$user = $this->appFactory->newUserFromTitle(
			$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);
    }
}
		);

		if ( !$user instanceof User ) {

			return;
		}

		foreach ( $user->getRights() as $right ) {
			$semanticData->addPropertyObjectValue( $property, new DIBlob( $right ) );
		}
	}

}


1		<?php
2
3		namespace SESP\PropertyAnnotators;
4
5		use SMW\DIProperty;
6		use SMW\SemanticData;
7		use SMWDataItem as DataItem;
8		use SMWDIBlob as DIBlob;
9		use SESP\PropertyAnnotator;
10		use SESP\AppFactory;
11		use User;
12
13		/**
14		* @private
15		* @ingroup SESP
16		*
17		* @license GNU GPL v2+
18		* @since 2.0
19		*
20		* @author mwjames
21		*/
22		class UserRightPropertyAnnotator implements PropertyAnnotator {
23
24		/**
25		* Predefined property ID
26		*/
27		const PROP_ID = '___USERRIGHT';
28
29		/**
30		* @var AppFactory
31		*/
32		private $appFactory;
33
34		/**
35		* @since 2.0
36		*
37		* @param AppFactory $appFactory
38		*/
39	4	public function __construct( AppFactory $appFactory ) {
40	4	$this->appFactory = $appFactory;
41	4	}
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	2	public function addAnnotation( DIProperty $property, SemanticData $semanticData ) {
58
59	2	$title = $semanticData->getSubject()->getTitle();
60
61	2	if ( !$title->inNamespace( NS_USER ) ) {
62		return;
63		}
64
65	2	$user = $this->appFactory->newUserFromTitle(
66		$title
		0 ignored issues – show Bug introduced 2018-03-24 15: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::newUserFromTitle()` 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	2	);
68
69	2	if ( !$user instanceof User ) {
		0 ignored issues – show Bug introduced 2018-03-24 15:08 UTC by Report Bug Copy Issue Report The class `User` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
70		return;
71		}
72
73	2	foreach ( $user->getRights() as $right ) {
74	1	$semanticData->addPropertyObjectValue( $property, new DIBlob( $right ) );
75	2	}
76	2	}
77
78		}
79

SemanticMediaWiki / SemanticExtraSpecialProperties

Push — master ( 6f7547...dda6b2 )

UserRightPropertyAnnotator::addAnnotation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like