Spatie\IcalendarGenerator\Components\Event

Complexity

Total Complexity

16

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	__construct()	0	6	1
A	getComponentType()	0	4	1
A	getRequiredProperties()	0	8	1
A	startsAt()	0	6	1
A	endsAt()	0	6	1
A	period()	0	7	1
A	name()	0	6	1
A	description()	0	6	1
A	location()	0	6	1
A	uniqueIdentifier()	0	6	1
A	createdAt()	0	6	1
A	fullDay()	0	6	1
A	alertMinutesBefore()	0	11	1
A	getPayload()	0	12	1
A	withTimezones()	0	6	1

<?php

namespace Spatie\IcalendarGenerator\Components;

use DateInterval;
use DateTimeImmutable;
use DateTimeInterface;
use Spatie\IcalendarGenerator\ComponentPayload;

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 $location;

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

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

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

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

    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 location(string $location): Event
    {
        $this->location = $location;

        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 withTimezones(): Event
    {
        $this->withTimezones = true;

        return $this;
    }

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

        return $this;
    }

    public function alertMinutesBefore(int $minutes, string $message = null): Event
    {
        $trigger = clone $this->starts;

        $this->alerts[] = Alert::create(
            $trigger->sub(new DateInterval("PT{$minutes}M")),
            $message ?? $this->name
        );

        return $this;
    }

    public function getPayload(): ComponentPayload
    {
        return ComponentPayload::create($this->getComponentType())
            ->textProperty('UID', $this->uuid)
            ->textProperty('SUMMARY', $this->name)
            ->textProperty('DESCRIPTION', $this->description)
            ->textProperty('LOCATION', $this->location)
            ->dateTimeProperty('DTSTART', $this->starts, ! $this->isFullDay, $this->withTimezones)
            ->dateTimeProperty('DTEND', $this->ends, ! $this->isFullDay, $this->withTimezones)
            ->dateTimeProperty('DTSTAMP', $this->created, true, $this->withTimezones)
            ->subComponent(...$this->alerts);
    }
}