TotalResponse::getResolution() - Code Metrics - Inspection of "Renamed namespace from Resource\Api to Model (#293..." - mailgun/mailgun-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( da873d...74929b )

by Tobias

created 2017-02-23 19:56 UTC

TotalResponse::getResolution() A

↳ Parent: TotalResponse

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

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

<?php

/*
 * Copyright (C) 2013-2016 Mailgun
 *
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */

namespace Mailgun\Model\Stats;

use Mailgun\Model\ApiResponse;

/**
 * @author Tobias Nyholm <[email protected]>
 */
final class TotalResponse implements ApiResponse
{
    /**
     * @var \DateTime
     */
    private $start;

    /**
     * @var \DateTime
     */
    private $end;

    /**
     * @var string
     */
    private $resolution;

    /**
     * @var TotalResponseItem[]
     */
    private $stats;

    /**
     * @param \DateTime           $start
     * @param \DateTime           $end
     * @param string              $resolution
     * @param TotalResponseItem[] $stats
     */
    private function __construct(\DateTime $start, \DateTime $end, $resolution, array $stats)
    {
        $this->start = $start;
        $this->end = $end;
        $this->resolution = $resolution;
        $this->stats = $stats;
    }

    /**
     * @param array $data
     *
     * @return self
     */
    public static function create(array $data)
    {
        $stats = [];
        if (isset($data['status'])) {
            foreach ($data['stats'] as $s) {
                $stats[] = TotalResponseItem::create($s);
            }
        }

        $start = isset($data['start']) ? new \DateTime($data['start']) : null;
        $end = isset($data['end']) ? new \DateTime($data['end']) : null;
        $resolution = isset($data['resolution']) ? $data['resolution'] : null;

        return new self($start, $end, $resolution, $stats);
/** @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 \DateTime
     */
    public function getStart()
    {
        return $this->start;
    }

    /**
     * @return \DateTime
     */
    public function getEnd()
    {
        return $this->end;
    }

    /**
     * @return string
     */
    public function getResolution()
    {
        return $this->resolution;
    }

    /**
     * @return TotalResponseItem[]
     */
    public function getStats()
    {
        return $this->stats;
    }
}


1			<?php
2
3			/*
4			* Copyright (C) 2013-2016 Mailgun
5			*
6			* This software may be modified and distributed under the terms
7			* of the MIT license. See the LICENSE file for details.
8			*/
9
10			namespace Mailgun\Model\Stats;
11
12			use Mailgun\Model\ApiResponse;
13
14			/**
15			* @author Tobias Nyholm <[email protected]>
16			*/
17			final class TotalResponse implements ApiResponse
18			{
19			/**
20			* @var \DateTime
21			*/
22			private $start;
23
24			/**
25			* @var \DateTime
26			*/
27			private $end;
28
29			/**
30			* @var string
31			*/
32			private $resolution;
33
34			/**
35			* @var TotalResponseItem[]
36			*/
37			private $stats;
38
39			/**
40			* @param \DateTime $start
41			* @param \DateTime $end
42			* @param string $resolution
43			* @param TotalResponseItem[] $stats
44			*/
45			private function __construct(\DateTime $start, \DateTime $end, $resolution, array $stats)
46			{
47			$this->start = $start;
48			$this->end = $end;
49			$this->resolution = $resolution;
50			$this->stats = $stats;
51			}
52
53			/**
54			* @param array $data
55			*
56			* @return self
57			*/
58			public static function create(array $data)
59			{
60			$stats = [];
61			if (isset($data['status'])) {
62			foreach ($data['stats'] as $s) {
63			$stats[] = TotalResponseItem::create($s);
64			}
65			}
66
67			$start = isset($data['start']) ? new \DateTime($data['start']) : null;
68			$end = isset($data['end']) ? new \DateTime($data['end']) : null;
69			$resolution = isset($data['resolution']) ? $data['resolution'] : null;
70
71			return new self($start, $end, $resolution, $stats);
			0 ignored issues – show Bug introduced 2017-02-23 20:00 UTC by Report Bug Copy Issue Report It seems like `$start` defined by `isset($data['start']) ? ...($data['start']) : null` on line `67` can be `null`; however, `Mailgun\Model\Stats\TotalResponse::__construct()` 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... Bug introduced 2017-02-23 20:00 UTC by Report Bug Copy Issue Report It seems like `$end` defined by `isset($data['end']) ? ne...me($data['end']) : null` on line `68` can be `null`; however, `Mailgun\Model\Stats\TotalResponse::__construct()` 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...
72			}
73
74			/**
75			* @return \DateTime
76			*/
77			public function getStart()
78			{
79			return $this->start;
80			}
81
82			/**
83			* @return \DateTime
84			*/
85			public function getEnd()
86			{
87			return $this->end;
88			}
89
90			/**
91			* @return string
92			*/
93			public function getResolution()
94			{
95			return $this->resolution;
96			}
97
98			/**
99			* @return TotalResponseItem[]
100			*/
101			public function getStats()
102			{
103			return $this->stats;
104			}
105			}
106

mailgun / mailgun-php

Push — master ( da873d...74929b )

TotalResponse::getResolution() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like