ApprovedRevPropertyAnnotator::addAnnotation() - Code Metrics - Inspection of "Copy SESP (ApprovedRevs) properties" - SemanticMediaWiki/SemanticApprovedRevs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

by mw

created 2019-03-02 17:19 UTC

ApprovedRevPropertyAnnotator::addAnnotation() A

↳ Parent: ApprovedRevPropertyAnnotator

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3.054

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.6666
c	0
b	0
f	0
ccs	9
cts	11
cp	0.8182
cc	3
nc	4
nop	1
crap	3.054

<?php

namespace SMW\ApprovedRevs\PropertyAnnotators;

use SMW\DIProperty;
use SMW\SemanticData;
use SMWDINumber as DINumber;
use SMW\ApprovedRevs\ApprovedRevsFacade;
use SMW\ApprovedRevs\PropertyRegistry;

/**
 * @private
 *
 * @license GNU GPL v2+
 */
class ApprovedRevPropertyAnnotator {

	/**
	 * @var ApprovedRevsFacade
	 */
	private $approvedRevsFacade;

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

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

	/**
	 * @since 1.0
	 *
	 * @param integer $approvedRev
	 */
	public function setApprovedRev( $approvedRev ) {
		$this->approvedRev = $approvedRev;
	}

	/**
	 * @since 1.0
	 *
	 * @return DIProperty
	 */
	public function newDIProperty() {
		return new DIProperty( PropertyRegistry::SAR_PROP_APPROVED_REV );
	}

	/**
	 * @since 1.0
	 *
	 * @param SemanticData $semanticData
	 */
	public function addAnnotation( SemanticData $semanticData ) {

		if ( $this->approvedRev === null ) {
			$this->approvedRev = $this->approvedRevsFacade->getApprovedRevID(
				$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);
    }
}
			);
		}

		$property = $this->newDIProperty();
		$semanticData->removeProperty( $property );

		if ( is_numeric( $this->approvedRev ) ) {
			$semanticData->addPropertyObjectValue(
				$property,
				$this->newDINumber()
			);
		}
	}

	private function newDINumber() {
		return new DINumber( $this->approvedRev );
	}

}


1		<?php
2
3		namespace SMW\ApprovedRevs\PropertyAnnotators;
4
5		use SMW\DIProperty;
6		use SMW\SemanticData;
7		use SMWDINumber as DINumber;
8		use SMW\ApprovedRevs\ApprovedRevsFacade;
9		use SMW\ApprovedRevs\PropertyRegistry;
10
11		/**
12		* @private
13		*
14		* @license GNU GPL v2+
15		*/
16		class ApprovedRevPropertyAnnotator {
17
18		/**
19		* @var ApprovedRevsFacade
20		*/
21		private $approvedRevsFacade;
22
23		/**
24		* @var Integer\|null
25		*/
26		private $approvedRev;
27
28		/**
29		* @param ApprovedRevsFacade $approvedRevsFacade
30		*/
31	3	public function __construct( ApprovedRevsFacade $approvedRevsFacade ) {
32	3	$this->approvedRevsFacade = $approvedRevsFacade;
33	3	}
34
35		/**
36		* @since 1.0
37		*
38		* @param integer $approvedRev
39		*/
40	2	public function setApprovedRev( $approvedRev ) {
41	2	$this->approvedRev = $approvedRev;
42	2	}
43
44		/**
45		* @since 1.0
46		*
47		* @return DIProperty
48		*/
49	2	public function newDIProperty() {
50	2	return new DIProperty( PropertyRegistry::SAR_PROP_APPROVED_REV );
51		}
52
53		/**
54		* @since 1.0
55		*
56		* @param SemanticData $semanticData
57		*/
58	2	public function addAnnotation( SemanticData $semanticData ) {
59
60	2	if ( $this->approvedRev === null ) {
61		$this->approvedRev = $this->approvedRevsFacade->getApprovedRevID(
62		$semanticData->getSubject()->getTitle()
		0 ignored issues – show Bug introduced 2019-03-02 17:21 UTC by Report Bug Copy Issue Report It seems like `$semanticData->getSubject()->getTitle()` can be `null`; however, `getApprovedRevID()` 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		);
64		}
65
66	2	$property = $this->newDIProperty();
67	2	$semanticData->removeProperty( $property );
68
69	2	if ( is_numeric( $this->approvedRev ) ) {
70	1	$semanticData->addPropertyObjectValue(
71	1	$property,
72	1	$this->newDINumber()
73		);
74		}
75	2	}
76
77	1	private function newDINumber() {
78	1	return new DINumber( $this->approvedRev );
79		}
80
81		}
82

SemanticMediaWiki / SemanticApprovedRevs

Pull Request — master (#1)

ApprovedRevPropertyAnnotator::addAnnotation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like