Spatie\IcalendarGenerator\Components\Alert

Complexity

Total Complexity

17

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	date()	0	4	1
A	minutesBeforeStart()	0	7	1
A	minutesAfterStart()	0	4	1
A	minutesBeforeEnd()	0	7	1
A	minutesAfterEnd()	0	4	1
A	create()	0	4	1
A	__construct()	0	4	1
A	getComponentType()	0	4	1
A	getRequiredProperties()	0	8	1
A	message()	0	6	1
A	triggerDate()	0	7	1
A	triggerAtStart()	0	7	1
A	triggerAtEnd()	0	7	1
A	payload()	0	7	1
A	resolveTriggerProperty()	0	18	3

<?php

namespace Spatie\IcalendarGenerator\Components;

use DateInterval;
use DateTimeInterface;
use Spatie\IcalendarGenerator\ComponentPayload;
use Spatie\IcalendarGenerator\PropertyTypes\DateTimePropertyType;
use Spatie\IcalendarGenerator\PropertyTypes\DurationPropertyType;
use Spatie\IcalendarGenerator\PropertyTypes\Parameter;

final class Alert extends Component
{
    private const TRIGGER_START = 'trigger_start';
    private const TRIGGER_END = 'trigger_end';
    private const TRIGGER_DATE = 'trigger_date';

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

    /** @var DateInterval */
    private $triggerInterval;

    /** @var string */
    private $triggerMode = self::TRIGGER_DATE;

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

    public static function date(DateTimeInterface $date, string $description = null): Alert
    {
        return static::create($description)->triggerDate($date);

Since Spatie\IcalendarGenerator\Components\Alert is declared final, using late-static binding will have no effect. You might want to replace static with self instead.

    }

    public static function minutesBeforeStart(int $minutes, string $description = null): Alert
    {
        $interval = new DateInterval("PT{$minutes}M");
        $interval->invert = 1;

        return static::create($description)->triggerAtStart($interval);

Since Spatie\IcalendarGenerator\Components\Alert is declared final, using late-static binding will have no effect. You might want to replace static with self instead.

    }

    public static function minutesAfterStart(int $minutes, string $description = null): Alert
    {
        return static::create($description)->triggerAtStart(new DateInterval("PT{$minutes}M"));

Since Spatie\IcalendarGenerator\Components\Alert is declared final, using late-static binding will have no effect. You might want to replace static with self instead.

    }

    public static function minutesBeforeEnd(int $minutes, string $description = null): Alert
    {
        $interval = new DateInterval("PT{$minutes}M");
        $interval->invert = 1;

        return static::create($description)->triggerAtEnd($interval);

Since Spatie\IcalendarGenerator\Components\Alert is declared final, using late-static binding will have no effect. You might want to replace static with self instead.

    }

    public static function minutesAfterEnd(int $minutes, string $description = null): Alert
    {
        return static::create($description)->triggerAtEnd(new DateInterval("PT{$minutes}M"));

Since Spatie\IcalendarGenerator\Components\Alert is declared final, using late-static binding will have no effect. You might want to replace static with self instead.

    }

    private static function create(string $description = null): Alert
    {
        return new self($description);
    }

    public function __construct(string $description = null)
    {
        $this->message = $description;
    }

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

    public function getRequiredProperties(): array
    {
        return [
            'ACTION',
            'TRIGGER',
            'DESCRIPTION',
        ];
    }

    public function message(string $message): Alert
    {
        $this->message = $message;

        return $this;
    }

    public function triggerDate(DateTimeInterface $triggerAt): Alert
    {
        $this->triggerMode = self::TRIGGER_DATE;
        $this->triggerDate = $triggerAt;

        return $this;
    }

    public function triggerAtStart(DateInterval $interval): Alert
    {
        $this->triggerMode = self::TRIGGER_START;
        $this->triggerInterval = $interval;

        return $this;
    }

    public function triggerAtEnd(DateInterval $interval): Alert
    {
        $this->triggerMode = self::TRIGGER_END;
        $this->triggerInterval = $interval;

        return $this;
    }

    protected function payload(): ComponentPayload
    {
        return ComponentPayload::create($this->getComponentType())
            ->textProperty('ACTION', 'DISPLAY')
            ->textProperty('DESCRIPTION', $this->message)
            ->property($this->resolveTriggerProperty());
    }

    private function resolveTriggerProperty()
    {
        if ($this->triggerMode === self::TRIGGER_DATE) {
            return DateTimePropertyType::create(
                'TRIGGER',
                $this->triggerDate,
                true
            )->addParameter(new Parameter('VALUE', 'DATE-TIME'));
        }

        $property = DurationPropertyType::create('TRIGGER', $this->triggerInterval);

        if ($this->triggerMode === self::TRIGGER_END) {
            return $property->addParameter(new Parameter('RELATED', 'END'));
        }

        return $property;
    }
}