Timestamp::getStatus() - Code Metrics - Inspection of "Merge pull request #483 from cultuurnet/refactor-e..." - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 913de5...7ff0dd )

by Jonas

created 2020-11-27 14:03 UTC

Timestamp::getStatus() A

↳ Parent: Timestamp

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace CultuurNet\UDB3;

use Broadway\Serializer\SerializableInterface;
use CultuurNet\UDB3\Event\ValueObjects\Status;
use CultuurNet\UDB3\Event\ValueObjects\StatusType;
use CultuurNet\UDB3\Model\ValueObject\Calendar\DateRange;
use DateTime;
use DateTimeInterface;
use InvalidArgumentException;

final class Timestamp implements SerializableInterface
{
    /**
     * @var DateTimeInterface
     */
    private $startDate;

    /**
     * @var DateTimeInterface
     */
    private $endDate;

    /**
     * @var Status
     */
    private $status;

    final public function __construct(
        DateTimeInterface $startDate,
        DateTimeInterface $endDate,
        Status $status = null
    ) {
        if ($endDate < $startDate) {
            throw new InvalidArgumentException('End date can not be earlier than start date.');
        }

        $this->startDate = $startDate;
        $this->endDate = $endDate;
        $this->status = $status ?? new Status(StatusType::available(), []);
    }

    public function getStartDate(): DateTimeInterface
    {
        return $this->startDate;
    }

    public function getEndDate(): DateTimeInterface
    {
        return $this->endDate;
    }

    public function getStatus(): Status
    {
        return $this->status;
    }

    public static function deserialize(array $data): Timestamp
    {
        $status = null;
        if (isset($data['status'])) {
            $status = Status::deserialize($data['status']);
        }

        return new static(
            DateTime::createFromFormat(DateTime::ATOM, $data['startDate']),

            DateTime::createFromFormat(DateTime::ATOM, $data['endDate']),

            $status
        );
    }

    public function serialize(): array
    {
        return [
            'startDate' => $this->startDate->format(DateTime::ATOM),
            'endDate' => $this->endDate->format(DateTime::ATOM),
            'status' => $this->status->serialize(),
        ];
    }

    public function toJsonLd(): array
    {
        $jsonLd = $this->serialize();
        $jsonLd['@type'] = 'Event';

        return $jsonLd;
    }

    public static function fromUdb3ModelDateRange(DateRange $dateRange): Timestamp
    {
        return new Timestamp(
            $dateRange->getFrom(),
/** @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);
    }
}
            $dateRange->getTo()
/** @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);
    }
}
        );
    }
}


1			<?php
2
3			namespace CultuurNet\UDB3;
4
5			use Broadway\Serializer\SerializableInterface;
6			use CultuurNet\UDB3\Event\ValueObjects\Status;
7			use CultuurNet\UDB3\Event\ValueObjects\StatusType;
8			use CultuurNet\UDB3\Model\ValueObject\Calendar\DateRange;
9			use DateTime;
10			use DateTimeInterface;
11			use InvalidArgumentException;
12
13			final class Timestamp implements SerializableInterface
14			{
15			/**
16			* @var DateTimeInterface
17			*/
18			private $startDate;
19
20			/**
21			* @var DateTimeInterface
22			*/
23			private $endDate;
24
25			/**
26			* @var Status
27			*/
28			private $status;
29
30			final public function __construct(
31			DateTimeInterface $startDate,
32			DateTimeInterface $endDate,
33			Status $status = null
34			) {
35			if ($endDate < $startDate) {
36			throw new InvalidArgumentException('End date can not be earlier than start date.');
37			}
38
39			$this->startDate = $startDate;
40			$this->endDate = $endDate;
41			$this->status = $status ?? new Status(StatusType::available(), []);
42			}
43
44			public function getStartDate(): DateTimeInterface
45			{
46			return $this->startDate;
47			}
48
49			public function getEndDate(): DateTimeInterface
50			{
51			return $this->endDate;
52			}
53
54			public function getStatus(): Status
55			{
56			return $this->status;
57			}
58
59			public static function deserialize(array $data): Timestamp
60			{
61			$status = null;
62			if (isset($data['status'])) {
63			$status = Status::deserialize($data['status']);
64			}
65
66			return new static(
67			DateTime::createFromFormat(DateTime::ATOM, $data['startDate']),
			0 ignored issues – show Security Bug introduced 2016-09-26 12:07 UTC by Report Bug Copy Issue Report It seems like `\DateTime::createFromFor...OM, $data['startDate'])` targeting `DateTime::createFromFormat()` can also be of type `false`; however, `CultuurNet\UDB3\Timestamp::__construct()` does only seem to accept `object<DateTimeInterface>`, did you maybe forget to handle an error condition? Loading history...
68			DateTime::createFromFormat(DateTime::ATOM, $data['endDate']),
			0 ignored issues – show Security Bug introduced 2016-09-26 12:07 UTC by Report Bug Copy Issue Report It seems like `\DateTime::createFromFor...ATOM, $data['endDate'])` targeting `DateTime::createFromFormat()` can also be of type `false`; however, `CultuurNet\UDB3\Timestamp::__construct()` does only seem to accept `object<DateTimeInterface>`, did you maybe forget to handle an error condition? Loading history...
69			$status
70			);
71			}
72
73			public function serialize(): array
74			{
75			return [
76			'startDate' => $this->startDate->format(DateTime::ATOM),
77			'endDate' => $this->endDate->format(DateTime::ATOM),
78			'status' => $this->status->serialize(),
79			];
80			}
81
82			public function toJsonLd(): array
83			{
84			$jsonLd = $this->serialize();
85			$jsonLd['@type'] = 'Event';
86
87			return $jsonLd;
88			}
89
90			public static function fromUdb3ModelDateRange(DateRange $dateRange): Timestamp
91			{
92			return new Timestamp(
93			$dateRange->getFrom(),
			0 ignored issues – show Bug introduced 2018-03-12 16:14 UTC by Report Bug Copy Issue Report It seems like `$dateRange->getFrom()` can be `null`; however, `__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...
94			$dateRange->getTo()
			0 ignored issues – show Bug introduced 2020-11-24 17:20 UTC by Report Bug Copy Issue Report It seems like `$dateRange->getTo()` can be `null`; however, `__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...
95			);
96			}
97			}
98

cultuurnet / udb3-php

Push — master ( 913de5...7ff0dd )

Timestamp::getStatus() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like