Activity - Code Metrics - Inspection of "clean up docblocks and fix some type hints" - php-xapi/model - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#74)

by Christian

created 2018-04-16 19:03 UTC

Activity A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

75%

Importance

Changes

Metric	Value
wmc	12
lcom	1
cbo	3
dl	0
loc	55
ccs	9
cts	12
cp	0.75
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	getId()	4	1
A	getDefinition()	4	1
C	equals()	24	9

<?php

/*
 * This file is part of the xAPI package.
 *
 * (c) Christian Flothmann <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Xabbuh\XApi\Model;

/**
 * An Activity in a {@link Statement}.
 *
 * @author Christian Flothmann <[email protected]>
 */
final class Activity extends StatementObject
{
    private $id;
    private $definition;

    public function __construct(IRI $id, Definition $definition = null)
    {
        $this->id = $id;
        $this->definition = $definition;
    }

    /**
     * Returns the Activity's unique identifier.
     */
    public function getId(): IRI
    {
        return $this->id;
    }

    /**
     * Returns the Activity's {@link Definition}.
     */
    public function getDefinition(): ?Definition
    {
        return $this->definition;
    }

    /**
     * {@inheritdoc}
     */
    public function equals(StatementObject $object): bool
    {
        if (!$object instanceof Activity) {
            return false;
        }

        if (!$this->id->equals($object->id)) {
            return false;
        }

        if (null === $this->definition && null !== $object->definition) {
            return false;
        }

        if (null !== $this->definition && null === $object->definition) {
            return false;
        }

        if (null !== $this->definition && !$this->definition->equals($object->definition)) {
/** @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);
    }
}
            return false;
        }

        return true;
    }
}


1		<?php
2
3		/*
4		* This file is part of the xAPI package.
5		*
6		* (c) Christian Flothmann <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Xabbuh\XApi\Model;
13
14		/**
15		* An Activity in a {@link Statement}.
16		*
17		* @author Christian Flothmann <[email protected]>
18		*/
19		final class Activity extends StatementObject
20		{
21		private $id;
22		private $definition;
23
24		public function __construct(IRI $id, Definition $definition = null)
25		{
26		$this->id = $id;
27		$this->definition = $definition;
28		}
29
30		/**
31		* Returns the Activity's unique identifier.
32		*/
33		public function getId(): IRI
34		{
35		return $this->id;
36	13	}
37
38	13	/**
39	13	* Returns the Activity's {@link Definition}.
40	13	*/
41		public function getDefinition(): ?Definition
42		{
43		return $this->definition;
44		}
45
46		/**
47	1	* {@inheritdoc}
48		*/
49	1	public function equals(StatementObject $object): bool
50		{
51		if (!$object instanceof Activity) {
52		return false;
53		}
54
55		if (!$this->id->equals($object->id)) {
56		return false;
57		}
58
59		if (null === $this->definition && null !== $object->definition) {
60		return false;
61		}
62
63		if (null !== $this->definition && null === $object->definition) {
64		return false;
65	2	}
66
67	2	if (null !== $this->definition && !$this->definition->equals($object->definition)) {
		0 ignored issues – show Bug introduced 2018-04-16 17:10 UTC by Report Bug Copy Issue Report It seems like `$object->definition` can be `null`; however, `equals()` 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...
68		return false;
69		}
70
71		return true;
72		}
73		}
74

php-xapi / model

Pull Request — master (#74)

Activity A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Duplication Side-by-Side

Filter issues like