Event::status() - Code Metrics - Inspection of "Add support for event status" - spatie/icalendar-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d65602...7abf9d )

by Ruben

created 2020-01-16 15:48 UTC

Event::status() A

↳ Parent: Event

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\IcalendarGenerator\Components;

use DateTimeImmutable;
use DateTimeInterface;
use Spatie\IcalendarGenerator\ComponentPayload;
use Spatie\IcalendarGenerator\Enums\Classification;
use Spatie\IcalendarGenerator\Enums\EventStatus;
use Spatie\IcalendarGenerator\Enums\ParticipationStatus;
use Spatie\IcalendarGenerator\PropertyTypes\CalendarAddressPropertyType;
use Spatie\IcalendarGenerator\PropertyTypes\CoordinatesPropertyType;
use Spatie\IcalendarGenerator\PropertyTypes\Parameter;
use Spatie\IcalendarGenerator\ValueObjects\CalendarAddress;

final class Event extends Component
{
    /** @var array */
    private $alerts = [];

    /** @var \DateTimeInterface */
    private $starts;

    /** @var \DateTimeInterface */
    private $ends;

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

    /** @var string|null */
    private $description;

    /** @var string|null */
    private $address;

    /** @var string|null */
    private $addressName;

    /** @var float|null */
    private $lat;

    /** @var float|null */
    private $lng;

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

    /** @var \DateTimeInterface */
    private $created;

    /** @var bool */
    private $withTimezone = false;

    /** @var bool */
    private $isFullDay = false;

    /** @var \Spatie\IcalendarGenerator\Enums\Classification|null */
    private $classification = null;

    /** @var bool|null */
    private $transparent = null;

    /** @var \Spatie\IcalendarGenerator\ValueObjects\CalendarAddress[] */
    private $attendees = [];

    /** @var \Spatie\IcalendarGenerator\ValueObjects\CalendarAddress|null */
    private $organizer = null;

    /** @var \Spatie\IcalendarGenerator\Enums\EventStatus|null */
    private $status = null;

    public static function create(string $name = null): Event
    {
        return new self($name);
    }

    public function __construct(string $name = null)
    {
        $this->name = $name;
        $this->uuid = uniqid();
        $this->created = new DateTimeImmutable();
    }

    public function getComponentType(): string
    {
        return 'EVENT';
    }

    public function getRequiredProperties(): array
    {
        return [
            'UID',
            'DTSTAMP',
            'DTSTART',
        ];
    }

    public function startsAt(DateTimeInterface $starts): Event
    {
        $this->starts = $starts;

        return $this;
    }

    public function endsAt(DateTimeInterface $ends): Event
    {
        $this->ends = $ends;

        return $this;
    }

    public function period(DateTimeInterface $starts, DateTimeInterface $ends): Event
    {
        $this->starts = $starts;
        $this->ends = $ends;

        return $this;
    }

    public function name(string $name): Event
    {
        $this->name = $name;

        return $this;
    }

    public function description(string $description): Event
    {
        $this->description = $description;

        return $this;
    }

    public function address(string $address, string $name = null): Event
    {
        $this->address = $address;

        if ($name) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->addressName = $name;
        }

        return $this;
    }

    public function addressName(string $name): Event
    {
        $this->addressName = $name;

        return $this;
    }

    public function coordinates(float $lat, float $lng): Event
    {
        $this->lat = $lat;
        $this->lng = $lng;

        return $this;
    }

    public function uniqueIdentifier(string $uid): Event
    {
        $this->uuid = $uid;

        return $this;
    }

    public function createdAt(DateTimeInterface $created): Event
    {
        $this->created = $created;

        return $this;
    }

    public function withTimezone(): Event
    {
        $this->withTimezone = true;

        return $this;
    }

    public function fullDay(): Event
    {
        $this->isFullDay = true;

        return $this;
    }

    public function alert(Alert $alert): Event
    {
        $this->alerts[] = $alert;

        return $this;
    }

    public function alertMinutesBefore(int $minutes, string $message = null): Event
    {
        $this->alerts[] = Alert::minutesBeforeStart($minutes, $message);

        return $this;
    }

    public function alertMinutesAfter(int $minutes, string $message = null): Event
    {
        $this->alerts[] = Alert::minutesAfterEnd($minutes, $message);

        return $this;
    }

    public function classification(?Classification $classification): Event
    {
        $this->classification = $classification;

        return $this;
    }

    public function transparent(): Event
    {
        $this->transparent = true;

        return $this;
    }

    public function attendee(
        string $email,
        string $name = null,
        ParticipationStatus $participationStatus = null
    ): Event {
        $this->attendees[] = new CalendarAddress($email, $name, $participationStatus);

        return $this;
    }

    public function organizer(string $email, string $name = null): Event
    {
        $this->organizer = new CalendarAddress($email, $name);

        return $this;
    }

    public function status(EventStatus $status): Event
    {
        $this->status = $status;

        return $this;
    }

    protected function payload(): ComponentPayload
    {
        $payload = ComponentPayload::create($this->getComponentType())
            ->textProperty('UID', $this->uuid)
            ->textProperty('SUMMARY', $this->name)
            ->textProperty('DESCRIPTION', $this->description)
            ->textProperty('LOCATION', $this->address)
            ->textProperty('CLASS', $this->classification)
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            ->textProperty('TRANSP', $this->transparent ? 'TRANSPARENT' : null)
            ->textProperty('STATUS', $this->status)
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            ->dateTimeProperty('DTSTART', $this->starts, ! $this->isFullDay, $this->withTimezone)
            ->dateTimeProperty('DTEND', $this->ends, ! $this->isFullDay, $this->withTimezone)
            ->dateTimeProperty('DTSTAMP', $this->created, true, $this->withTimezone)
            ->subComponent(...$this->alerts);

        if ($this->organizer) {
            $payload->property(CalendarAddressPropertyType::create('ORGANIZER', $this->organizer));
        }

        foreach ($this->attendees as $attendee) {
            $payload->property(CalendarAddressPropertyType::create('ATTENDEE', $attendee));
        }

        $payload = $this->resolveLocationProperties($payload);

        return $payload;
    }

    private function resolveLocationProperties(ComponentPayload $payload): ComponentPayload
    {
        if (is_null($this->lng) && is_null($this->lat)) {
            return $payload;
        }

        $payload->property(CoordinatesPropertyType::create('GEO', $this->lat, $this->lng));

        if (is_null($this->address)) {
            return $payload;
        }

        $property = CoordinatesPropertyType::create(
            'X-APPLE-STRUCTURED-LOCATION',
            $this->lat,
            $this->lng
        )->addParameter(Parameter::create('VALUE', 'URI'))
            ->addParameter(Parameter::create('X-ADDRESS', $this->address))
            ->addParameter(Parameter::create('X-APPLE-RADIUS', 72))
            ->addParameter(Parameter::create('X-TITLE', $this->addressName));

        $payload->property($property);

        return $payload;
    }
}


1			<?php
2
3			namespace Spatie\IcalendarGenerator\Components;
4
5			use DateTimeImmutable;
6			use DateTimeInterface;
7			use Spatie\IcalendarGenerator\ComponentPayload;
8			use Spatie\IcalendarGenerator\Enums\Classification;
9			use Spatie\IcalendarGenerator\Enums\EventStatus;
10			use Spatie\IcalendarGenerator\Enums\ParticipationStatus;
11			use Spatie\IcalendarGenerator\PropertyTypes\CalendarAddressPropertyType;
12			use Spatie\IcalendarGenerator\PropertyTypes\CoordinatesPropertyType;
13			use Spatie\IcalendarGenerator\PropertyTypes\Parameter;
14			use Spatie\IcalendarGenerator\ValueObjects\CalendarAddress;
15
16			final class Event extends Component
17			{
18			/** @var array */
19			private $alerts = [];
20
21			/** @var \DateTimeInterface */
22			private $starts;
23
24			/** @var \DateTimeInterface */
25			private $ends;
26
27			/** @var string */
28			private $name;
29
30			/** @var string\|null */
31			private $description;
32
33			/** @var string\|null */
34			private $address;
35
36			/** @var string\|null */
37			private $addressName;
38
39			/** @var float\|null */
40			private $lat;
41
42			/** @var float\|null */
43			private $lng;
44
45			/** @var string */
46			private $uuid;
47
48			/** @var \DateTimeInterface */
49			private $created;
50
51			/** @var bool */
52			private $withTimezone = false;
53
54			/** @var bool */
55			private $isFullDay = false;
56
57			/** @var \Spatie\IcalendarGenerator\Enums\Classification\|null */
58			private $classification = null;
59
60			/** @var bool\|null */
61			private $transparent = null;
62
63			/** @var \Spatie\IcalendarGenerator\ValueObjects\CalendarAddress[] */
64			private $attendees = [];
65
66			/** @var \Spatie\IcalendarGenerator\ValueObjects\CalendarAddress\|null */
67			private $organizer = null;
68
69			/** @var \Spatie\IcalendarGenerator\Enums\EventStatus\|null */
70			private $status = null;
71
72			public static function create(string $name = null): Event
73			{
74			return new self($name);
75			}
76
77			public function __construct(string $name = null)
78			{
79			$this->name = $name;
80			$this->uuid = uniqid();
81			$this->created = new DateTimeImmutable();
82			}
83
84			public function getComponentType(): string
85			{
86			return 'EVENT';
87			}
88
89			public function getRequiredProperties(): array
90			{
91			return [
92			'UID',
93			'DTSTAMP',
94			'DTSTART',
95			];
96			}
97
98			public function startsAt(DateTimeInterface $starts): Event
99			{
100			$this->starts = $starts;
101
102			return $this;
103			}
104
105			public function endsAt(DateTimeInterface $ends): Event
106			{
107			$this->ends = $ends;
108
109			return $this;
110			}
111
112			public function period(DateTimeInterface $starts, DateTimeInterface $ends): Event
113			{
114			$this->starts = $starts;
115			$this->ends = $ends;
116
117			return $this;
118			}
119
120			public function name(string $name): Event
121			{
122			$this->name = $name;
123
124			return $this;
125			}
126
127			public function description(string $description): Event
128			{
129			$this->description = $description;
130
131			return $this;
132			}
133
134			public function address(string $address, string $name = null): Event
135			{
136			$this->address = $address;
137
138			if ($name) {
			0 ignored issues – show Bug Best Practice introduced 2019-10-28 16:03 UTC by Report Bug Copy Issue Report The expression `$name` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
139			$this->addressName = $name;
140			}
141
142			return $this;
143			}
144
145			public function addressName(string $name): Event
146			{
147			$this->addressName = $name;
148
149			return $this;
150			}
151
152			public function coordinates(float $lat, float $lng): Event
153			{
154			$this->lat = $lat;
155			$this->lng = $lng;
156
157			return $this;
158			}
159
160			public function uniqueIdentifier(string $uid): Event
161			{
162			$this->uuid = $uid;
163
164			return $this;
165			}
166
167			public function createdAt(DateTimeInterface $created): Event
168			{
169			$this->created = $created;
170
171			return $this;
172			}
173
174			public function withTimezone(): Event
175			{
176			$this->withTimezone = true;
177
178			return $this;
179			}
180
181			public function fullDay(): Event
182			{
183			$this->isFullDay = true;
184
185			return $this;
186			}
187
188			public function alert(Alert $alert): Event
189			{
190			$this->alerts[] = $alert;
191
192			return $this;
193			}
194
195			public function alertMinutesBefore(int $minutes, string $message = null): Event
196			{
197			$this->alerts[] = Alert::minutesBeforeStart($minutes, $message);
198
199			return $this;
200			}
201
202			public function alertMinutesAfter(int $minutes, string $message = null): Event
203			{
204			$this->alerts[] = Alert::minutesAfterEnd($minutes, $message);
205
206			return $this;
207			}
208
209			public function classification(?Classification $classification): Event
210			{
211			$this->classification = $classification;
212
213			return $this;
214			}
215
216			public function transparent(): Event
217			{
218			$this->transparent = true;
219
220			return $this;
221			}
222
223			public function attendee(
224			string $email,
225			string $name = null,
226			ParticipationStatus $participationStatus = null
227			): Event {
228			$this->attendees[] = new CalendarAddress($email, $name, $participationStatus);
229
230			return $this;
231			}
232
233			public function organizer(string $email, string $name = null): Event
234			{
235			$this->organizer = new CalendarAddress($email, $name);
236
237			return $this;
238			}
239
240			public function status(EventStatus $status): Event
241			{
242			$this->status = $status;
243
244			return $this;
245			}
246
247			protected function payload(): ComponentPayload
248			{
249			$payload = ComponentPayload::create($this->getComponentType())
250			->textProperty('UID', $this->uuid)
251			->textProperty('SUMMARY', $this->name)
252			->textProperty('DESCRIPTION', $this->description)
253			->textProperty('LOCATION', $this->address)
254			->textProperty('CLASS', $this->classification)
			0 ignored issues – show Bug introduced 2020-01-15 14:36 UTC by Report Bug Copy Issue Report It seems like `$this->classification` can also be of type `object<Spatie\IcalendarG...r\Enums\Classification>`; however, `Spatie\IcalendarGenerato...Payload::textProperty()` does only seem to accept `string\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
255			->textProperty('TRANSP', $this->transparent ? 'TRANSPARENT' : null)
256			->textProperty('STATUS', $this->status)
			0 ignored issues – show Bug introduced 2020-01-16 15:49 UTC by Report Bug Copy Issue Report It seems like `$this->status` can also be of type `object<Spatie\IcalendarG...ator\Enums\EventStatus>`; however, `Spatie\IcalendarGenerato...Payload::textProperty()` does only seem to accept `string\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
257			->dateTimeProperty('DTSTART', $this->starts, ! $this->isFullDay, $this->withTimezone)
258			->dateTimeProperty('DTEND', $this->ends, ! $this->isFullDay, $this->withTimezone)
259			->dateTimeProperty('DTSTAMP', $this->created, true, $this->withTimezone)
260			->subComponent(...$this->alerts);
261
262			if ($this->organizer) {
263			$payload->property(CalendarAddressPropertyType::create('ORGANIZER', $this->organizer));
264			}
265
266			foreach ($this->attendees as $attendee) {
267			$payload->property(CalendarAddressPropertyType::create('ATTENDEE', $attendee));
268			}
269
270			$payload = $this->resolveLocationProperties($payload);
271
272			return $payload;
273			}
274
275			private function resolveLocationProperties(ComponentPayload $payload): ComponentPayload
276			{
277			if (is_null($this->lng) && is_null($this->lat)) {
278			return $payload;
279			}
280
281			$payload->property(CoordinatesPropertyType::create('GEO', $this->lat, $this->lng));
282
283			if (is_null($this->address)) {
284			return $payload;
285			}
286
287			$property = CoordinatesPropertyType::create(
288			'X-APPLE-STRUCTURED-LOCATION',
289			$this->lat,
290			$this->lng
291			)->addParameter(Parameter::create('VALUE', 'URI'))
292			->addParameter(Parameter::create('X-ADDRESS', $this->address))
293			->addParameter(Parameter::create('X-APPLE-RADIUS', 72))
294			->addParameter(Parameter::create('X-TITLE', $this->addressName));
295
296			$payload->property($property);
297
298			return $payload;
299			}
300			}
301

spatie / icalendar-generator

GitHub Access Token became invalid

Push — master ( d65602...7abf9d )

Event::status() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like