Calendar::getType() - Code Metrics - Inspection of "Merge pull request #114 from peter279k/test_enhanc..." - markuspoerschke/iCal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5db245...cdc2ed )

by Markus

created 2018-05-02 09:03 UTC

Calendar::getType() A

↳ Parent: Calendar

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
nc	1
cc	1
eloc	2
nop	0
crap	1

<?php

/*
 * This file is part of the eluceo/iCal package.
 *
 * (c) Markus Poerschke <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Eluceo\iCal\Component;

use Eluceo\iCal\Component;
use Eluceo\iCal\PropertyBag;

class Calendar extends Component
{
    /**
     * Methods for calendar components.
     *
     * According to RFC 5545: 3.7.2. Method
     *
     * @see http://tools.ietf.org/html/rfc5545#section-3.7.2
     *
     * And then according to RFC 2446: 3 APPLICATION PROTOCOL ELEMENTS
     * @see https://tools.ietf.org/html/rfc2446#section-3.2
     */
    const METHOD_PUBLISH = 'PUBLISH';
    const METHOD_REQUEST = 'REQUEST';
    const METHOD_REPLY = 'REPLY';
    const METHOD_ADD = 'ADD';
    const METHOD_CANCEL = 'CANCEL';
    const METHOD_REFRESH = 'REFRESH';
    const METHOD_COUNTER = 'COUNTER';
    const METHOD_DECLINECOUNTER = 'DECLINECOUNTER';

    /**
     * This property defines the calendar scale used for the calendar information specified in the iCalendar object.
     *
     * According to RFC 5545: 3.7.1. Calendar Scale
     *
     * @see http://tools.ietf.org/html/rfc5545#section-3.7
     */
    const CALSCALE_GREGORIAN = 'GREGORIAN';

    /**
     * The Product Identifier.
     *
     * According to RFC 5545: 3.7.3 Product Identifier
     *
     * This property specifies the identifier for the product that created the Calendar object.
     *
     * @see https://tools.ietf.org/html/rfc5545#section-3.7.3
     *
     * @var string
     */
    protected $prodId = null;
    protected $method = null;
    protected $name = null;
    protected $description = null;
    protected $timezone = null;

    /**
     * This property defines the calendar scale used for the
     * calendar information specified in the iCalendar object.
     *
     * Also identifies the calendar type of a non-Gregorian recurring appointment.
     *
     * @var string
     *
     * @see http://tools.ietf.org/html/rfc5545#section-3.7
     * @see http://msdn.microsoft.com/en-us/library/ee237520(v=exchg.80).aspx
     */
    protected $calendarScale = null;

    /**
     * Specifies whether or not the iCalendar file only contains one appointment.
     *
     * @var bool
     *
     * @see http://msdn.microsoft.com/en-us/library/ee203486(v=exchg.80).aspx
     */
    protected $forceInspectOrOpen = false;

    /**
     * Specifies a globally unique identifier for the calendar.
     *
     * @var string
     *
     * @see http://msdn.microsoft.com/en-us/library/ee179588(v=exchg.80).aspx
     */
    protected $calId = null;

    /**
     * Specifies a suggested iCalendar file download frequency for clients and
     * servers with sync capabilities.
     *
     * For example you can set the value to 'P1W' if the calendar should be
     * synced once a week. Use 'P3H' to sync the file every 3 hours.
     *
     * @var string
     *
     * @see http://msdn.microsoft.com/en-us/library/ee178699(v=exchg.80).aspx
     */
    protected $publishedTTL = null;

    /**
     * Specifies a color for the calendar in calendar for Apple/Outlook.
     *
     * @var string
     *
     * @see http://msdn.microsoft.com/en-us/library/ee179588(v=exchg.80).aspx
     */
    protected $calendarColor = null;

    public function __construct($prodId)
    {
        if (empty($prodId)) {
            throw new \UnexpectedValueException('PRODID cannot be empty');
        }

        $this->prodId = $prodId;
    }

    /**
     * {@inheritdoc}
     */
    public function getType()
    {
        return 'VCALENDAR';
    }

    /**
     * @param $method
     *
     * @return $this
     */
    public function setMethod($method)
    {
        $this->method = $method;

        return $this;
    }

    /**
     * @param $name
     *
     * @return $this
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * @param $description
     *
     * @return $this
     */
    public function setDescription($description)
    {
        $this->description = $description;

        return $this;
    }

    /**
     * @param $timezone
     *
     * @return $this
     */
    public function setTimezone($timezone)
    {
        $this->timezone = $timezone;

        return $this;
    }

    /**
     * @param $calendarColor
     *
     * @return $this
     */
    public function setCalendarColor($calendarColor)
    {
        $this->calendarColor = $calendarColor;

        return $this;
    }

    /**
     * @param $calendarScale
     *
     * @return $this
     */
    public function setCalendarScale($calendarScale)
    {
        $this->calendarScale = $calendarScale;

        return $this;
    }

    /**
     * @param bool $forceInspectOrOpen
     *
     * @return $this
     */
    public function setForceInspectOrOpen($forceInspectOrOpen)
    {
        $this->forceInspectOrOpen = $forceInspectOrOpen;

        return $this;
    }

    /**
     * @param string $calId
     *
     * @return $this
     */
    public function setCalId($calId)
    {
        $this->calId = $calId;

        return $this;
    }

    /**
     * @param string $ttl
     *
     * @return $this
     */
    public function setPublishedTTL($ttl)
    {
        $this->publishedTTL = $ttl;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function buildPropertyBag()
    {
        $propertyBag = new PropertyBag();
        $propertyBag->set('VERSION', '2.0');
        $propertyBag->set('PRODID', $this->prodId);

        if ($this->method) {
            $propertyBag->set('METHOD', $this->method);
        }

        if ($this->calendarColor) {
            $propertyBag->set('X-APPLE-CALENDAR-COLOR', $this->calendarColor);
            $propertyBag->set('X-OUTLOOK-COLOR', $this->calendarColor);
            $propertyBag->set('X-FUNAMBOL-COLOR', $this->calendarColor);
        }

        if ($this->calendarScale) {
            $propertyBag->set('CALSCALE', $this->calendarScale);
            $propertyBag->set('X-MICROSOFT-CALSCALE', $this->calendarScale);
        }

        if ($this->name) {
            $propertyBag->set('X-WR-CALNAME', $this->name);
        }

        if ($this->description) {
            $propertyBag->set('X-WR-CALDESC', $this->description);
        }

        if ($this->timezone) {
            if ($this->timezone instanceof Timezone) {
                $propertyBag->set('X-WR-TIMEZONE', $this->timezone->getZoneIdentifier());
                $this->addComponent($this->timezone);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            } else {
                $propertyBag->set('X-WR-TIMEZONE', $this->timezone);
                $this->addComponent(new Timezone($this->timezone));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
        }

        if ($this->forceInspectOrOpen) {
            $propertyBag->set('X-MS-OLK-FORCEINSPECTOROPEN', $this->forceInspectOrOpen);
        }

        if ($this->calId) {
            $propertyBag->set('X-WR-RELCALID', $this->calId);
        }

        if ($this->publishedTTL) {
            $propertyBag->set('X-PUBLISHED-TTL', $this->publishedTTL);
        }

        return $propertyBag;
    }

    /**
     * Adds an Event to the Calendar.
     *
     * Wrapper for addComponent()
     *
     * @see        Eluceo\iCal::addComponent
     * @deprecated Please, use public method addComponent() from abstract Component class
     *
     * @param Event $event
     */
    public function addEvent(Event $event)
    {
        $this->addComponent($event);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @return null|string
     */
    public function getProdId()
    {
        return $this->prodId;
    }

    public function getMethod()
    {
        return $this->method;
    }
}


1		<?php
2
3		/*
4		* This file is part of the eluceo/iCal package.
5		*
6		* (c) Markus Poerschke <[email protected]>
7		*
8		* This source file is subject to the MIT license that is bundled
9		* with this source code in the file LICENSE.
10		*/
11
12		namespace Eluceo\iCal\Component;
13
14		use Eluceo\iCal\Component;
15		use Eluceo\iCal\PropertyBag;
16
17		class Calendar extends Component
18		{
19		/**
20		* Methods for calendar components.
21		*
22		* According to RFC 5545: 3.7.2. Method
23		*
24		* @see http://tools.ietf.org/html/rfc5545#section-3.7.2
25		*
26		* And then according to RFC 2446: 3 APPLICATION PROTOCOL ELEMENTS
27		* @see https://tools.ietf.org/html/rfc2446#section-3.2
28		*/
29		const METHOD_PUBLISH = 'PUBLISH';
30		const METHOD_REQUEST = 'REQUEST';
31		const METHOD_REPLY = 'REPLY';
32		const METHOD_ADD = 'ADD';
33		const METHOD_CANCEL = 'CANCEL';
34		const METHOD_REFRESH = 'REFRESH';
35		const METHOD_COUNTER = 'COUNTER';
36		const METHOD_DECLINECOUNTER = 'DECLINECOUNTER';
37
38		/**
39		* This property defines the calendar scale used for the calendar information specified in the iCalendar object.
40		*
41		* According to RFC 5545: 3.7.1. Calendar Scale
42		*
43		* @see http://tools.ietf.org/html/rfc5545#section-3.7
44		*/
45		const CALSCALE_GREGORIAN = 'GREGORIAN';
46
47		/**
48		* The Product Identifier.
49		*
50		* According to RFC 5545: 3.7.3 Product Identifier
51		*
52		* This property specifies the identifier for the product that created the Calendar object.
53		*
54		* @see https://tools.ietf.org/html/rfc5545#section-3.7.3
55		*
56		* @var string
57		*/
58		protected $prodId = null;
59		protected $method = null;
60		protected $name = null;
61		protected $description = null;
62		protected $timezone = null;
63
64		/**
65		* This property defines the calendar scale used for the
66		* calendar information specified in the iCalendar object.
67		*
68		* Also identifies the calendar type of a non-Gregorian recurring appointment.
69		*
70		* @var string
71		*
72		* @see http://tools.ietf.org/html/rfc5545#section-3.7
73		* @see http://msdn.microsoft.com/en-us/library/ee237520(v=exchg.80).aspx
74		*/
75		protected $calendarScale = null;
76
77		/**
78		* Specifies whether or not the iCalendar file only contains one appointment.
79		*
80		* @var bool
81		*
82		* @see http://msdn.microsoft.com/en-us/library/ee203486(v=exchg.80).aspx
83		*/
84		protected $forceInspectOrOpen = false;
85
86		/**
87		* Specifies a globally unique identifier for the calendar.
88		*
89		* @var string
90		*
91		* @see http://msdn.microsoft.com/en-us/library/ee179588(v=exchg.80).aspx
92		*/
93		protected $calId = null;
94
95		/**
96		* Specifies a suggested iCalendar file download frequency for clients and
97		* servers with sync capabilities.
98		*
99		* For example you can set the value to 'P1W' if the calendar should be
100		* synced once a week. Use 'P3H' to sync the file every 3 hours.
101		*
102		* @var string
103		*
104		* @see http://msdn.microsoft.com/en-us/library/ee178699(v=exchg.80).aspx
105		*/
106		protected $publishedTTL = null;
107
108		/**
109		* Specifies a color for the calendar in calendar for Apple/Outlook.
110		*
111		* @var string
112		*
113		* @see http://msdn.microsoft.com/en-us/library/ee179588(v=exchg.80).aspx
114		*/
115		protected $calendarColor = null;
116
117	19	public function __construct($prodId)
118		{
119	19	if (empty($prodId)) {
120	1	throw new \UnexpectedValueException('PRODID cannot be empty');
121		}
122
123	18	$this->prodId = $prodId;
124	18	}
125
126		/**
127		* {@inheritdoc}
128		*/
129	17	public function getType()
130		{
131	17	return 'VCALENDAR';
132		}
133
134		/**
135		* @param $method
136		*
137		* @return $this
138		*/
139	1	public function setMethod($method)
140		{
141	1	$this->method = $method;
142
143	1	return $this;
144		}
145
146		/**
147		* @param $name
148		*
149		* @return $this
150		*/
151	1	public function setName($name)
152		{
153	1	$this->name = $name;
154
155	1	return $this;
156		}
157
158		/**
159		* @param $description
160		*
161		* @return $this
162		*/
163	1	public function setDescription($description)
164		{
165	1	$this->description = $description;
166
167	1	return $this;
168		}
169
170		/**
171		* @param $timezone
172		*
173		* @return $this
174		*/
175	2	public function setTimezone($timezone)
176		{
177	2	$this->timezone = $timezone;
178
179	2	return $this;
180		}
181
182		/**
183		* @param $calendarColor
184		*
185		* @return $this
186		*/
187	1	public function setCalendarColor($calendarColor)
188		{
189	1	$this->calendarColor = $calendarColor;
190
191	1	return $this;
192		}
193
194		/**
195		* @param $calendarScale
196		*
197		* @return $this
198		*/
199	1	public function setCalendarScale($calendarScale)
200		{
201	1	$this->calendarScale = $calendarScale;
202
203	1	return $this;
204		}
205
206		/**
207		* @param bool $forceInspectOrOpen
208		*
209		* @return $this
210		*/
211	1	public function setForceInspectOrOpen($forceInspectOrOpen)
212		{
213	1	$this->forceInspectOrOpen = $forceInspectOrOpen;
214
215	1	return $this;
216		}
217
218		/**
219		* @param string $calId
220		*
221		* @return $this
222		*/
223	1	public function setCalId($calId)
224		{
225	1	$this->calId = $calId;
226
227	1	return $this;
228		}
229
230		/**
231		* @param string $ttl
232		*
233		* @return $this
234		*/
235	1	public function setPublishedTTL($ttl)
236		{
237	1	$this->publishedTTL = $ttl;
238
239	1	return $this;
240		}
241
242		/**
243		* {@inheritdoc}
244		*/
245	17	public function buildPropertyBag()
246		{
247	17	$propertyBag = new PropertyBag();
248	17	$propertyBag->set('VERSION', '2.0');
249	17	$propertyBag->set('PRODID', $this->prodId);
250
251	17	if ($this->method) {
252	1	$propertyBag->set('METHOD', $this->method);
253		}
254
255	17	if ($this->calendarColor) {
256	1	$propertyBag->set('X-APPLE-CALENDAR-COLOR', $this->calendarColor);
257	1	$propertyBag->set('X-OUTLOOK-COLOR', $this->calendarColor);
258	1	$propertyBag->set('X-FUNAMBOL-COLOR', $this->calendarColor);
259		}
260
261	17	if ($this->calendarScale) {
262	1	$propertyBag->set('CALSCALE', $this->calendarScale);
263	1	$propertyBag->set('X-MICROSOFT-CALSCALE', $this->calendarScale);
264		}
265
266	17	if ($this->name) {
267	1	$propertyBag->set('X-WR-CALNAME', $this->name);
268		}
269
270	17	if ($this->description) {
271	1	$propertyBag->set('X-WR-CALDESC', $this->description);
272		}
273
274	17	if ($this->timezone) {
275	2	if ($this->timezone instanceof Timezone) {
276	1	$propertyBag->set('X-WR-TIMEZONE', $this->timezone->getZoneIdentifier());
277	1	$this->addComponent($this->timezone);
		0 ignored issues – show Documentation introduced 2017-11-28 16:35 UTC by Report Bug Copy Issue Report `$this->timezone` is of type `object<Eluceo\iCal\Component\Timezone>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
278		} else {
279	1	$propertyBag->set('X-WR-TIMEZONE', $this->timezone);
280	1	$this->addComponent(new Timezone($this->timezone));
		0 ignored issues – show Documentation introduced 2017-11-28 16:35 UTC by Report Bug Copy Issue Report `new \Eluceo\iCal\Compone...mezone($this->timezone)` is of type `object<Eluceo\iCal\Component\Timezone>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
281		}
282		}
283
284	17	if ($this->forceInspectOrOpen) {
285	1	$propertyBag->set('X-MS-OLK-FORCEINSPECTOROPEN', $this->forceInspectOrOpen);
286		}
287
288	17	if ($this->calId) {
289	1	$propertyBag->set('X-WR-RELCALID', $this->calId);
290		}
291
292	17	if ($this->publishedTTL) {
293	1	$propertyBag->set('X-PUBLISHED-TTL', $this->publishedTTL);
294		}
295
296	17	return $propertyBag;
297		}
298
299		/**
300		* Adds an Event to the Calendar.
301		*
302		* Wrapper for addComponent()
303		*
304		* @see Eluceo\iCal::addComponent
305		* @deprecated Please, use public method addComponent() from abstract Component class
306		*
307		* @param Event $event
308		*/
309	1	public function addEvent(Event $event)
310		{
311	1	$this->addComponent($event);
		0 ignored issues – show Documentation introduced 2017-11-28 16:35 UTC by Report Bug Copy Issue Report `$event` is of type `object<Eluceo\iCal\Component\Event>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
312	1	}
313
314		/**
315		* @return null\|string
316		*/
317	1	public function getProdId()
318		{
319	1	return $this->prodId;
320		}
321
322	1	public function getMethod()
323		{
324	1	return $this->method;
325		}
326		}
327

markuspoerschke / iCal

Push — master ( 5db245...cdc2ed )

Calendar::getType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like