Result::getExtensions() - Code Metrics - Inspection of "add equals() methods to Extensions and Result" - php-xapi/model - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#17)

by Christian

created 2016-09-19 07:22 UTC

Result::getExtensions() A

↳ Parent: Result

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
dl	0
loc	4
rs	10
c	1
b	0
f	1
ccs	0
cts	3
cp	0
cc	1
eloc	2
nc	1
nop	0
crap	2

<?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 {@link Actor Actor's} outcome related to the {@link Statement} in which
 * it is included.
 *
 * @author Christian Flothmann <[email protected]>
 */
final class Result
{
    /**
     * @var Score The score
     */
    private $score;

    /**
     * @var bool Indicates whether or not the attempt was successful
     */
    private $success;

    /**
     * @var bool Indicates whether or not the Activity was completed
     */
    private $completion;

    /**
     * @var string A response for the given Activity
     */
    private $response;

    /**
     * @var string Period of time over which the Activity was performed
     */
    private $duration;

    /**
     * @var Extensions|null Extensions associated with this result
     */
    private $extensions;

    /**
     * @param Score|null      $score
     * @param bool|null       $success
     * @param bool|null       $completion
     * @param string|null     $response
     * @param string|null     $duration
     * @param Extensions|null $extensions
     */
    public function __construct(Score $score = null, $success = null, $completion = null, $response = null, $duration = null, Extensions $extensions = null)
    {
        $this->score = $score;
        $this->success = $success;
        $this->completion = $completion;
        $this->response = $response;
        $this->duration = $duration;
        $this->extensions = $extensions;
    }

    /**
     * Returns the user's score.
     *
     * @return Score The score
     */
    public function getScore()
    {
        return $this->score;
    }

    /**
     * Returns whether or not the user finished a task successfully.
     *
     * @return bool True if the user finished an exercise successfully, false
     *              otherwise
     */
    public function getSuccess()
    {
        return $this->success;
    }

    /**
     * Returns the completion status.
     *
     * @return bool $completion True, if the Activity was completed, false
     *                          otherwise
     */
    public function getCompletion()
    {
        return $this->completion;
    }

    /**
     * Returns the response.
     *
     * @return string The response
     */
    public function getResponse()
    {
        return $this->response;
    }

    /**
     * Returns the period of time over which the Activity was performed.
     *
     * @return string The duration
     */
    public function getDuration()
    {
        return $this->duration;
    }

    /**
     * Returns the extensions associated with the result.
     *
     * @return Extensions|null The extensions
     */
    public function getExtensions()
    {
        return $this->extensions;
    }

    /**
     * Checks if another result is equal.
     *
     * Two results are equal if and only if all of their properties are equal.
     *
     * @param Result $result The result to compare with
     *
     * @return bool True if the results are equal, false otherwise
     */
    public function equals(Result $result)
    {
        if (null !== $this->score xor null !== $result->score) {
            return false;
        }

        if (null !== $this->score && !$this->score->equals($result->score)) {
            return false;
        }

        if ($this->success !== $result->success) {
            return false;
        }

        if ($this->completion !== $result->completion) {
            return false;
        }

        if ($this->response !== $result->response) {
            return false;
        }

        if ($this->duration !== $result->duration) {
            return false;
        }

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

        if (null !== $this->extensions && !$this->extensions->equals($result->extensions)) {
/** @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 {@link Actor Actor's} outcome related to the {@link Statement} in which
16			* it is included.
17			*
18			* @author Christian Flothmann <[email protected]>
19			*/
20			final class Result
21			{
22			/**
23			* @var Score The score
24			*/
25			private $score;
26
27			/**
28			* @var bool Indicates whether or not the attempt was successful
29			*/
30			private $success;
31
32			/**
33			* @var bool Indicates whether or not the Activity was completed
34			*/
35			private $completion;
36
37			/**
38			* @var string A response for the given Activity
39			*/
40			private $response;
41
42			/**
43			* @var string Period of time over which the Activity was performed
44			*/
45			private $duration;
46
47			/**
48			* @var Extensions\|null Extensions associated with this result
49			*/
50			private $extensions;
51
52			/**
53			* @param Score\|null $score
54			* @param bool\|null $success
55			* @param bool\|null $completion
56			* @param string\|null $response
57			* @param string\|null $duration
58			* @param Extensions\|null $extensions
59			*/
60			public function __construct(Score $score = null, $success = null, $completion = null, $response = null, $duration = null, Extensions $extensions = null)
61			{
62			$this->score = $score;
63			$this->success = $success;
64			$this->completion = $completion;
65			$this->response = $response;
66			$this->duration = $duration;
67			$this->extensions = $extensions;
68			}
69
70			/**
71			* Returns the user's score.
72			*
73			* @return Score The score
74			*/
75			public function getScore()
76			{
77			return $this->score;
78			}
79
80			/**
81			* Returns whether or not the user finished a task successfully.
82			*
83			* @return bool True if the user finished an exercise successfully, false
84			* otherwise
85			*/
86			public function getSuccess()
87			{
88			return $this->success;
89			}
90
91			/**
92			* Returns the completion status.
93			*
94			* @return bool $completion True, if the Activity was completed, false
95			* otherwise
96			*/
97			public function getCompletion()
98			{
99			return $this->completion;
100			}
101
102			/**
103			* Returns the response.
104			*
105			* @return string The response
106			*/
107			public function getResponse()
108			{
109			return $this->response;
110			}
111
112			/**
113			* Returns the period of time over which the Activity was performed.
114			*
115			* @return string The duration
116			*/
117			public function getDuration()
118			{
119			return $this->duration;
120			}
121
122			/**
123			* Returns the extensions associated with the result.
124			*
125			* @return Extensions\|null The extensions
126			*/
127			public function getExtensions()
128			{
129			return $this->extensions;
130			}
131
132			/**
133			* Checks if another result is equal.
134			*
135			* Two results are equal if and only if all of their properties are equal.
136			*
137			* @param Result $result The result to compare with
138			*
139			* @return bool True if the results are equal, false otherwise
140			*/
141			public function equals(Result $result)
142			{
143			if (null !== $this->score xor null !== $result->score) {
144			return false;
145			}
146
147			if (null !== $this->score && !$this->score->equals($result->score)) {
148			return false;
149			}
150
151			if ($this->success !== $result->success) {
152			return false;
153			}
154
155			if ($this->completion !== $result->completion) {
156			return false;
157			}
158
159			if ($this->response !== $result->response) {
160			return false;
161			}
162
163			if ($this->duration !== $result->duration) {
164			return false;
165			}
166
167			if (null !== $this->extensions xor null !== $result->extensions) {
168			return false;
169			}
170
171			if (null !== $this->extensions && !$this->extensions->equals($result->extensions)) {
			0 ignored issues – show Bug introduced 2016-09-19 07:27 UTC by Report Bug Copy Issue Report It seems like `$result->extensions` 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...
172			return false;
173			}
174
175			return true;
176			}
177			}
178

php-xapi / model

Pull Request — master (#17)

Result::getExtensions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like