Event::resolveLocationProperties() - Code Metrics - spatie/icalendar-generator - Measure and Improve Code Quality continuously with Scrutinizer

Event::resolveLocationProperties() A
last analyzed 2020-10-12 09:08 UTC

↳ Parent: Event

Complexity

Conditions	5
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	25
rs	9.2088
c	0
b	0
f	0
cc	5
nc	3
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;

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

    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;
    }

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

        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)
            ->textProperty('TRANSP', $this->transparent ? 'TRANSPARENT' : null)
            ->textProperty('STATUS', $this->status)
            ->uriProperty('URL', $this->url)
            ->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) || is_null($this->addressName)) {
            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			/** @var string\|null */
73			private $url;
74
75			public static function create(string $name = null): Event
76			{
77			return new self($name);
78			}
79
80			public function __construct(string $name = null)
81			{
82			$this->name = $name;
83			$this->uuid = uniqid();
84			$this->created = new DateTimeImmutable();
85			}
86
87			public function getComponentType(): string
88			{
89			return 'EVENT';
90			}
91
92			public function getRequiredProperties(): array
93			{
94			return [
95			'UID',
96			'DTSTAMP',
97			'DTSTART',
98			];
99			}
100
101			public function startsAt(DateTimeInterface $starts): Event
102			{
103			$this->starts = $starts;
104
105			return $this;
106			}
107
108			public function endsAt(DateTimeInterface $ends): Event
109			{
110			$this->ends = $ends;
111
112			return $this;
113			}
114
115			public function period(DateTimeInterface $starts, DateTimeInterface $ends): Event
116			{
117			$this->starts = $starts;
118			$this->ends = $ends;
119
120			return $this;
121			}
122
123			public function name(string $name): Event
124			{
125			$this->name = $name;
126
127			return $this;
128			}
129
130			public function description(string $description): Event
131			{
132			$this->description = $description;
133
134			return $this;
135			}
136
137			public function address(string $address, string $name = null): Event
138			{
139			$this->address = $address;
140
141			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...
142			$this->addressName = $name;
143			}
144
145			return $this;
146			}
147
148			public function addressName(string $name): Event
149			{
150			$this->addressName = $name;
151
152			return $this;
153			}
154
155			public function coordinates(float $lat, float $lng): Event
156			{
157			$this->lat = $lat;
158			$this->lng = $lng;
159
160			return $this;
161			}
162
163			public function uniqueIdentifier(string $uid): Event
164			{
165			$this->uuid = $uid;
166
167			return $this;
168			}
169
170			public function createdAt(DateTimeInterface $created): Event
171			{
172			$this->created = $created;
173
174			return $this;
175			}
176
177			public function withTimezone(): Event
178			{
179			$this->withTimezone = true;
180
181			return $this;
182			}
183
184			public function fullDay(): Event
185			{
186			$this->isFullDay = true;
187
188			return $this;
189			}
190
191			public function alert(Alert $alert): Event
192			{
193			$this->alerts[] = $alert;
194
195			return $this;
196			}
197
198			public function alertMinutesBefore(int $minutes, string $message = null): Event
199			{
200			$this->alerts[] = Alert::minutesBeforeStart($minutes, $message);
201
202			return $this;
203			}
204
205			public function alertMinutesAfter(int $minutes, string $message = null): Event
206			{
207			$this->alerts[] = Alert::minutesAfterEnd($minutes, $message);
208
209			return $this;
210			}
211
212			public function classification(?Classification $classification): Event
213			{
214			$this->classification = $classification;
215
216			return $this;
217			}
218
219			public function transparent(): Event
220			{
221			$this->transparent = true;
222
223			return $this;
224			}
225
226			public function attendee(
227			string $email,
228			string $name = null,
229			ParticipationStatus $participationStatus = null
230			): Event {
231			$this->attendees[] = new CalendarAddress($email, $name, $participationStatus);
232
233			return $this;
234			}
235
236			public function organizer(string $email, string $name = null): Event
237			{
238			$this->organizer = new CalendarAddress($email, $name);
239
240			return $this;
241			}
242
243			public function status(EventStatus $status): Event
244			{
245			$this->status = $status;
246
247			return $this;
248			}
249
250			public function url(string $url): Event
251			{
252			$this->url = $url;
253
254			return $this;
255			}
256
257			protected function payload(): ComponentPayload
258			{
259			$payload = ComponentPayload::create($this->getComponentType())
260			->textProperty('UID', $this->uuid)
261			->textProperty('SUMMARY', $this->name)
262			->textProperty('DESCRIPTION', $this->description)
263			->textProperty('LOCATION', $this->address)
264			->textProperty('CLASS', $this->classification)
265			->textProperty('TRANSP', $this->transparent ? 'TRANSPARENT' : null)
266			->textProperty('STATUS', $this->status)
267			->uriProperty('URL', $this->url)
268			->dateTimeProperty('DTSTART', $this->starts, ! $this->isFullDay, $this->withTimezone)
269			->dateTimeProperty('DTEND', $this->ends, ! $this->isFullDay, $this->withTimezone)
270			->dateTimeProperty('DTSTAMP', $this->created, true, $this->withTimezone)
271			->subComponent(...$this->alerts);
272
273			if ($this->organizer) {
274			$payload->property(CalendarAddressPropertyType::create('ORGANIZER', $this->organizer));
275			}
276
277			foreach ($this->attendees as $attendee) {
278			$payload->property(CalendarAddressPropertyType::create('ATTENDEE', $attendee));
279			}
280
281			$payload = $this->resolveLocationProperties($payload);
282
283			return $payload;
284			}
285
286			private function resolveLocationProperties(ComponentPayload $payload): ComponentPayload
287			{
288			if (is_null($this->lng) && is_null($this->lat)) {
289			return $payload;
290			}
291
292			$payload->property(CoordinatesPropertyType::create('GEO', $this->lat, $this->lng));
293
294			if (is_null($this->address) \|\| is_null($this->addressName)) {
295			return $payload;
296			}
297
298			$property = CoordinatesPropertyType::create(
299			'X-APPLE-STRUCTURED-LOCATION',
300			$this->lat,
301			$this->lng
302			)->addParameter(Parameter::create('VALUE', 'URI'))
303			->addParameter(Parameter::create('X-ADDRESS', $this->address))
304			->addParameter(Parameter::create('X-APPLE-RADIUS', '72'))
305			->addParameter(Parameter::create('X-TITLE', $this->addressName));
306
307			$payload->property($property);
308
309			return $payload;
310			}
311			}
312

spatie / icalendar-generator

GitHub Access Token became invalid

Event::resolveLocationProperties() A last analyzed 2020-10-12 09:08 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Event::resolveLocationProperties() A
last analyzed 2020-10-12 09:08 UTC