ApprovedDatePropertyAnnotator::addAnnotation() - Code Metrics - Inspection of "Add additional properties for AR" - SemanticMediaWiki/SemanticExtraSpecialProperties - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#98)

by mw

created 2018-02-03 13:07 UTC

ApprovedDatePropertyAnnotator::addAnnotation() A

↳ Parent: ApprovedDatePropertyAnnotator

Complexity

Conditions	4
Paths	4

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4.9102

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	17
ccs	8
cts	13
cp	0.6153
rs	9.2
cc	4
eloc	11
nc	4
nop	2
crap	4.9102

<?php

namespace SESP\PropertyAnnotators;

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

/**
 * @private
 * @ingroup SESP
 *
 * @license GNU GPL v2+
 */
class ApprovedDatePropertyAnnotator implements PropertyAnnotator {

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

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

	/**
	 * @var Integer|null
	 */
	private $approvedDate;

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

	/**
	 * @since 2.0
	 *
	 * @param Integer $approvedDate
	 */
	public function setApprovedDate( $approvedDate ) {
		$this->approvedDate = $approvedDate;
	}

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

	public function getDataItem() {
		if ( $this->approvedDate ) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			$date = $this->approvedDate;
			return new DITime(
				DITime::CM_GREGORIAN,
				$date->format( 'Y' ),

				$date->format( 'm' ),

				$date->format( 'd' ),

				$date->format( 'H' ),

				$date->format( 'i' )

			);
		}
	}

	/**
	 * {@inheritDoc}
	 */
	public function addAnnotation(
		DIProperty $property, SemanticData $semanticData
	) {
		if ( $this->approvedDate === null && class_exists( 'ApprovedRevs' ) ) {
			$logReader = $this->appFactory->newDatabaseLogReader(
				$semanticData->getSubject()->getTitle(), 'approval'
			);
			$this->approvedDate = $logReader->getDateOfLogEntry();
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;
}
		}

		$dataItem = $this->getDataItem();
		if ( $dataItem ) {
			$semanticData->addPropertyObjectValue( $property, $dataItem );
		} else {
			$semanticData->removeProperty( $property );
		}
	}
}


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
12		/**
13		* @private
14		* @ingroup SESP
15		*
16		* @license GNU GPL v2+
17		*/
18		class ApprovedDatePropertyAnnotator implements PropertyAnnotator {
19
20		/**
21		* Predefined property ID
22		*/
23		const PROP_ID = '___APPROVEDDATE';
24
25		/**
26		* @var AppFactory
27		*/
28		private $appFactory;
29
30		/**
31		* @var Integer\|null
32		*/
33		private $approvedDate;
34
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		* @param Integer $approvedDate
46		*/
47	2	public function setApprovedDate( $approvedDate ) {
48	2	$this->approvedDate = $approvedDate;
49	2	}
50
51		/**
52		* {@inheritDoc}
53		*/
54	1	public function isAnnotatorFor( DIProperty $property ) {
55	1	return $property->getKey() === self::PROP_ID;
56		}
57
58	2	public function getDataItem() {
59	2	if ( $this->approvedDate ) {
		0 ignored issues – show Bug Best Practice introduced 2018-01-07 04:49 UTC by Report Bug Copy Issue Report The expression `$this->approvedDate` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
60	1	$date = $this->approvedDate;
61	1	return new DITime(
62	1	DITime::CM_GREGORIAN,
63	1	$date->format( 'Y' ),
		0 ignored issues – show Bug introduced 2018-01-07 04:49 UTC by Report Bug Copy Issue Report The method `format` cannot be called on `$date` (of type `integer`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
64	1	$date->format( 'm' ),
		0 ignored issues – show Bug introduced 2018-01-07 04:49 UTC by Report Bug Copy Issue Report The method `format` cannot be called on `$date` (of type `integer`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
65	1	$date->format( 'd' ),
		0 ignored issues – show Bug introduced 2018-01-07 04:49 UTC by Report Bug Copy Issue Report The method `format` cannot be called on `$date` (of type `integer`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
66	1	$date->format( 'H' ),
		0 ignored issues – show Bug introduced 2018-01-07 04:49 UTC by Report Bug Copy Issue Report The method `format` cannot be called on `$date` (of type `integer`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
67	1	$date->format( 'i' )
		0 ignored issues – show Bug introduced 2018-01-07 04:49 UTC by Report Bug Copy Issue Report The method `format` cannot be called on `$date` (of type `integer`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
68	1	);
69		}
70	1	}
71
72		/**
73		* {@inheritDoc}
74		*/
75	2	public function addAnnotation(
76		DIProperty $property, SemanticData $semanticData
77		) {
78	2	if ( $this->approvedDate === null && class_exists( 'ApprovedRevs' ) ) {
79		$logReader = $this->appFactory->newDatabaseLogReader(
80		$semanticData->getSubject()->getTitle(), 'approval'
81		);
82		$this->approvedDate = $logReader->getDateOfLogEntry();
		0 ignored issues – show Documentation Bug introduced 2018-01-07 04:49 UTC by Report Bug Copy Issue Report It seems like `$logReader->getDateOfLogEntry()` can also be of type `object<MWTimestamp>`. However, the property `$approvedDate` is declared as type `integer\|null`. 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...
83		}
84
85	2	$dataItem = $this->getDataItem();
86	2	if ( $dataItem ) {
87	1	$semanticData->addPropertyObjectValue( $property, $dataItem );
88	1	} else {
89	1	$semanticData->removeProperty( $property );
90		}
91	2	}
92		}
93

SemanticMediaWiki / SemanticExtraSpecialProperties

Pull Request — master (#98)

ApprovedDatePropertyAnnotator::addAnnotation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like