Timestamp::getEventStatus() - Code Metrics - Inspection of "III-3570 Add Event status" - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#480)

by Jonas

created 2020-11-23 12:20 UTC

Timestamp::getEventStatus() 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\EventStatus;
use CultuurNet\UDB3\Event\ValueObjects\EventStatusType;
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 EventStatus
     */
    private $eventStatus;

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

        $this->startDate = $startDate;
        $this->endDate = $endDate;
        $this->eventStatus = new EventStatus(EventStatusType::scheduled(), []);
        if ($eventStatus) {
            $this->eventStatus = $eventStatus;
        }
    }

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

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

    public function getEventStatus(): EventStatus
    {
        return $this->eventStatus;
    }

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

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

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

            $status
        );
    }

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

        return \array_merge(
            $serialized,
            $this->eventStatus->serialize()
        );
    }

    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\EventStatus;
7			use CultuurNet\UDB3\Event\ValueObjects\EventStatusType;
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 EventStatus
27			*/
28			private $eventStatus;
29
30			final public function __construct(
31			DateTimeInterface $startDate,
32			DateTimeInterface $endDate,
33			EventStatus $eventStatus = 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->eventStatus = new EventStatus(EventStatusType::scheduled(), []);
42			if ($eventStatus) {
43			$this->eventStatus = $eventStatus;
44			}
45			}
46
47			public function getStartDate(): DateTimeInterface
48			{
49			return $this->startDate;
50			}
51
52			public function getEndDate(): DateTimeInterface
53			{
54			return $this->endDate;
55			}
56
57			public function getEventStatus(): EventStatus
58			{
59			return $this->eventStatus;
60			}
61
62			public static function deserialize(array $data): Timestamp
63			{
64			$status = null;
65			if (isset($data['eventStatus']) && isset($data['eventStatusReason'])) {
66			$status = EventStatus::deserialize($data);
67			}
68
69			return new static(
70			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...
71			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...
72			$status
73			);
74			}
75
76			public function serialize(): array
77			{
78			$serialized = [
79			'startDate' => $this->startDate->format(DateTime::ATOM),
80			'endDate' => $this->endDate->format(DateTime::ATOM),
81			];
82
83			return \array_merge(
84			$serialized,
85			$this->eventStatus->serialize()
86			);
87			}
88
89			public static function fromUdb3ModelDateRange(DateRange $dateRange): Timestamp
90			{
91			return new Timestamp(
92			$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...
93			$dateRange->getTo()
			0 ignored issues – show Bug introduced 2018-03-12 16:14 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...
94			);
95			}
96			}
97

cultuurnet / udb3-php

Pull Request — master (#480)

Timestamp::getEventStatus() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like