Event - Code Metrics - Inspection of "Merge pull request #93 from jrjohnson/null-geo" - markuspoerschke/iCal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5705c5...a00397 )

by Markus

created 2017-04-24 21:32 UTC

Event D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	851
Duplicated Lines	1.53 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

25.91%

Importance

Changes	10
Bugs	1	Features	0

Metric	Value
wmc	80
c	10
b	1
f	0
lcom	1
cbo	9
dl	13
loc	851
ccs	57
cts	220
cp	0.2591
rs	4.4444

47 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	getType()	0	4	1
F	buildPropertyBag()	0	126	25
A	setDtEnd()	0	6	1
A	getDtEnd()	0	4	1
A	setDtStart()	0	6	1
A	getDtStart()	0	4	1
A	setDtStamp()	0	6	1
A	setDuration()	0	6	1
A	setGeoLocation()	0	6	1
A	setNoTime()	0	6	1
A	setSequence()	0	6	1
A	getSequence()	0	4	1
A	setOrganizer()	0	6	1
A	setSummary()	0	6	1
A	setUniqueId()	0	6	1
A	getUniqueId()	0	4	1
A	setUrl()	0	6	1
A	setUseTimezone()	0	6	1
A	getUseTimezone()	0	4	1
A	setTimezoneString()	0	6	1
A	getTimezoneString()	0	4	1
A	setAttendees()	0	6	1
A	addAttendee()	0	6	1
A	getAttendees()	0	4	1
A	setDescription()	0	6	1
A	setDescriptionHTML()	0	6	1
A	setUseUtc()	0	6	1
A	getDescription()	0	4	1
A	getDescriptionHTML()	0	4	1
A	setCancelled()	0	6	1
A	setTimeTransparency()	13	13	3
A	setStatus()	0	14	4
A	setRecurrenceRule()	0	8	1
A	getRecurrenceRule()	0	6	1
A	addRecurrenceRule()	0	6	1
A	getRecurrenceRules()	0	4	1
A	setCreated()	0	6	1
A	setModified()	0	6	1
A	setCategories()	0	6	1
A	setIsPrivate()	0	6	1
A	addExDate()	0	6	1
A	getExDates()	0	4	1
A	setExDates()	0	6	1
A	getRecurrenceId()	0	4	1
A	setRecurrenceId()	0	6	1
A	setLocation()	0	18	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Event often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Event, and based on these observations, apply Extract Interface, too.

<?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\Property;
use Eluceo\iCal\Property\DateTimeProperty;
use Eluceo\iCal\Property\DateTimesProperty;
use Eluceo\iCal\Property\Event\Attendees;
use Eluceo\iCal\Property\Event\Geo;
use Eluceo\iCal\Property\Event\Organizer;
use Eluceo\iCal\Property\Event\RecurrenceId;
use Eluceo\iCal\Property\Event\RecurrenceRule;
use Eluceo\iCal\Property\RawStringValue;
use Eluceo\iCal\PropertyBag;

/**
 * Implementation of the EVENT component.
 */
class Event extends Component
{
    const TIME_TRANSPARENCY_OPAQUE = 'OPAQUE';
    const TIME_TRANSPARENCY_TRANSPARENT = 'TRANSPARENT';

    const STATUS_TENTATIVE = 'TENTATIVE';
    const STATUS_CONFIRMED = 'CONFIRMED';
    const STATUS_CANCELLED = 'CANCELLED';

    /**
     * @var string
     */
    protected $uniqueId;

    /**
     * The property indicates the date/time that the instance of
     * the iCalendar object was created.
     *
     * The value MUST be specified in the UTC time format.
     *
     * @var \DateTime
     */
    protected $dtStamp;

    /**
     * @var \DateTime
     */
    protected $dtStart;

    /**
     * Preferentially chosen over the duration if both are set.
     *
     * @var \DateTime
     */
    protected $dtEnd;

    /**
     * @var \DateInterval
     */
    protected $duration;

    /**
     * @var bool
     */
    protected $noTime = false;

    /**
     * @var string
     */
    protected $url;

    /**
     * @var string
     */
    protected $location;

    /**
     * @var string
     */
    protected $locationTitle;

    /**
     * @var Geo
     */
    protected $locationGeo;

    /**
     * @var string
     */
    protected $summary;

    /**
     * @var Organizer
     */
    protected $organizer;

    /**
     * @see https://tools.ietf.org/html/rfc5545#section-3.8.2.7
     *
     * @var string
     */
    protected $transparency = self::TIME_TRANSPARENCY_OPAQUE;

    /**
     * If set to true the timezone will be added to the event.
     *
     * @var bool
     */
    protected $useTimezone = false;

    /**
     * If set will we used as the timezone identifier.
     *
     * @var string
     */
    protected $timezoneString = '';

    /**
     * @var int
     */
    protected $sequence = 0;

    /**
     * @var Attendees
     */
    protected $attendees;

    /**
     * @var string
     */
    protected $description;

    /**
     * @var string
     */
    protected $descriptionHTML;

    /**
     * @var string
     */
    protected $status;

    /**
     * @var RecurrenceRule
     */
    protected $recurrenceRule;

    /**
     * @var array
     */
    protected $recurrenceRules = [];

    /**
     * This property specifies the date and time that the calendar
     * information was created.
     *
     * The value MUST be specified in the UTC time format.
     *
     * @var \DateTime
     */
    protected $created;

    /**
     * The property specifies the date and time that the information
     * associated with the calendar component was last revised.
     *
     * The value MUST be specified in the UTC time format.
     *
     * @var \DateTime
     */
    protected $modified;

    /**
     * Indicates if the UTC time should be used or not.
     *
     * @var bool
     */
    protected $useUtc = true;

    /**
     * @var bool
     */
    protected $cancelled;

    /**
     * This property is used to specify categories or subtypes
     * of the calendar component.  The categories are useful in searching
     * for a calendar component of a particular type and category.
     *
     * @see https://tools.ietf.org/html/rfc5545#section-3.8.1.2
     *
     * @var array
     */
    protected $categories;

    /**
     * https://tools.ietf.org/html/rfc5545#section-3.8.1.3.
     *
     * @var bool
     */
    protected $isPrivate = false;

    /**
     * Dates to be excluded from a series of events.
     *
     * @var \DateTimeInterface[]
     */
    protected $exDates = [];

    /**
     * @var RecurrenceId
     */
    protected $recurrenceId;

    public function __construct(string $uniqueId = null)
    {
        if (null == $uniqueId) {

            $uniqueId = uniqid();
        }

        $this->uniqueId = $uniqueId;
        $this->attendees = new Attendees();
    }

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

    /**
     * {@inheritdoc}
     */
    public function buildPropertyBag()
    {
        $propertyBag = new PropertyBag();

        // mandatory information
        $propertyBag->set('UID', $this->uniqueId);

        $propertyBag->add(new DateTimeProperty('DTSTART', $this->dtStart, $this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString));
        $propertyBag->set('SEQUENCE', $this->sequence);
        $propertyBag->set('TRANSP', $this->transparency);

        if ($this->status) {
            $propertyBag->set('STATUS', $this->status);
        }

        // An event can have a 'dtend' or 'duration', but not both.
        if ($this->dtEnd !== null) {
            if ($this->noTime === true) {
                $this->dtEnd->add(new \DateInterval('P1D'));
            }
            $propertyBag->add(new DateTimeProperty('DTEND', $this->dtEnd, $this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString));
        } elseif ($this->duration !== null) {
            $propertyBag->set('DURATION', $this->duration->format('P%dDT%hH%iM%sS'));
        }

        // optional information
        if (null != $this->url) {
            $propertyBag->set('URL', $this->url);
        }

        if (null != $this->location) {
            $propertyBag->set('LOCATION', $this->location);

            if (null != $this->locationGeo) {
                $propertyBag->add(
                    new Property(
                        'X-APPLE-STRUCTURED-LOCATION',
                        new RawStringValue('geo:' . $this->locationGeo->getGeoLocationAsString(',')),
                        [
                            'VALUE' => 'URI',
                            'X-ADDRESS' => $this->location,
                            'X-APPLE-RADIUS' => 49,
                            'X-TITLE' => $this->locationTitle,
                        ]
                    )
                );
            }
        }

        if (null != $this->locationGeo) {
            $propertyBag->add($this->locationGeo);
        }

        if (null != $this->summary) {
            $propertyBag->set('SUMMARY', $this->summary);
        }

        if (null != $this->attendees) {
            $propertyBag->add($this->attendees);
        }

        $propertyBag->set('CLASS', $this->isPrivate ? 'PRIVATE' : 'PUBLIC');

        if (null != $this->description) {
            $propertyBag->set('DESCRIPTION', $this->description);
        }

        if (null != $this->descriptionHTML) {
            $propertyBag->add(
                new Property(
                    'X-ALT-DESC',
                    $this->descriptionHTML,
                    [
                        'FMTTYPE' => 'text/html',
                    ]
                )
            );
        }

        if (null != $this->recurrenceRule) {
            $propertyBag->set('RRULE', $this->recurrenceRule);
        }

        foreach ($this->recurrenceRules as $recurrenceRule) {
            $propertyBag->set('RRULE', $recurrenceRule);
        }

        if (null != $this->recurrenceId) {
            $this->recurrenceId->applyTimeSettings($this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString);
            $propertyBag->add($this->recurrenceId);
        }

        if (!empty($this->exDates)) {
            $propertyBag->add(new DateTimesProperty('EXDATE', $this->exDates, $this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString));
        }

        if ($this->cancelled) {
            $propertyBag->set('STATUS', 'CANCELLED');
        }

        if (null != $this->organizer) {
            $propertyBag->add($this->organizer);
        }

        if ($this->noTime) {
            $propertyBag->set('X-MICROSOFT-CDO-ALLDAYEVENT', 'TRUE');
        }

        if (null != $this->categories) {
            $propertyBag->set('CATEGORIES', $this->categories);
        }

        $propertyBag->add(
            new DateTimeProperty('DTSTAMP', $this->dtStamp ?: new \DateTimeImmutable(), false, false, true)
        );

        if ($this->created) {
            $propertyBag->add(new DateTimeProperty('CREATED', $this->created, false, false, true));
        }

        if ($this->modified) {
            $propertyBag->add(new DateTimeProperty('LAST-MODIFIED', $this->modified, false, false, true));
        }

        return $propertyBag;
    }

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

        return $this;
    }

    public function getDtEnd()
    {
        return $this->dtEnd;
    }

    public function setDtStart($dtStart)
    {
        $this->dtStart = $dtStart;

        return $this;
    }

    public function getDtStart()
    {
        return $this->dtStart;
    }

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

        return $this;
    }

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

        return $this;
    }

    /**
     * @param string     $location
     * @param string     $title
     * @param Geo|string $geo
     *
     * @return $this
     */
    public function setLocation($location, $title = '', $geo = null)
    {
        if (is_scalar($geo)) {
            $geo = Geo::fromString($geo);

        } elseif (!is_null($geo) && !$geo instanceof Geo) {
            $className = get_class($geo);
            throw new \InvalidArgumentException(
                "The parameter 'geo' must be a string or an instance of " . Geo::class
                . " but an instance of {$className} was given."
            );
        }

        $this->location = $location;
        $this->locationTitle = $title;
        $this->locationGeo = $geo;

        return $this;
    }

    /**
     * @param Geo $geoProperty
     *
     * @return $this
     */
    public function setGeoLocation(Geo $geoProperty)
    {
        $this->locationGeo = $geoProperty;

        return $this;
    }

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

        return $this;
    }

    /**
     * @param int $sequence
     *
     * @return $this
     */
    public function setSequence($sequence)
    {
        $this->sequence = $sequence;

        return $this;
    }

    /**
     * @return int
     */
    public function getSequence()
    {
        return $this->sequence;
    }

    /**
     * @param Organizer $organizer
     *
     * @return $this
     */
    public function setOrganizer(Organizer $organizer)
    {
        $this->organizer = $organizer;

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

    /**
     * @return string
     */
    public function getUniqueId()
    {
        return $this->uniqueId;
    }

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

        return $this;
    }

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

        return $this;
    }

    /**
     * @return bool
     */
    public function getUseTimezone()
    {
        return $this->useTimezone;
    }

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

        return $this;
    }

    /**
     * @return bool
     */
    public function getTimezoneString()
    {
        return $this->timezoneString;
    }

    /**
     * @param Attendees $attendees
     *
     * @return $this
     */
    public function setAttendees(Attendees $attendees)
    {
        $this->attendees = $attendees;

        return $this;
    }

    /**
     * @param string $attendee
     * @param array  $params
     *
     * @return $this
     */
    public function addAttendee($attendee, $params = [])
    {
        $this->attendees->add($attendee, $params);

        return $this;
    }

    /**
     * @return Attendees
     */
    public function getAttendees(): Attendees
    {
        return $this->attendees;
    }

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

        return $this;
    }

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

        return $this;
    }

    /**
     * @param bool $useUtc
     *
     * @return $this
     */
    public function setUseUtc($useUtc = true)
    {
        $this->useUtc = $useUtc;

        return $this;
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @return string
     */
    public function getDescriptionHTML()
    {
        return $this->descriptionHTML;
    }

    /**
     * @param $status
     *
     * @return $this
     */
    public function setCancelled($status)
    {
        $this->cancelled = (bool) $status;

        return $this;
    }

    /**
     * @param $transparency
     *
     * @return $this
     *
     * @throws \InvalidArgumentException
     */
    public function setTimeTransparency($transparency)

    {
        $transparency = strtoupper($transparency);
        if ($transparency === self::TIME_TRANSPARENCY_OPAQUE
            || $transparency === self::TIME_TRANSPARENCY_TRANSPARENT
        ) {
            $this->transparency = $transparency;
        } else {
            throw new \InvalidArgumentException('Invalid value for transparancy');
        }

        return $this;
    }

    /**
     * @param $status
     *
     * @return $this
     *
     * @throws \InvalidArgumentException
     */
    public function setStatus($status)
    {
        $status = strtoupper($status);
        if ($status == self::STATUS_CANCELLED
            || $status == self::STATUS_CONFIRMED
            || $status == self::STATUS_TENTATIVE
        ) {
            $this->status = $status;
        } else {
            throw new \InvalidArgumentException('Invalid value for status');
        }

        return $this;
    }

    /**
     * @deprecated Deprecated since version 0.11.0, to be removed in 1.0. Use addRecurrenceRule instead.
     *
     * @param RecurrenceRule $recurrenceRule
     *
     * @return $this
     */
    public function setRecurrenceRule(RecurrenceRule $recurrenceRule)
    {
        @trigger_error('setRecurrenceRule() is deprecated since version 0.11.0 and will be removed in 1.0. Use addRecurrenceRule instead.', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        $this->recurrenceRule = $recurrenceRule;

        return $this;
    }

    /**
     * @deprecated Deprecated since version 0.11.0, to be removed in 1.0. Use getRecurrenceRules instead.
     *
     * @return RecurrenceRule
     */
    public function getRecurrenceRule()
    {
        @trigger_error('getRecurrenceRule() is deprecated since version 0.11.0 and will be removed in 1.0. Use getRecurrenceRules instead.', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        return $this->recurrenceRule;
    }

    /**
     * @param RecurrenceRule $recurrenceRule
     *
     * @return $this
     */
    public function addRecurrenceRule(RecurrenceRule $recurrenceRule)
    {
        $this->recurrenceRules[] = $recurrenceRule;

        return $this;
    }

    /**
     * @return array
     */
    public function getRecurrenceRules()
    {
        return $this->recurrenceRules;
    }

    /**
     * @param $dtStamp
     *
     * @return $this
     */
    public function setCreated($dtStamp)
    {
        $this->created = $dtStamp;

        return $this;
    }

    /**
     * @param $dtStamp
     *
     * @return $this
     */
    public function setModified($dtStamp)
    {
        $this->modified = $dtStamp;

        return $this;
    }

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

        return $this;
    }

    /**
     * Sets the event privacy.
     *
     * @param bool $flag
     *
     * @return $this
     */
    public function setIsPrivate($flag)
    {
        $this->isPrivate = (bool) $flag;

        return $this;
    }

    /**
     * @param \DateTimeInterface $dateTime
     *
     * @return \Eluceo\iCal\Component\Event
     */
    public function addExDate(\DateTimeInterface $dateTime)
    {
        $this->exDates[] = $dateTime;

        return $this;
    }

    /**
     * @return \DateTimeInterface[]
     */
    public function getExDates()
    {
        return $this->exDates;
    }

    /**
     * @param \DateTimeInterface[]
     *
     * @return \Eluceo\iCal\Component\Event
     */
    public function setExDates(array $exDates)
    {
        $this->exDates = $exDates;

        return $this;
    }

    /**
     * @return \Eluceo\iCal\Property\Event\RecurrenceId
     */
    public function getRecurrenceId()
    {
        return $this->recurrenceId;
    }

    /**
     * @param RecurrenceId $recurrenceId
     *
     * @return \Eluceo\iCal\Component\Event
     */
    public function setRecurrenceId(RecurrenceId $recurrenceId)
    {
        $this->recurrenceId = $recurrenceId;

        return $this;
    }
}


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\Property;
16			use Eluceo\iCal\Property\DateTimeProperty;
17			use Eluceo\iCal\Property\DateTimesProperty;
18			use Eluceo\iCal\Property\Event\Attendees;
19			use Eluceo\iCal\Property\Event\Geo;
20			use Eluceo\iCal\Property\Event\Organizer;
21			use Eluceo\iCal\Property\Event\RecurrenceId;
22			use Eluceo\iCal\Property\Event\RecurrenceRule;
23			use Eluceo\iCal\Property\RawStringValue;
24			use Eluceo\iCal\PropertyBag;
25
26			/**
27			* Implementation of the EVENT component.
28			*/
29			class Event extends Component
30			{
31			const TIME_TRANSPARENCY_OPAQUE = 'OPAQUE';
32			const TIME_TRANSPARENCY_TRANSPARENT = 'TRANSPARENT';
33
34			const STATUS_TENTATIVE = 'TENTATIVE';
35			const STATUS_CONFIRMED = 'CONFIRMED';
36			const STATUS_CANCELLED = 'CANCELLED';
37
38			/**
39			* @var string
40			*/
41			protected $uniqueId;
42
43			/**
44			* The property indicates the date/time that the instance of
45			* the iCalendar object was created.
46			*
47			* The value MUST be specified in the UTC time format.
48			*
49			* @var \DateTime
50			*/
51			protected $dtStamp;
52
53			/**
54			* @var \DateTime
55			*/
56			protected $dtStart;
57
58			/**
59			* Preferentially chosen over the duration if both are set.
60			*
61			* @var \DateTime
62			*/
63			protected $dtEnd;
64
65			/**
66			* @var \DateInterval
67			*/
68			protected $duration;
69
70			/**
71			* @var bool
72			*/
73			protected $noTime = false;
74
75			/**
76			* @var string
77			*/
78			protected $url;
79
80			/**
81			* @var string
82			*/
83			protected $location;
84
85			/**
86			* @var string
87			*/
88			protected $locationTitle;
89
90			/**
91			* @var Geo
92			*/
93			protected $locationGeo;
94
95			/**
96			* @var string
97			*/
98			protected $summary;
99
100			/**
101			* @var Organizer
102			*/
103			protected $organizer;
104
105			/**
106			* @see https://tools.ietf.org/html/rfc5545#section-3.8.2.7
107			*
108			* @var string
109			*/
110			protected $transparency = self::TIME_TRANSPARENCY_OPAQUE;
111
112			/**
113			* If set to true the timezone will be added to the event.
114			*
115			* @var bool
116			*/
117			protected $useTimezone = false;
118
119			/**
120			* If set will we used as the timezone identifier.
121			*
122			* @var string
123			*/
124			protected $timezoneString = '';
125
126			/**
127			* @var int
128			*/
129			protected $sequence = 0;
130
131			/**
132			* @var Attendees
133			*/
134			protected $attendees;
135
136			/**
137			* @var string
138			*/
139			protected $description;
140
141			/**
142			* @var string
143			*/
144			protected $descriptionHTML;
145
146			/**
147			* @var string
148			*/
149			protected $status;
150
151			/**
152			* @var RecurrenceRule
153			*/
154			protected $recurrenceRule;
155
156			/**
157			* @var array
158			*/
159			protected $recurrenceRules = [];
160
161			/**
162			* This property specifies the date and time that the calendar
163			* information was created.
164			*
165			* The value MUST be specified in the UTC time format.
166			*
167			* @var \DateTime
168			*/
169			protected $created;
170
171			/**
172			* The property specifies the date and time that the information
173			* associated with the calendar component was last revised.
174			*
175			* The value MUST be specified in the UTC time format.
176			*
177			* @var \DateTime
178			*/
179			protected $modified;
180
181			/**
182			* Indicates if the UTC time should be used or not.
183			*
184			* @var bool
185			*/
186			protected $useUtc = true;
187
188			/**
189			* @var bool
190			*/
191			protected $cancelled;
192
193			/**
194			* This property is used to specify categories or subtypes
195			* of the calendar component. The categories are useful in searching
196			* for a calendar component of a particular type and category.
197			*
198			* @see https://tools.ietf.org/html/rfc5545#section-3.8.1.2
199			*
200			* @var array
201			*/
202			protected $categories;
203
204			/**
205			* https://tools.ietf.org/html/rfc5545#section-3.8.1.3.
206			*
207			* @var bool
208			*/
209			protected $isPrivate = false;
210
211			/**
212			* Dates to be excluded from a series of events.
213			*
214			* @var \DateTimeInterface[]
215	4		*/
216			protected $exDates = [];
217	4
218	2		/**
219	2		* @var RecurrenceId
220			*/
221	4		protected $recurrenceId;
222	4
223			public function __construct(string $uniqueId = null)
224			{
225			if (null == $uniqueId) {
			0 ignored issues – show Bug introduced 2017-04-09 17:06 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$uniqueId` of type `null\|string` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `===` instead. Loading history...
226			$uniqueId = uniqid();
227	4		}
228
229	4		$this->uniqueId = $uniqueId;
230			$this->attendees = new Attendees();
231			}
232
233			/**
234			* {@inheritdoc}
235	4		*/
236			public function getType()
237	4		{
238			return 'VEVENT';
239			}
240	4
241			/**
242	4		* {@inheritdoc}
243	4		*/
244	4		public function buildPropertyBag()
245			{
246	4		$propertyBag = new PropertyBag();
247
248			// mandatory information
249			$propertyBag->set('UID', $this->uniqueId);
250
251	4		$propertyBag->add(new DateTimeProperty('DTSTART', $this->dtStart, $this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString));
252	2		$propertyBag->set('SEQUENCE', $this->sequence);
253			$propertyBag->set('TRANSP', $this->transparency);
254
255	2		if ($this->status) {
256	4		$propertyBag->set('STATUS', $this->status);
257			}
258
259			// An event can have a 'dtend' or 'duration', but not both.
260			if ($this->dtEnd !== null) {
261	4		if ($this->noTime === true) {
262			$this->dtEnd->add(new \DateInterval('P1D'));
263			}
264			$propertyBag->add(new DateTimeProperty('DTEND', $this->dtEnd, $this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString));
265	4		} elseif ($this->duration !== null) {
266			$propertyBag->set('DURATION', $this->duration->format('P%dDT%hH%iM%sS'));
267			}
268
269			// optional information
270			if (null != $this->url) {
271			$propertyBag->set('URL', $this->url);
272			}
273
274			if (null != $this->location) {
275			$propertyBag->set('LOCATION', $this->location);
276
277			if (null != $this->locationGeo) {
278			$propertyBag->add(
279			new Property(
280			'X-APPLE-STRUCTURED-LOCATION',
281			new RawStringValue('geo:' . $this->locationGeo->getGeoLocationAsString(',')),
282			[
283			'VALUE' => 'URI',
284			'X-ADDRESS' => $this->location,
285	4		'X-APPLE-RADIUS' => 49,
286			'X-TITLE' => $this->locationTitle,
287			]
288			)
289	4		);
290			}
291			}
292
293	4		if (null != $this->locationGeo) {
294			$propertyBag->add($this->locationGeo);
295	4		}
296	2
297	2		if (null != $this->summary) {
298			$propertyBag->set('SUMMARY', $this->summary);
299	4		}
300
301			if (null != $this->attendees) {
302			$propertyBag->add($this->attendees);
303			}
304
305			$propertyBag->set('CLASS', $this->isPrivate ? 'PRIVATE' : 'PUBLIC');
306
307			if (null != $this->description) {
308			$propertyBag->set('DESCRIPTION', $this->description);
309			}
310
311	4		if (null != $this->descriptionHTML) {
312			$propertyBag->add(
313			new Property(
314			'X-ALT-DESC',
315	4		$this->descriptionHTML,
316			[
317	4		'FMTTYPE' => 'text/html',
318			]
319	4		)
320			);
321			}
322
323			if (null != $this->recurrenceRule) {
324	4		$propertyBag->set('RRULE', $this->recurrenceRule);
325			}
326
327			foreach ($this->recurrenceRules as $recurrenceRule) {
328	4		$propertyBag->set('RRULE', $recurrenceRule);
329			}
330
331			if (null != $this->recurrenceId) {
332	4		$this->recurrenceId->applyTimeSettings($this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString);
333	2		$propertyBag->add($this->recurrenceId);
334	2		}
335
336	4		if (!empty($this->exDates)) {
337			$propertyBag->add(new DateTimesProperty('EXDATE', $this->exDates, $this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString));
338			}
339
340	4		if ($this->cancelled) {
341			$propertyBag->set('STATUS', 'CANCELLED');
342			}
343
344	4		if (null != $this->organizer) {
345	4		$propertyBag->add($this->organizer);
346	4		}
347
348	4		if ($this->noTime) {
349			$propertyBag->set('X-MICROSOFT-CDO-ALLDAYEVENT', 'TRUE');
350			}
351
352	4		if (null != $this->categories) {
353			$propertyBag->set('CATEGORIES', $this->categories);
354			}
355
356	4		$propertyBag->add(
357			new DateTimeProperty('DTSTAMP', $this->dtStamp ?: new \DateTimeImmutable(), false, false, true)
358			);
359
360			if ($this->created) {
361			$propertyBag->add(new DateTimeProperty('CREATED', $this->created, false, false, true));
362			}
363
364	2		if ($this->modified) {
365			$propertyBag->add(new DateTimeProperty('LAST-MODIFIED', $this->modified, false, false, true));
366	2		}
367
368	2		return $propertyBag;
369			}
370
371			/**
372			* @param $dtEnd
373			*
374			* @return $this
375			*/
376	2		public function setDtEnd($dtEnd)
377			{
378	2		$this->dtEnd = $dtEnd;
379
380	2		return $this;
381			}
382
383			public function getDtEnd()
384			{
385			return $this->dtEnd;
386			}
387
388			public function setDtStart($dtStart)
389			{
390			$this->dtStart = $dtStart;
391
392			return $this;
393			}
394
395			public function getDtStart()
396			{
397			return $this->dtStart;
398			}
399
400			/**
401			* @param $dtStamp
402			*
403			* @return $this
404			*/
405			public function setDtStamp($dtStamp)
406			{
407			$this->dtStamp = $dtStamp;
408
409			return $this;
410			}
411
412			/**
413			* @param $duration
414			*
415			* @return $this
416			*/
417			public function setDuration($duration)
418			{
419			$this->duration = $duration;
420
421			return $this;
422			}
423
424			/**
425			* @param string $location
426			* @param string $title
427			* @param Geo\|string $geo
428			*
429			* @return $this
430			*/
431			public function setLocation($location, $title = '', $geo = null)
432			{
433			if (is_scalar($geo)) {
434			$geo = Geo::fromString($geo);
			0 ignored issues – show Deprecated Code introduced 2017-04-20 22:13 UTC by Report Bug Copy Issue Report The method `Eluceo\iCal\Property\Event\Geo::fromString()` has been deprecated with message: This method is used to allow backwards compatibility for Event::setLocation This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
435			} elseif (!is_null($geo) && !$geo instanceof Geo) {
436			$className = get_class($geo);
437			throw new \InvalidArgumentException(
438			"The parameter 'geo' must be a string or an instance of " . Geo::class
439			. " but an instance of {$className} was given."
440			);
441			}
442
443			$this->location = $location;
444			$this->locationTitle = $title;
445			$this->locationGeo = $geo;
446
447			return $this;
448			}
449
450			/**
451			* @param Geo $geoProperty
452			*
453			* @return $this
454			*/
455			public function setGeoLocation(Geo $geoProperty)
456			{
457			$this->locationGeo = $geoProperty;
458
459			return $this;
460			}
461
462			/**
463			* @param $noTime
464			*
465	2		* @return $this
466			*/
467	2		public function setNoTime($noTime)
468			{
469	2		$this->noTime = $noTime;
470
471			return $this;
472			}
473
474			/**
475			* @param int $sequence
476			*
477			* @return $this
478			*/
479			public function setSequence($sequence)
480			{
481			$this->sequence = $sequence;
482
483			return $this;
484			}
485
486			/**
487			* @return int
488			*/
489			public function getSequence()
490			{
491			return $this->sequence;
492			}
493
494			/**
495			* @param Organizer $organizer
496			*
497			* @return $this
498			*/
499			public function setOrganizer(Organizer $organizer)
500			{
501			$this->organizer = $organizer;
502
503			return $this;
504			}
505
506			/**
507			* @param $summary
508			*
509			* @return $this
510			*/
511			public function setSummary($summary)
512			{
513			$this->summary = $summary;
514
515			return $this;
516			}
517
518			/**
519			* @param $uniqueId
520			*
521			* @return $this
522			*/
523			public function setUniqueId($uniqueId)
524			{
525			$this->uniqueId = $uniqueId;
526
527			return $this;
528			}
529
530			/**
531			* @return string
532			*/
533			public function getUniqueId()
534			{
535			return $this->uniqueId;
536			}
537
538			/**
539			* @param $url
540			*
541			* @return $this
542			*/
543			public function setUrl($url)
544			{
545			$this->url = $url;
546
547			return $this;
548			}
549
550			/**
551			* @param $useTimezone
552			*
553			* @return $this
554			*/
555			public function setUseTimezone($useTimezone)
556			{
557			$this->useTimezone = $useTimezone;
558
559			return $this;
560			}
561
562			/**
563			* @return bool
564			*/
565			public function getUseTimezone()
566			{
567			return $this->useTimezone;
568			}
569
570			/**
571			* @param $timezoneString
572			*
573			* @return $this
574			*/
575			public function setTimezoneString($timezoneString)
576			{
577	2		$this->timezoneString = $timezoneString;
578
579	2		return $this;
580			}
581	2
582			/**
583			* @return bool
584			*/
585			public function getTimezoneString()
586			{
587			return $this->timezoneString;
588			}
589
590			/**
591			* @param Attendees $attendees
592			*
593			* @return $this
594			*/
595			public function setAttendees(Attendees $attendees)
596			{
597			$this->attendees = $attendees;
598
599			return $this;
600			}
601
602			/**
603			* @param string $attendee
604			* @param array $params
605			*
606			* @return $this
607			*/
608			public function addAttendee($attendee, $params = [])
609			{
610			$this->attendees->add($attendee, $params);
611
612			return $this;
613			}
614
615			/**
616			* @return Attendees
617			*/
618			public function getAttendees(): Attendees
619			{
620			return $this->attendees;
621			}
622
623			/**
624			* @param $description
625			*
626			* @return $this
627			*/
628			public function setDescription($description)
629			{
630			$this->description = $description;
631
632			return $this;
633			}
634
635			/**
636			* @param $descriptionHTML
637			*
638			* @return $this
639			*/
640			public function setDescriptionHTML($descriptionHTML)
641			{
642			$this->descriptionHTML = $descriptionHTML;
643
644			return $this;
645			}
646
647			/**
648			* @param bool $useUtc
649			*
650			* @return $this
651			*/
652			public function setUseUtc($useUtc = true)
653			{
654			$this->useUtc = $useUtc;
655
656			return $this;
657			}
658
659			/**
660			* @return string
661			*/
662			public function getDescription()
663			{
664			return $this->description;
665			}
666
667			/**
668			* @return string
669			*/
670			public function getDescriptionHTML()
671			{
672			return $this->descriptionHTML;
673			}
674
675			/**
676			* @param $status
677			*
678			* @return $this
679			*/
680			public function setCancelled($status)
681			{
682			$this->cancelled = (bool) $status;
683
684			return $this;
685			}
686
687			/**
688			* @param $transparency
689			*
690			* @return $this
691			*
692			* @throws \InvalidArgumentException
693			*/
694		View Code Duplication	public function setTimeTransparency($transparency)
			0 ignored issues – show Duplication introduced 2015-12-04 09:21 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
695			{
696			$transparency = strtoupper($transparency);
697			if ($transparency === self::TIME_TRANSPARENCY_OPAQUE
698			\|\| $transparency === self::TIME_TRANSPARENCY_TRANSPARENT
699			) {
700			$this->transparency = $transparency;
701			} else {
702			throw new \InvalidArgumentException('Invalid value for transparancy');
703			}
704
705			return $this;
706			}
707
708			/**
709			* @param $status
710			*
711			* @return $this
712			*
713			* @throws \InvalidArgumentException
714			*/
715			public function setStatus($status)
716			{
717			$status = strtoupper($status);
718			if ($status == self::STATUS_CANCELLED
719			\|\| $status == self::STATUS_CONFIRMED
720			\|\| $status == self::STATUS_TENTATIVE
721			) {
722			$this->status = $status;
723			} else {
724			throw new \InvalidArgumentException('Invalid value for status');
725			}
726
727			return $this;
728			}
729
730			/**
731			* @deprecated Deprecated since version 0.11.0, to be removed in 1.0. Use addRecurrenceRule instead.
732			*
733			* @param RecurrenceRule $recurrenceRule
734			*
735			* @return $this
736			*/
737			public function setRecurrenceRule(RecurrenceRule $recurrenceRule)
738			{
739			@trigger_error('setRecurrenceRule() is deprecated since version 0.11.0 and will be removed in 1.0. Use addRecurrenceRule instead.', E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2016-08-30 16:46 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
740
741			$this->recurrenceRule = $recurrenceRule;
742
743			return $this;
744			}
745
746			/**
747			* @deprecated Deprecated since version 0.11.0, to be removed in 1.0. Use getRecurrenceRules instead.
748			*
749			* @return RecurrenceRule
750			*/
751			public function getRecurrenceRule()
752			{
753			@trigger_error('getRecurrenceRule() is deprecated since version 0.11.0 and will be removed in 1.0. Use getRecurrenceRules instead.', E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2016-08-30 16:46 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
754
755			return $this->recurrenceRule;
756			}
757
758			/**
759			* @param RecurrenceRule $recurrenceRule
760			*
761			* @return $this
762			*/
763			public function addRecurrenceRule(RecurrenceRule $recurrenceRule)
764			{
765			$this->recurrenceRules[] = $recurrenceRule;
766
767			return $this;
768			}
769
770			/**
771			* @return array
772			*/
773			public function getRecurrenceRules()
774			{
775			return $this->recurrenceRules;
776			}
777
778			/**
779			* @param $dtStamp
780			*
781			* @return $this
782			*/
783			public function setCreated($dtStamp)
784			{
785			$this->created = $dtStamp;
786
787			return $this;
788			}
789
790			/**
791			* @param $dtStamp
792			*
793			* @return $this
794			*/
795			public function setModified($dtStamp)
796			{
797			$this->modified = $dtStamp;
798
799			return $this;
800			}
801
802			/**
803			* @param $categories
804			*
805			* @return $this
806			*/
807			public function setCategories($categories)
808			{
809			$this->categories = $categories;
810
811			return $this;
812			}
813
814			/**
815			* Sets the event privacy.
816			*
817			* @param bool $flag
818			*
819			* @return $this
820			*/
821			public function setIsPrivate($flag)
822			{
823			$this->isPrivate = (bool) $flag;
824
825			return $this;
826			}
827
828			/**
829			* @param \DateTimeInterface $dateTime
830			*
831			* @return \Eluceo\iCal\Component\Event
832			*/
833			public function addExDate(\DateTimeInterface $dateTime)
834			{
835			$this->exDates[] = $dateTime;
836
837			return $this;
838			}
839
840			/**
841			* @return \DateTimeInterface[]
842			*/
843			public function getExDates()
844			{
845			return $this->exDates;
846			}
847
848			/**
849			* @param \DateTimeInterface[]
850			*
851			* @return \Eluceo\iCal\Component\Event
852			*/
853			public function setExDates(array $exDates)
854			{
855			$this->exDates = $exDates;
856
857			return $this;
858			}
859
860			/**
861			* @return \Eluceo\iCal\Property\Event\RecurrenceId
862			*/
863			public function getRecurrenceId()
864			{
865			return $this->recurrenceId;
866			}
867
868			/**
869			* @param RecurrenceId $recurrenceId
870			*
871			* @return \Eluceo\iCal\Component\Event
872			*/
873			public function setRecurrenceId(RecurrenceId $recurrenceId)
874			{
875			$this->recurrenceId = $recurrenceId;
876
877			return $this;
878			}
879			}
880

markuspoerschke / iCal