UserRegistrationDatePropertyAnnotator::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 10:05 UTC

addAnnotation() B

↳ Parent: UserRegistrationDatePropertyAnnotator

Complexity

Conditions	4
Paths	5

Size

Total Lines	30
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	21
CRAP Score	4.0015

Importance

Changes

Metric	Value
cc	4
eloc	18
nc	5
nop	2
dl	0
loc	30
ccs	21
cts	22
cp	0.9545
crap	4.0015
rs	8.5806
c	0
b	0
f	0

<?php

namespace SESP\PropertyAnnotators;

use SMW\DIProperty;
use SMW\SemanticData;
use SMWDataItem as DataItem;
use SMWDITime as DITime;
use SESP\PropertyAnnotator;
use SESP\AppFactory;
use User;

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

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

	/**
	 * @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);
    }
}
		$dataItem = null;

		if ( $user instanceof User ) {


			$timestamp = wfTimestamp( TS_ISO_8601, $user->getRegistration() );
			$date = new \DateTime( $timestamp );

			$dataItem = new DITime(
				DITime::CM_GREGORIAN,
				$date->format('Y'),
				$date->format('m'),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				$date->format('d'),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				$date->format('H'),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				$date->format('i')
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			);
		}

		if ( $dataItem instanceof DataItem ) {
			$semanticData->addPropertyObjectValue( $property, $dataItem );
		}
	}

}


1		<?php
2
3		namespace SESP\PropertyAnnotators;
4
5		use SMW\DIProperty;
6		use SMW\SemanticData;
7		use SMWDataItem as DataItem;
8		use SMWDITime as DITime;
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 UserRegistrationDatePropertyAnnotator implements PropertyAnnotator {
23
24		/**
25		* Predefined property ID
26		*/
27		const PROP_ID = '___USERREG';
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
61	1	if ( !$title->inNamespace( NS_USER ) ) {
62		return;
63		}
64
65	1	$user = $this->appFactory->newUserFromTitle( $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::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...
66	1	$dataItem = null;
67
68	1	if ( $user instanceof User ) {
		0 ignored issues – show Bug introduced 2017-06-03 14: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...
69
70	1	$timestamp = wfTimestamp( TS_ISO_8601, $user->getRegistration() );
71	1	$date = new \DateTime( $timestamp );
72
73	1	$dataItem = new DITime(
74	1	DITime::CM_GREGORIAN,
75	1	$date->format('Y'),
76	1	$date->format('m'),
		0 ignored issues – show Documentation introduced 2015-12-04 20:50 UTC by Report Bug Copy Issue Report `$date->format('m')` is of type `string`, but the function expects a `boolean`. 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...
77	1	$date->format('d'),
		0 ignored issues – show Documentation introduced 2015-12-04 20:50 UTC by Report Bug Copy Issue Report `$date->format('d')` is of type `string`, but the function expects a `boolean`. 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...
78	1	$date->format('H'),
		0 ignored issues – show Documentation introduced 2015-12-04 20:50 UTC by Report Bug Copy Issue Report `$date->format('H')` is of type `string`, but the function expects a `boolean`. 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...
79	1	$date->format('i')
		0 ignored issues – show Documentation introduced 2015-12-04 20:50 UTC by Report Bug Copy Issue Report `$date->format('i')` is of type `string`, but the function expects a `boolean`. 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...
80	1	);
81	1	}
82
83	1	if ( $dataItem instanceof DataItem ) {
84	1	$semanticData->addPropertyObjectValue( $property, $dataItem );
85	1	}
86	1	}
87
88		}
89

SemanticMediaWiki / SemanticExtraSpecialProperties

Pull Request — master (#75)

addAnnotation() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like