Event - 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

Event D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	852
Duplicated Lines	1.53 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

55.87%

Importance

Changes	8
Bugs	1	Features	0

Metric	Value
wmc	80
lcom	1
cbo	9
dl	13
loc	852
ccs	119
cts	213
cp	0.5587
rs	4.4444
c	8
b	1
f	0

47 Methods

Rating	Name	Duplication	Size	Complexity
A	getUseTimezone()	0	4	1
A	setTimezoneString()	0	6	1
A	getAttendees()	0	4	1
A	getDescription()	0	4	1
A	setIsPrivate()	0	6	1
A	__construct()	0	9	2
A	getType()	0	4	1
F	buildPropertyBag()	0	127	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	setLocation()	0	18	4
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	getTimezoneString()	0	4	1
A	setAttendees()	0	6	1
A	addAttendee()	0	6	1
A	setDescription()	0	6	1
A	setDescriptionHTML()	0	6	1
A	setUseUtc()	0	6	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	addExDate()	0	6	1
A	getExDates()	0	4	1
A	setExDates()	0	6	1
A	getRecurrenceId()	0	4	1
A	setRecurrenceId()	0	6	1

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) {
            $dtEnd = clone $this->dtEnd;
            if ($this->noTime === true) {
                $dtEnd = $dtEnd->add(new \DateInterval('P1D'));
            }
            $propertyBag->add(new DateTimeProperty('DTEND', $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			*/
216			protected $exDates = [];
217
218			/**
219			* @var RecurrenceId
220			*/
221			protected $recurrenceId;
222
223	25		public function __construct(string $uniqueId = null)
224			{
225	25		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	3		$uniqueId = uniqid();
227			}
228
229	25		$this->uniqueId = $uniqueId;
230	25		$this->attendees = new Attendees();
231	25		}
232
233			/**
234			* {@inheritdoc}
235			*/
236	6		public function getType()
237			{
238	6		return 'VEVENT';
239			}
240
241			/**
242			* {@inheritdoc}
243			*/
244	16		public function buildPropertyBag()
245			{
246	16		$propertyBag = new PropertyBag();
247
248			// mandatory information
249	16		$propertyBag->set('UID', $this->uniqueId);
250
251	16		$propertyBag->add(new DateTimeProperty('DTSTART', $this->dtStart, $this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString));
252	16		$propertyBag->set('SEQUENCE', $this->sequence);
253	16		$propertyBag->set('TRANSP', $this->transparency);
254
255	16		if ($this->status) {
256			$propertyBag->set('STATUS', $this->status);
257			}
258
259			// An event can have a 'dtend' or 'duration', but not both.
260	16		if ($this->dtEnd !== null) {
261	3		$dtEnd = clone $this->dtEnd;
262	3		if ($this->noTime === true) {
263			$dtEnd = $dtEnd->add(new \DateInterval('P1D'));
264			}
265	3		$propertyBag->add(new DateTimeProperty('DTEND', $dtEnd, $this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString));
266	13		} elseif ($this->duration !== null) {
267	1		$propertyBag->set('DURATION', $this->duration->format('P%dDT%hH%iM%sS'));
268			}
269
270			// optional information
271	16		if (null != $this->url) {
272	1		$propertyBag->set('URL', $this->url);
273			}
274
275	16		if (null != $this->location) {
276	2		$propertyBag->set('LOCATION', $this->location);
277
278	2		if (null != $this->locationGeo) {
279	1		$propertyBag->add(
280	1		new Property(
281	1		'X-APPLE-STRUCTURED-LOCATION',
282	1		new RawStringValue('geo:' . $this->locationGeo->getGeoLocationAsString(',')),
283			[
284	1		'VALUE' => 'URI',
285	1		'X-ADDRESS' => $this->location,
286	1		'X-APPLE-RADIUS' => 49,
287	1		'X-TITLE' => $this->locationTitle,
288			]
289			)
290			);
291			}
292			}
293
294	16		if (null != $this->locationGeo) {
295	2		$propertyBag->add($this->locationGeo);
296			}
297
298	16		if (null != $this->summary) {
299	1		$propertyBag->set('SUMMARY', $this->summary);
300			}
301
302	16		if (null != $this->attendees) {
303	16		$propertyBag->add($this->attendees);
304			}
305
306	16		$propertyBag->set('CLASS', $this->isPrivate ? 'PRIVATE' : 'PUBLIC');
307
308	16		if (null != $this->description) {
309	3		$propertyBag->set('DESCRIPTION', $this->description);
310			}
311
312	16		if (null != $this->descriptionHTML) {
313			$propertyBag->add(
314			new Property(
315			'X-ALT-DESC',
316			$this->descriptionHTML,
317			[
318			'FMTTYPE' => 'text/html',
319			]
320			)
321			);
322			}
323
324	16		if (null != $this->recurrenceRule) {
325			$propertyBag->set('RRULE', $this->recurrenceRule);
326			}
327
328	16		foreach ($this->recurrenceRules as $recurrenceRule) {
329			$propertyBag->set('RRULE', $recurrenceRule);
330			}
331
332	16		if (null != $this->recurrenceId) {
333			$this->recurrenceId->applyTimeSettings($this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString);
334			$propertyBag->add($this->recurrenceId);
335			}
336
337	16		if (!empty($this->exDates)) {
338			$propertyBag->add(new DateTimesProperty('EXDATE', $this->exDates, $this->noTime, $this->useTimezone, $this->useUtc, $this->timezoneString));
339			}
340
341	16		if ($this->cancelled) {
342			$propertyBag->set('STATUS', 'CANCELLED');
343			}
344
345	16		if (null != $this->organizer) {
346	2		$propertyBag->add($this->organizer);
347			}
348
349	16		if ($this->noTime) {
350	1		$propertyBag->set('X-MICROSOFT-CDO-ALLDAYEVENT', 'TRUE');
351			}
352
353	16		if (null != $this->categories) {
354			$propertyBag->set('CATEGORIES', $this->categories);
355			}
356
357	16		$propertyBag->add(
358	16		new DateTimeProperty('DTSTAMP', $this->dtStamp ?: new \DateTimeImmutable(), false, false, true)
359			);
360
361	16		if ($this->created) {
362			$propertyBag->add(new DateTimeProperty('CREATED', $this->created, false, false, true));
363			}
364
365	16		if ($this->modified) {
366			$propertyBag->add(new DateTimeProperty('LAST-MODIFIED', $this->modified, false, false, true));
367			}
368
369	16		return $propertyBag;
370			}
371
372			/**
373			* @param $dtEnd
374			*
375			* @return $this
376			*/
377	4		public function setDtEnd($dtEnd)
378			{
379	4		$this->dtEnd = $dtEnd;
380
381	4		return $this;
382			}
383
384	2		public function getDtEnd()
385			{
386	2		return $this->dtEnd;
387			}
388
389	4		public function setDtStart($dtStart)
390			{
391	4		$this->dtStart = $dtStart;
392
393	4		return $this;
394			}
395
396	2		public function getDtStart()
397			{
398	2		return $this->dtStart;
399			}
400
401			/**
402			* @param $dtStamp
403			*
404			* @return $this
405			*/
406	1		public function setDtStamp($dtStamp)
407			{
408	1		$this->dtStamp = $dtStamp;
409
410	1		return $this;
411			}
412
413			/**
414			* @param $duration
415			*
416			* @return $this
417			*/
418	1		public function setDuration($duration)
419			{
420	1		$this->duration = $duration;
421
422	1		return $this;
423			}
424
425			/**
426			* @param string $location
427			* @param string $title
428			* @param Geo\|string $geo
429			*
430			* @return $this
431			*/
432	3		public function setLocation($location, $title = '', $geo = null)
433			{
434	3		if (is_scalar($geo)) {
435	1		$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...
436	2		} elseif (!is_null($geo) && !$geo instanceof Geo) {
437	1		$className = get_class($geo);
438	1		throw new \InvalidArgumentException(
439			"The parameter 'geo' must be a string or an instance of " . Geo::class
440	1		. " but an instance of {$className} was given."
441			);
442			}
443
444	2		$this->location = $location;
445	2		$this->locationTitle = $title;
446	2		$this->locationGeo = $geo;
447
448	2		return $this;
449			}
450
451			/**
452			* @param Geo $geoProperty
453			*
454			* @return $this
455			*/
456	1		public function setGeoLocation(Geo $geoProperty)
457			{
458	1		$this->locationGeo = $geoProperty;
459
460	1		return $this;
461			}
462
463			/**
464			* @param $noTime
465			*
466			* @return $this
467			*/
468	1		public function setNoTime($noTime)
469			{
470	1		$this->noTime = $noTime;
471
472	1		return $this;
473			}
474
475			/**
476			* @param int $sequence
477			*
478			* @return $this
479			*/
480	2		public function setSequence($sequence)
481			{
482	2		$this->sequence = $sequence;
483
484	2		return $this;
485			}
486
487			/**
488			* @return int
489			*/
490	1		public function getSequence()
491			{
492	1		return $this->sequence;
493			}
494
495			/**
496			* @param Organizer $organizer
497			*
498			* @return $this
499			*/
500	2		public function setOrganizer(Organizer $organizer)
501			{
502	2		$this->organizer = $organizer;
503
504	2		return $this;
505			}
506
507			/**
508			* @param $summary
509			*
510			* @return $this
511			*/
512	1		public function setSummary($summary)
513			{
514	1		$this->summary = $summary;
515
516	1		return $this;
517			}
518
519			/**
520			* @param $uniqueId
521			*
522			* @return $this
523			*/
524	1		public function setUniqueId($uniqueId)
525			{
526	1		$this->uniqueId = $uniqueId;
527
528	1		return $this;
529			}
530
531			/**
532			* @return string
533			*/
534	2		public function getUniqueId()
535			{
536	2		return $this->uniqueId;
537			}
538
539			/**
540			* @param $url
541			*
542			* @return $this
543			*/
544	1		public function setUrl($url)
545			{
546	1		$this->url = $url;
547
548	1		return $this;
549			}
550
551			/**
552			* @param $useTimezone
553			*
554			* @return $this
555			*/
556			public function setUseTimezone($useTimezone)
557			{
558			$this->useTimezone = $useTimezone;
559
560			return $this;
561			}
562
563			/**
564			* @return bool
565			*/
566			public function getUseTimezone()
567			{
568			return $this->useTimezone;
569			}
570
571			/**
572			* @param $timezoneString
573			*
574			* @return $this
575			*/
576	2		public function setTimezoneString($timezoneString)
577			{
578	2		$this->timezoneString = $timezoneString;
579
580	2		return $this;
581			}
582
583			/**
584			* @return bool
585			*/
586	1		public function getTimezoneString()
587			{
588	1		return $this->timezoneString;
589			}
590
591			/**
592			* @param Attendees $attendees
593			*
594			* @return $this
595			*/
596			public function setAttendees(Attendees $attendees)
597			{
598			$this->attendees = $attendees;
599
600			return $this;
601			}
602
603			/**
604			* @param string $attendee
605			* @param array $params
606			*
607			* @return $this
608			*/
609			public function addAttendee($attendee, $params = [])
610			{
611			$this->attendees->add($attendee, $params);
612
613			return $this;
614			}
615
616			/**
617			* @return Attendees
618			*/
619			public function getAttendees(): Attendees
620			{
621			return $this->attendees;
622			}
623
624			/**
625			* @param $description
626			*
627			* @return $this
628			*/
629	3		public function setDescription($description)
630			{
631	3		$this->description = $description;
632
633	3		return $this;
634			}
635
636			/**
637			* @param $descriptionHTML
638			*
639			* @return $this
640			*/
641			public function setDescriptionHTML($descriptionHTML)
642			{
643			$this->descriptionHTML = $descriptionHTML;
644
645			return $this;
646			}
647
648			/**
649			* @param bool $useUtc
650			*
651			* @return $this
652			*/
653			public function setUseUtc($useUtc = true)
654			{
655			$this->useUtc = $useUtc;
656
657			return $this;
658			}
659
660			/**
661			* @return string
662			*/
663			public function getDescription()
664			{
665			return $this->description;
666			}
667
668			/**
669			* @return string
670			*/
671			public function getDescriptionHTML()
672			{
673			return $this->descriptionHTML;
674			}
675
676			/**
677			* @param $status
678			*
679			* @return $this
680			*/
681			public function setCancelled($status)
682			{
683			$this->cancelled = (bool) $status;
684
685			return $this;
686			}
687
688			/**
689			* @param $transparency
690			*
691			* @return $this
692			*
693			* @throws \InvalidArgumentException
694			*/
695		View Code Duplication	public function setTimeTransparency($transparency)
			0 ignored issues – show Duplication introduced 2017-09-20 12:54 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...
696			{
697			$transparency = strtoupper($transparency);
698			if ($transparency === self::TIME_TRANSPARENCY_OPAQUE
699			\|\| $transparency === self::TIME_TRANSPARENCY_TRANSPARENT
700			) {
701			$this->transparency = $transparency;
702			} else {
703			throw new \InvalidArgumentException('Invalid value for transparancy');
704			}
705
706			return $this;
707			}
708
709			/**
710			* @param $status
711			*
712			* @return $this
713			*
714			* @throws \InvalidArgumentException
715			*/
716			public function setStatus($status)
717			{
718			$status = strtoupper($status);
719			if ($status == self::STATUS_CANCELLED
720			\|\| $status == self::STATUS_CONFIRMED
721			\|\| $status == self::STATUS_TENTATIVE
722			) {
723			$this->status = $status;
724			} else {
725			throw new \InvalidArgumentException('Invalid value for status');
726			}
727
728			return $this;
729			}
730
731			/**
732			* @deprecated Deprecated since version 0.11.0, to be removed in 1.0. Use addRecurrenceRule instead.
733			*
734			* @param RecurrenceRule $recurrenceRule
735			*
736			* @return $this
737			*/
738			public function setRecurrenceRule(RecurrenceRule $recurrenceRule)
739			{
740			@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...
741
742			$this->recurrenceRule = $recurrenceRule;
743
744			return $this;
745			}
746
747			/**
748			* @deprecated Deprecated since version 0.11.0, to be removed in 1.0. Use getRecurrenceRules instead.
749			*
750			* @return RecurrenceRule
751			*/
752			public function getRecurrenceRule()
753			{
754			@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...
755
756			return $this->recurrenceRule;
757			}
758
759			/**
760			* @param RecurrenceRule $recurrenceRule
761			*
762			* @return $this
763			*/
764			public function addRecurrenceRule(RecurrenceRule $recurrenceRule)
765			{
766			$this->recurrenceRules[] = $recurrenceRule;
767
768			return $this;
769			}
770
771			/**
772			* @return array
773			*/
774			public function getRecurrenceRules()
775			{
776			return $this->recurrenceRules;
777			}
778
779			/**
780			* @param $dtStamp
781			*
782			* @return $this
783			*/
784			public function setCreated($dtStamp)
785			{
786			$this->created = $dtStamp;
787
788			return $this;
789			}
790
791			/**
792			* @param $dtStamp
793			*
794			* @return $this
795			*/
796			public function setModified($dtStamp)
797			{
798			$this->modified = $dtStamp;
799
800			return $this;
801			}
802
803			/**
804			* @param $categories
805			*
806			* @return $this
807			*/
808			public function setCategories($categories)
809			{
810			$this->categories = $categories;
811
812			return $this;
813			}
814
815			/**
816			* Sets the event privacy.
817			*
818			* @param bool $flag
819			*
820			* @return $this
821			*/
822			public function setIsPrivate($flag)
823			{
824			$this->isPrivate = (bool) $flag;
825
826			return $this;
827			}
828
829			/**
830			* @param \DateTimeInterface $dateTime
831			*
832			* @return \Eluceo\iCal\Component\Event
833			*/
834			public function addExDate(\DateTimeInterface $dateTime)
835			{
836			$this->exDates[] = $dateTime;
837
838			return $this;
839			}
840
841			/**
842			* @return \DateTimeInterface[]
843			*/
844			public function getExDates()
845			{
846			return $this->exDates;
847			}
848
849			/**
850			* @param \DateTimeInterface[]
851			*
852			* @return \Eluceo\iCal\Component\Event
853			*/
854			public function setExDates(array $exDates)
855			{
856			$this->exDates = $exDates;
857
858			return $this;
859			}
860
861			/**
862			* @return \Eluceo\iCal\Property\Event\RecurrenceId
863			*/
864			public function getRecurrenceId()
865			{
866			return $this->recurrenceId;
867			}
868
869			/**
870			* @param RecurrenceId $recurrenceId
871			*
872			* @return \Eluceo\iCal\Component\Event
873			*/
874			public function setRecurrenceId(RecurrenceId $recurrenceId)
875			{
876			$this->recurrenceId = $recurrenceId;
877
878			return $this;
879			}
880			}
881

markuspoerschke / iCal