Calendar::payload() - Code Metrics - Inspection of "Add possibility to extend the properties and subco..." - spatie/icalendar-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b0f2f1...6d15b0 )

by Ruben

created 2019-12-17 15:51 UTC

Calendar::payload() A

↳ Parent: Calendar

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	28
rs	9.472
c	0
b	0
f	0
cc	3
nc	4
nop	0

<?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) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $payload
                ->property(
                    DurationPropertyType::create('REFRESH-INTERVAL', $this->refreshInterval)
                        ->addParameter(new Parameter('VALUE', 'DURATION'))
                )
                ->property(DurationPropertyType::create('X-PUBLISHED-TTL', $this->refreshInterval));
        }

        return $payload;
    }
}


1			<?php
2
3			namespace Spatie\IcalendarGenerator\Components;
4
5			use Closure;
6			use Spatie\IcalendarGenerator\ComponentPayload;
7			use Spatie\IcalendarGenerator\PropertyTypes\DurationPropertyType;
8			use Spatie\IcalendarGenerator\PropertyTypes\Parameter;
9
10			final class Calendar extends Component
11			{
12			/** @var array */
13			private $events = [];
14
15			/** @var string\|null */
16			private $name;
17
18			/** @var string\|null */
19			private $description;
20
21			/** @var bool */
22			private $withTimezone = false;
23
24			/** @var int\|null */
25			private $refreshInterval;
26
27			/** @var string\|null */
28			private $productIdentifier;
29
30			public static function create(string $name = null): Calendar
31			{
32			return new self($name);
33			}
34
35			public function __construct(string $name = null)
36			{
37			$this->name = $name;
38			}
39
40			public function getComponentType(): string
41			{
42			return 'CALENDAR';
43			}
44
45			public function getRequiredProperties(): array
46			{
47			return [
48			'VERSION',
49			'PRODID',
50			];
51			}
52
53			public function name(string $name): Calendar
54			{
55			$this->name = $name;
56
57			return $this;
58			}
59
60			public function description(string $description): Calendar
61			{
62			$this->description = $description;
63
64			return $this;
65			}
66
67			public function productIdentifier(string $identifier): Calendar
68			{
69			$this->productIdentifier = $identifier;
70
71			return $this;
72			}
73
74			/**
75			* @param $event \Spatie\IcalendarGenerator\Components\Event\|array\|Closure
76			*
77			* @return \Spatie\IcalendarGenerator\Components\Calendar
78			*/
79			public function event($event): Calendar
80			{
81			if (is_null($event)) {
82			return $this;
83			}
84
85			$events = array_map(function ($eventToResolve) {
86			if (! is_callable($eventToResolve)) {
87			return $eventToResolve;
88			}
89
90			$newEvent = new Event();
91
92			$eventToResolve($newEvent);
93
94			return $newEvent;
95			}, is_array($event) ? $event : [$event]);
96
97			$this->events = array_merge($this->events, $events);
98
99			return $this;
100			}
101
102			public function withTimezone(): Calendar
103			{
104			$this->withTimezone = true;
105
106			return $this;
107			}
108
109			public function refreshInterval(int $minutes): Calendar
110			{
111			$this->refreshInterval = $minutes;
112
113			return $this;
114			}
115
116			public function get(): string
117			{
118			return $this->toString();
119			}
120
121			protected function payload(): ComponentPayload
122			{
123			$events = $this->events;
124
125			if ($this->withTimezone) {
126			array_walk($events, function (Event $event) {
127			$event->withTimezone();
128			});
129			}
130
131			$payload = ComponentPayload::create($this->getComponentType())
132			->textProperty('VERSION', '2.0')
133			->textProperty('PRODID', $this->productIdentifier ?? 'spatie/icalendar-generator')
134			->textProperty(['NAME', 'X-WR-CALNAME'], $this->name)
135			->textProperty(['DESCRIPTION', 'X-WR-CALDESC'], $this->description)
136			->subComponent(...$events);
137
138			if ($this->refreshInterval) {
			0 ignored issues – show Bug Best Practice introduced 2019-10-28 16:03 UTC by Report Bug Copy Issue Report 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. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
139			$payload
140			->property(
141			DurationPropertyType::create('REFRESH-INTERVAL', $this->refreshInterval)
142			->addParameter(new Parameter('VALUE', 'DURATION'))
143			)
144			->property(DurationPropertyType::create('X-PUBLISHED-TTL', $this->refreshInterval));
145			}
146
147			return $payload;
148			}
149			}
150

spatie / icalendar-generator

GitHub Access Token became invalid

Push — master ( b0f2f1...6d15b0 )

Calendar::payload() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like