Overview

Namespaces

  • intouch
    • ical

Classes

  • Duration
  • Factory
  • Freq
  • iCal
  • Line
  • Parser
  • Query
  • Recurrence
  • VCalendar
  • VEvent
  • VTimeZone
  • Overview
  • Namespace
  • Class
  • Tree

Class VEvent

The wrapper for vevents. Will reveal a unified and simple api for the events, which include always finding a start and end (except when no end or duration is given) and checking if the event is blocking or similar.

Will apply the specified timezone to timestamps if a tzid is specified

Namespace: intouch\ical
License: CC-BY-SA-DK
Author: Morten Fangel (C) 2008
Author: Michael Kahn (C) 2013
Located at ical/VEvent.php
Methods summary
public
# __construct( intouch\ical\Line[] $data, intouch\ical\iCal $ical )

Constructs a new intouch\ical\VEvent. Needs the iCal supplied so it can query for timezones.

Constructs a new intouch\ical\VEvent. Needs the iCal supplied so it can query for timezones.

Parameters

$data
intouch\ical\Line[]
$data
$ical
intouch\ical\iCal
$ical
public intouch\ical\Freq
# getFrequency( )

Returns the Event Occurrences Iterator (if recurrence set)

Returns the Event Occurrences Iterator (if recurrence set)

Returns

intouch\ical\Freq
public string
# getUID( )

Returns the UID of the event

Returns the UID of the event

Returns

string
public string
# getSummary( )

Returns the summary (or null if none is given) of the event

Returns the summary (or null if none is given) of the event

Returns

string
public string
# getDescription( )

Returns the description (or null if none is given) of the event

Returns the description (or null if none is given) of the event

Returns

string
public string
# getLocation( )

Returns the location (or null if none is given) of the event

Returns the location (or null if none is given) of the event

Returns

string
public boolean
# isBlocking( )

Returns true if the event is blocking (ie not transparent)

Returns true if the event is blocking (ie not transparent)

Returns

boolean
public boolean
# isConfirmed( )

Returns true if the event is confirmed

Returns true if the event is confirmed

Returns

boolean
public boolean
# isWholeDay( )

Returns true if duration is multiple of 86400

Returns true if duration is multiple of 86400

Returns

boolean
public integer
# getStart( )

Returns the timestamp for the beginning of the event

Returns the timestamp for the beginning of the event

Returns

integer
public integer
# getEnd( )

Returns the timestamp for the end of the event

Returns the timestamp for the end of the event

Returns

integer
public integer
# getRangeEnd( )

Returns the timestamp for the end of the last event

Returns the timestamp for the end of the last event

Returns

integer
public integer
# getDuration( )

Returns the duration of this event in seconds

Returns the duration of this event in seconds

Returns

integer
public string
# getProperty( string $prop )

Returns the given property of the event.

Returns the given property of the event.

Parameters

$prop
string
$prop

Returns

string
protected string
# setLineTimeZone( intouch\ical\Line $line )

Set default timezone (temporary) to get timestamps

Set default timezone (temporary) to get timestamps

Returns

string
protected integer
# getTimestamp( intouch\ical\Line $line, intouch\ical\iCal $ical )

Calculates the timestamp from a DT line.

Calculates the timestamp from a DT line.

Parameters

$line
mixed
$line intouch\ical\Line
$ical

Returns

integer
Constants summary
boolean DEFAULT_CONFIRMED true
#
Properties summary
protected mixed $uid
#
protected mixed $start
#
protected mixed $end
#
protected mixed $summary
#
protected mixed $description
#
protected mixed $location
#
protected mixed $laststart
#
protected mixed $lastend
#
public mixed $recurrence
#
public mixed $recurex
#
public mixed $excluded
#
public mixed $added
#
public mixed $freq
#
public mixed $data
#
intouch-iCalendar API documentation generated by ApiGen 2.8.0