Spatie\IcalendarGenerator\Components\Calendar

Complexity

Total Complexity

17

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	__construct()	0	4	1
A	getComponentType()	0	4	1
A	getRequiredProperties()	0	7	1
A	name()	0	6	1
A	description()	0	6	1
A	productIdentifier()	0	6	1
A	event()	0	22	4
A	withTimezone()	0	6	1
A	refreshInterval()	0	6	1
A	get()	0	4	1
A	payload()	0	28	3

<?php

namespace Spatie\IcalendarGenerator\Components;

use Closure;
use Spatie\IcalendarGenerator\ComponentPayload;
use Spatie\IcalendarGenerator\PropertyTypes\DurationPropertyType;
use Spatie\IcalendarGenerator\PropertyTypes\Parameter;

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

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

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

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

    /** @var int|null */
    private $refreshInterval;

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

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

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

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

    public function getRequiredProperties(): array
    {
        return [
            'VERSION',
            'PRODID',
        ];
    }

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

        return $this;
    }

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

        return $this;
    }

    public function productIdentifier(string $identifier): Calendar
    {
        $this->productIdentifier = $identifier;

        return $this;
    }

    /**
     * @param $event \Spatie\IcalendarGenerator\Components\Event|array|Closure
     *
     * @return \Spatie\IcalendarGenerator\Components\Calendar
     */
    public function event($event): Calendar
    {
        if (is_null($event)) {
            return $this;
        }

        $events = array_map(function ($eventToResolve) {
            if (! is_callable($eventToResolve)) {
                return $eventToResolve;
            }

            $newEvent = new Event();

            $eventToResolve($newEvent);

            return $newEvent;
        }, is_array($event) ? $event : [$event]);

        $this->events = array_merge($this->events, $events);

        return $this;
    }

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

        return $this;
    }

    public function refreshInterval(int $minutes): Calendar
    {
        $this->refreshInterval = $minutes;

        return $this;
    }

    public function get(): string
    {
        return $this->toString();
    }

    protected function payload(): ComponentPayload
    {
        $events = $this->events;

        if ($this->withTimezone) {
            array_walk($events, function (Event $event) {
                $event->withTimezone();
            });
        }

        $payload = ComponentPayload::create($this->getComponentType())
            ->textProperty('VERSION', '2.0')
            ->textProperty('PRODID', $this->productIdentifier ?? 'spatie/icalendar-generator')
            ->textProperty(['NAME', 'X-WR-CALNAME'], $this->name)
            ->textProperty(['DESCRIPTION', 'X-WR-CALDESC'], $this->description)
            ->subComponent(...$events);

        if ($this->refreshInterval) {

The expression $this->refreshInterval of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

            $payload
                ->property(
                    DurationPropertyType::create('REFRESH-INTERVAL', $this->refreshInterval)
                        ->addParameter(new Parameter('VALUE', 'DURATION'))
                )
                ->property(DurationPropertyType::create('X-PUBLISHED-TTL', $this->refreshInterval));
        }

        return $payload;
    }
}