InteractionComponent::equals() - Code Metrics - Inspection of "add statement activity interaction definitions" - php-xapi/model - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#27)

by Christian

created 2016-09-23 13:47 UTC

InteractionComponent::equals() B

↳ Parent: InteractionComponent

Complexity

Conditions	5
Paths	4

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	8
nc	4
nop	1

<?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\Interaction;

use Xabbuh\XApi\Model\LanguageMap;

/**
 * An XAPI activity interaction component.
 *
 * @author Christian Flothmann <[email protected]>
 */
final class InteractionComponent
{
    private $id;
    private $description;

    /**
     * @param string           $id
     * @param LanguageMap|null $description
     */
    public function __construct($id, LanguageMap $description = null)
    {
        $this->id = $id;
        $this->description = $description;
    }

    public function getId()
    {
        return $this->id;
    }

    public function getDescription()
    {
        return $this->description;
    }

    public function equals(InteractionComponent $interactionComponent)
    {
        if ($this->id !== $interactionComponent->id) {
            return false;
        }

        if (null !== $this->description xor null !== $interactionComponent->description) {
            return false;
        }

        if (null !== $this->description && !$this->description->equals($interactionComponent->description)) {
/** @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\Interaction;
13
14			use Xabbuh\XApi\Model\LanguageMap;
15
16			/**
17			* An XAPI activity interaction component.
18			*
19			* @author Christian Flothmann <[email protected]>
20			*/
21			final class InteractionComponent
22			{
23			private $id;
24			private $description;
25
26			/**
27			* @param string $id
28			* @param LanguageMap\|null $description
29			*/
30			public function __construct($id, LanguageMap $description = null)
31			{
32			$this->id = $id;
33			$this->description = $description;
34			}
35
36			public function getId()
37			{
38			return $this->id;
39			}
40
41			public function getDescription()
42			{
43			return $this->description;
44			}
45
46			public function equals(InteractionComponent $interactionComponent)
47			{
48			if ($this->id !== $interactionComponent->id) {
49			return false;
50			}
51
52			if (null !== $this->description xor null !== $interactionComponent->description) {
53			return false;
54			}
55
56			if (null !== $this->description && !$this->description->equals($interactionComponent->description)) {
			0 ignored issues – show Bug introduced 2016-09-23 13:20 UTC by Report Bug Copy Issue Report It seems like `$interactionComponent->description` 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...
57			return false;
58			}
59
60			return true;
61			}
62			}
63

php-xapi / model

Pull Request — master (#27)

InteractionComponent::equals() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like