\vevent

class for calendar component VEVENT

properties and functions shared by vcalendar and calendarComponents

Summary

Methods

Properties

Constants

__construct()
createAction()
setAction()
createAttach()
setAttach()
createAttendee()
setAttendee()
createCategories()
setCategories()
createClass()
setClass()
createComment()
setComment()
createCompleted()
setCompleted()
createContact()
setContact()
createCreated()
setCreated()
createDescription()
setDescription()
createDtend()
setDtend()
createDtstamp()
_makeDtstamp()
setDtstamp()
createDtstart()
setDtstart()
createDue()
setDue()
createDuration()
setDuration()
createExdate()
setExdate()
createExrule()
setExrule()
createFreebusy()
setFreebusy()
createGeo()
setGeo()
createLastModified()
setLastModified()
createLocation()
setLocation()
createOrganizer()
setOrganizer()
createPercentComplete()
setPercentComplete()
createPriority()
setPriority()
createRdate()
setRdate()
createRecurrenceid()
setRecurrenceid()
createRelatedTo()
setRelatedTo()
createRepeat()
setRepeat()
createRequestStatus()
setRequestStatus()
createResources()
setResources()
createRrule()
setRrule()
createSequence()
setSequence()
createStatus()
setStatus()
createSummary()
setSummary()
createTransp()
setTransp()
createTrigger()
setTrigger()
createTzid()
setTzid()
createTzname()
setTzname()
createTzoffsetfrom()
setTzoffsetfrom()
createTzoffsetto()
setTzoffsetto()
createTzurl()
setTzurl()
createUid()
_makeUid()
setUid()
createUrl()
setUrl()
_createFormat()
_format_recur()
_notExistProp()
getConfig()
setConfig()
deleteProperty()
deletePropertyM()
getProperty()
_getProperties()
setProperty()
parse()
copy()
deleteComponent()
getComponent()
addSubComponent()
newComponent()
setComponent()
createSubComponent()
createXprop()
setXprop()
createComponent()

$objName
$components
$unparsed

No constants found

_createElement()
_createParams()

$uid
$dtstamp
$xprop
$allowEmpty
$language
$nl
$unique_id
$format
$dtzid
$componentStart1
$componentStart2
$componentEnd1
$componentEnd2
$elementStart1
$elementStart2
$elementEnd1
$elementEnd2
$intAttrDelimiter
$attributeDelimiter
$valueInit
$xcaldecl
$attach
$attendee
$categories
$comment
$contact
$class
$created
$description
$dtend
$dtstart
$duration
$exdate
$exrule
$geo
$lastmodified
$location
$organizer
$priority
$rdate
$recurrenceid
$relatedto
$requeststatus
$resources
$rrule
$sequence
$status
$summary
$transp
$url

N/A

No private methods found

No private properties found

N/A

File: libraries/icalcreator/lib/vevent.class.php
Package: iCalcreator
Class hierarchy: \iCalBase

\calendarComponent

\vevent

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2008-10-12

Properties

$objName

$objName : string

Type

string — component type

$components

$components : array

Type

array — container for sub-components

$unparsed

$unparsed : array

Type

array — calendar/components in 'raw' text...

$uid

$uid : array

Type

array — component property UID value

$dtstamp

$dtstamp : array

Type

array — component property DTSTAMP value

$xprop

$xprop : array

Type

array — component property X-property value @access protected

$allowEmpty

$allowEmpty : boolean

Type

boolean — config variable @var string $language config variable @var string $nl config variable @var string $unique_id config variable @var string $format config variable @var string $dtzid config variable @access protected

$language

$language :

Type

$nl

$nl :

Type

$unique_id

$unique_id :

Type

$format

$format :

Type

$dtzid

$dtzid :

Type

$componentStart1

$componentStart1 : string

Type

string — valendar/component internal variable @var string $componentStart2 valendar/component internal variable @var string $componentEnd1 valendar/component internal variable @var string $componentEnd2 valendar/component internal variable @var string $elementStart1 valendar/component internal variable @var string $elementStart2 valendar/component internal variable @var string $elementEnd1 valendar/component internal variable @var string $elementEnd2 valendar/component internal variable @var string $intAttrDelimiter valendar/component internal variable @var string $attributeDelimiter valendar/component internal variable @var string $valueInit valendar/component internal variable @access protected

$componentStart2

$componentStart2 :

Type

$componentEnd1

$componentEnd1 :

Type

$componentEnd2

$componentEnd2 :

Type

$elementStart1

$elementStart1 :

Type

$elementStart2

$elementStart2 :

Type

$elementEnd1

$elementEnd1 :

Type

$elementEnd2

$elementEnd2 :

Type

$intAttrDelimiter

$intAttrDelimiter :

Type

$attributeDelimiter

$attributeDelimiter :

Type

$valueInit

$valueInit :

Type

$xcaldecl

$xcaldecl : array

Type

array — xCal declaration container @access protected

$attach

$attach : array

Type

array — component property value

$attendee

$attendee :

Type

$categories

$categories :

Type

$comment

$comment :

Type

$contact

$contact :

Type

$class

$class :

Type

$created

$created :

Type

$description

$description :

Type

$dtend

$dtend :

Type

$dtstart

$dtstart :

Type

$duration

$duration :

Type

$exdate

$exdate :

Type

$exrule

$exrule :

Type

$geo

$geo :

Type

$lastmodified

$lastmodified :

Type

$location

$location :

Type

$organizer

$organizer :

Type

$priority

$priority :

Type

$rdate

$rdate :

Type

$recurrenceid

$recurrenceid :

Type

$relatedto

$relatedto :

Type

$requeststatus

$requeststatus :

Type

$resources

$resources :

Type

$rrule

$rrule :

Type

$sequence

$sequence :

Type

$status

$status :

Type

$summary

$summary :

Type

$transp

$transp :

Type

$url

$url :

Type

Methods

__construct()

__construct(array  $config = array())

constructor for calendar component VEVENT object

Parameters

array

$config

Uses: vevent::calendarComponent(); vevent::$attach; vevent::$attendee; vevent::$categories; vevent::$class; vevent::$comment; vevent::$contact; vevent::$created; vevent::$description; vevent::$dtstart; vevent::$dtend; vevent::$duration; vevent::$exdate; vevent::$exrule; vevent::$geo; vevent::$lastmodified; vevent::$location; vevent::$organizer; vevent::$priority; vevent::$rdate; vevent::$recurrenceid; vevent::$relatedto; vevent::$requeststatus; vevent::$resources; vevent::$rrule; vevent::$sequence; vevent::$status; vevent::$summary; vevent::$transp; vevent::$url; vevent::$xprop; vevent::$components; calendarComponent::setConfig()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.8.2 2011-05-01

createAction()

createAction() : string

creates formatted output for calendar component property action

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$action; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams(); calendarComponent::_createElement()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-22

setAction()

setAction(string  $value, mixed  $params = FALSE) : boolean

set calendar component property action

Parameters

string	$value	"AUDIO" / "DISPLAY" / "EMAIL" / "PROCEDURE"
mixed	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$action; calendarComponent::$action; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createAttach()

createAttach() : string

creates formatted output for calendar component property attach

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$attach; calendarComponent::_createParams(); calendarComponent::$format; calendarComponent::$intAttrDelimiter; calendarComponent::$attributeDelimiter; calendarComponent::$valueInit; calendarComponent::$nl; calendarComponent::_createElement()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.11.16 2012-02-04

setAttach()

setAttach(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property attach

Parameters

string	$value
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::$attach; calendarComponent::getConfig(); iCalUtilityFunctions::_setMval()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createAttendee()

createAttendee() : string

creates formatted output for calendar component property attendee

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$attendee; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::$intAttrDelimiter

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.11.12 2012-01-31

setAttendee()

setAttendee(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property attach

Parameters

string	$value
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$objName; iCalUtilityFunctions::_existRem(); iCalUtilityFunctions::_setMval()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.18.13 2013-09-22

createCategories()

createCategories() : string

creates formatted output for calendar component property categories

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$categories; calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_strrep(); calendarComponent::$format; calendarComponent::$nl

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.2 2012-12-18

setCategories()

setCategories(mixed  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property categories

Parameters

mixed	$value
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$categories; iCalUtilityFunctions::_setMval()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createClass()

createClass() : string

creates formatted output for calendar component property class

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$class; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	0.9.7 2006-11-20

setClass()

setClass(string  $value, array  $params = FALSE) : boolean

set calendar component property class

Parameters

string	$value	"PUBLIC" / "PRIVATE" / "CONFIDENTIAL" / iana-token / x-name
array	$params	optional

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$class; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createComment()

createComment() : string

creates formatted output for calendar component property comment

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$comment; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_strrep(); calendarComponent::$format; calendarComponent::$nl

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.2 2012-12-18

setComment()

setComment(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property comment

Parameters

string	$value
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_setMval(); calendarComponent::$comment

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createCompleted()

createCompleted() : string

creates formatted output for calendar component property completed

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$completed; calendarComponent::getConfig(); calendarComponent::_createElement(); iCalUtilityFunctions::_date2strdate();; calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-22

setCompleted()

setCompleted(mixed  $year, mixed  $month = FALSE, integer  $day = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, array  $params = FALSE) : boolean

set calendar component property completed

Parameters

mixed	$year
mixed	$month
integer	$day
integer	$hour
integer	$min
integer	$sec
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_setParams(); calendarComponent::$completed; iCalUtilityFunctions::_setDate2()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createContact()

createContact() : string

creates formatted output for calendar component property contact

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$contact; calendarComponent::_createParams(); iCalUtilityFunctions::_strrep(); calendarComponent::getConfig(); calendarComponent::_createElement()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.2 2012-12-18

setContact()

setContact(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property contact

Parameters

string	$value
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_setMval(); calendarComponent::$contact

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createCreated()

createCreated() : string

creates formatted output for calendar component property created

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$created; iCalUtilityFunctions::_date2strdate(); calendarComponent::_createParams(); calendarComponent::_createElement()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-21

setCreated()

setCreated(mixed  $year = FALSE, mixed  $month = FALSE, integer  $day = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, mixed  $params = FALSE) : boolean

set calendar component property created

Parameters

mixed	$year
mixed	$month
integer	$day
integer	$hour
integer	$min
integer	$sec
mixed	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::$created; iCalUtilityFunctions::_setDate2()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.19.5 2014-03-29

createDescription()

createDescription() : string

creates formatted output for calendar component property description

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$description; calendarComponent::_createParams(); iCalUtilityFunctions::_strrep(); calendarComponent::_createElement(); calendarComponent::getConfig()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.2 2012-12-18

setDescription()

setDescription(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property description

Parameters

string	$value
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$objName; iCalUtilityFunctions::_setMval(); calendarComponent::$description

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createDtend()

createDtend() : string

creates formatted output for calendar component property dtend

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$dtend; calendarComponent::getConfig(); iCalUtilityFunctions::_date2strdate(); calendarComponent::_createParams(); calendarComponent::_createElement()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.14.4 2012-09-26

setDtend()

setDtend(mixed  $year, mixed  $month = FALSE, integer  $day = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, string  $tz = FALSE, array  $params = FALSE) : boolean

set calendar component property dtend

Parameters

mixed	$year
mixed	$month
integer	$day
integer	$hour
integer	$min
integer	$sec
string	$tz
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$dtend; iCalUtilityFunctions::_setParams(); iCalUtilityFunctions::_setDate()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createDtstamp()

createDtstamp() : string

creates formatted output for calendar component property dtstamp

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$dtstamp; calendarComponent::_makeDtstamp(); iCalUtilityFunctions::_date2strdate(); calendarComponent::_createParams(); calendarComponent::_createElement()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.4 2008-03-07

_makeDtstamp()

_makeDtstamp() : void

computes datestamp for calendar component object instance dtstamp

Inherited from: \calendarComponent
Uses: iCalUtilityFunctions::$fmt; calendarComponent::$dtstamp

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-21

setDtstamp()

setDtstamp(mixed  $year, mixed  $month = FALSE, integer  $day = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, array  $params = FALSE) : TRUE

set calendar component property dtstamp

Parameters

mixed	$year
mixed	$month
integer	$day
integer	$hour
integer	$min
integer	$sec
array	$params

Returns

TRUE

Inherited from: \calendarComponent
Uses: calendarComponent::_makeDtstamp(); calendarComponent::$dtstamp; iCalUtilityFunctions::_setDate2()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-23

createDtstart()

createDtstart() : string

creates formatted output for calendar component property dtstart

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$dtstart; calendarComponent::getConfig(); calendarComponent::_createElement(); iCalUtilityFunctions::_date2strdate(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.14.4 2012-09-26

setDtstart()

setDtstart(mixed  $year, mixed  $month = FALSE, integer  $day = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, string  $tz = FALSE, array  $params = FALSE) : boolean

set calendar component property dtstart

Parameters

mixed	$year
mixed	$month
integer	$day
integer	$hour
integer	$min
integer	$sec
string	$tz
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_setParams(); calendarComponent::$dtstart; iCalUtilityFunctions::_setDate()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createDue()

createDue() : string

creates formatted output for calendar component property due

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$due; calendarComponent::getConfig(); calendarComponent::_createElement(); iCalUtilityFunctions::_date2strdate(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.14.4 2012-09-26

setDue()

setDue(mixed  $year, mixed  $month = FALSE, integer  $day = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, string  $tz = FALSE, array  $params = FALSE) : boolean

set calendar component property due

Parameters

mixed	$year
mixed	$month
integer	$day
integer	$hour
integer	$min
integer	$sec
string	$tz
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$due; iCalUtilityFunctions::_setParams(); iCalUtilityFunctions::_setDate()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createDuration()

createDuration() : string

creates formatted output for calendar component property duration

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$duration; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_duration2str()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-05-25

setDuration()

setDuration(mixed  $week, mixed  $day = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, array  $params = FALSE) : boolean

set calendar component property duration

Parameters

mixed	$week
mixed	$day
integer	$hour
integer	$min
integer	$sec
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$duration; iCalUtilityFunctions::_duration2arr(); iCalUtilityFunctions::_durationStr2arr(); iCalUtilityFunctions::_setParams(); iCalUtilityFunctions::_duration2arr()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-05-25

createExdate()

createExdate() : string

creates formatted output for calendar component property exdate

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$exdate; calendarComponent::getConfig(); calendarComponent::_createElement(); iCalUtilityFunctions::_sortExdate1(); iCalUtilityFunctions::_sortExdate2(); iCalUtilityFunctions::_date2strdate(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.5 2012-12-28

setExdate()

setExdate(array  $exdates, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property exdate

Parameters

array	$exdates
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_setMval(); calendarComponent::$exdate; iCalUtilityFunctions::_setParams(); iCalUtilityFunctions::_chkdatecfg(); iCalUtilityFunctions::_existRem(); iCalUtilityFunctions::_strDate2arr(); iCalUtilityFunctions::_isArrayTimestampDate(); iCalUtilityFunctions::_isOffset(); iCalUtilityFunctions::_timestamp2date(); iCalUtilityFunctions::_chkDateArr(); iCalUtilityFunctions::$fmt; iCalUtilityFunctions::_strdate2date()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-10

createExrule()

createExrule() : string

creates formatted output for calendar component property exrule

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$exrule; calendarComponent::_format_recur()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-22

setExrule()

setExrule(array  $exruleset, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property exdate

Parameters

array	$exruleset
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_setMval(); calendarComponent::$exrule; iCalUtilityFunctions::_setRexrule()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createFreebusy()

createFreebusy() : string

creates formatted output for calendar component property freebusy

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$freebusy; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::$intAttrDelimiter; calendarComponent::_createParams(); iCalUtilityFunctions::_sortRdate1(); iCalUtilityFunctions::_date2strdate(); iCalUtilityFunctions::_duration2str()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.27 2013-07-05

setFreebusy()

setFreebusy(string  $fbType, array  $fbValues, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property freebusy

Parameters

string	$fbType
array	$fbValues
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$freebusy; iCalUtilityFunctions::_isArrayDate(); iCalUtilityFunctions::_setMval(); iCalUtilityFunctions::_chkDateArr(); iCalUtilityFunctions::_isArrayTimestampDate(); iCalUtilityFunctions::_timestamp2date(); iCalUtilityFunctions::_duration2arr(); iCalUtilityFunctions::_durationStr2arr(); iCalUtilityFunctions::_strdate2date()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createGeo()

createGeo() : string

creates formatted output for calendar component property geo

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$geo; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_geo2str2(); iCalUtilityFunctions::$geoLongFmt; iCalUtilityFunctions::$geoLatFmt

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.18.10 2013-09-03

setGeo()

setGeo(mixed  $latitude, mixed  $longitude, array  $params = FALSE) : boolean

set calendar component property geo

Parameters

mixed	$latitude
mixed	$longitude
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::$geo; iCalUtilityFunctions::_setParams(); calendarComponent::getConfig()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.18.10 2013-09-03

createLastModified()

createLastModified() : string

creates formatted output for calendar component property last-modified

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$lastmodified; calendarComponent::_createParams(); iCalUtilityFunctions::_date2strdate(); calendarComponent::_createElement()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-21

setLastModified()

setLastModified(mixed  $year = FALSE, mixed  $month = FALSE, integer  $day = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, array  $params = FALSE) : \boll

set calendar component property completed

Parameters

mixed	$year	optional
mixed	$month	optional
integer	$day	optional
integer	$hour	optional
integer	$min	optional
integer	$sec	optional
array	$params	optional

Returns

\boll

Inherited from: \calendarComponent
Uses: calendarComponent::$lastmodified; iCalUtilityFunctions::_setDate2()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.19.5 2014-03-29

createLocation()

createLocation() : string

creates formatted output for calendar component property location

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$location; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_strrep()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.2 2012-12-18

setLocation()

setLocation(string  $value, array  $params = FALSE) : boolean

set calendar component property location '

Parameters

string	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::$location; calendarComponent::getConfig(); iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createOrganizer()

createOrganizer() : string

creates formatted output for calendar component property organizer

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$organizer; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.6.33 2010-12-17

setOrganizer()

setOrganizer(string  $value, array  $params = FALSE) : boolean

set calendar component property organizer

Parameters

string	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$organizer; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createPercentComplete()

createPercentComplete() : string

creates formatted output for calendar component property percent-complete

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$percentcomplete; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.9.3 2011-05-14

setPercentComplete()

setPercentComplete(integer  $value, array  $params = FALSE) : boolean

set calendar component property percent-complete

Parameters

integer	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::$percentcomplete; calendarComponent::getConfig(); iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createPriority()

createPriority() : string

creates formatted output for calendar component property priority

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$priority; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.9.3 2011-05-14

setPriority()

setPriority(integer  $value, array  $params = FALSE) : boolean

set calendar component property priority

Parameters

integer	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$priority; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createRdate()

createRdate() : string

creates formatted output for calendar component property rdate

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$rdate; calendarComponent::$objName; calendarComponent::getConfig(); calendarComponent::_createElement(); iCalUtilityFunctions::_sortRdate1(); iCalUtilityFunctions::_sortRdate2(); calendarComponent::_createParams(); iCalUtilityFunctions::_date2strdate()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.9 2013-01-09

setRdate()

setRdate(array  $rdates, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property rdate

Parameters

array	$rdates
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_setMval(); calendarComponent::$rdate; iCalUtilityFunctions::_setParams(); calendarComponent::$objName; iCalUtilityFunctions::_isArrayDate(); iCalUtilityFunctions::_chkdatecfg(); iCalUtilityFunctions::_existRem(); iCalUtilityFunctions::_strDate2arr(); iCalUtilityFunctions::_isArrayTimestampDate(); iCalUtilityFunctions::_isOffset(); iCalUtilityFunctions::_timestamp2date(); iCalUtilityFunctions::_chkDateArr(); iCalUtilityFunctions::$fmt; iCalUtilityFunctions::_strdate2date(); iCalUtilityFunctions::_duration2arr(); iCalUtilityFunctions::_durationStr2arr()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-10

createRecurrenceid()

createRecurrenceid() : string

creates formatted output for calendar component property recurrence-id

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$recurrenceid; calendarComponent::getConfig(); calendarComponent::_createElement(); iCalUtilityFunctions::_date2strdate(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.14.4 2012-09-26

setRecurrenceid()

setRecurrenceid(mixed  $year, mixed  $month = FALSE, integer  $day = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, string  $tz = FALSE, array  $params = FALSE) : boolean

set calendar component property recurrence-id

Parameters

mixed	$year
mixed	$month
integer	$day
integer	$hour
integer	$min
integer	$sec
string	$tz
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$recurrenceid; iCalUtilityFunctions::_setDate()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createRelatedTo()

createRelatedTo() : string

creates formatted output for calendar component property related-to

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$relatedto; calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_strrep(); calendarComponent::getConfig()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-05-25

setRelatedTo()

setRelatedTo(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property related-to

Parameters

string	$value
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_existRem(); iCalUtilityFunctions::_setMval()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createRepeat()

createRepeat() : string

creates formatted output for calendar component property repeat

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$repeat; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.9.3 2011-05-14

setRepeat()

setRepeat(string  $value, array  $params = FALSE) : void

set calendar component property repeat

Parameters

string	$value
array	$params

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$repeat; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createRequestStatus()

createRequestStatus() : string

creates formatted output for calendar component property request-status

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$requeststatus; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_strrep()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.2 2012-12-18

setRequestStatus()

setRequestStatus(float  $statcode, string  $text, string  $extdata = FALSE, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property request-status

Parameters

float	$statcode
string	$text
string	$extdata
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$requeststatus; iCalUtilityFunctions::_setMval()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createResources()

createResources() : string

creates formatted output for calendar component property resources

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$resources; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_strrep()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.2 2012-12-18

setResources()

setResources(mixed  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property recources

Parameters

mixed	$value
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_setMval(); calendarComponent::$resources

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createRrule()

createRrule() : string

creates formatted output for calendar component property rrule

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$rrule; calendarComponent::_format_recur()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-21

setRrule()

setRrule(array  $rruleset, array  $params = FALSE, integer  $index = FALSE) : void

set calendar component property rrule

Parameters

array	$rruleset
array	$params
integer	$index

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_setMval(); iCalUtilityFunctions::_setRexrule()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createSequence()

createSequence() : string

creates formatted output for calendar component property sequence

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$sequence; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.9.3 2011-05-14

setSequence()

setSequence(integer  $value = FALSE, array  $params = FALSE) : boolean

set calendar component property sequence

Parameters

integer	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::$sequence; iCalUtilityFunctions::_setParams();

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.10.8 2011-09-19

createStatus()

createStatus() : string

creates formatted output for calendar component property status

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$status; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-21

setStatus()

setStatus(string  $value, array  $params = FALSE) : boolean

set calendar component property status

Parameters

string	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$status; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createSummary()

createSummary() : string

creates formatted output for calendar component property summary

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$summary; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_strrep()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.2 2012-12-18

setSummary()

setSummary(string  $value, string  $params = FALSE) : boolean

set calendar component property summary

Parameters

string	$value
string	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createTransp()

createTransp() : string

creates formatted output for calendar component property transp

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$transp; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-21

setTransp()

setTransp(string  $value, string  $params = FALSE) : boolean

set calendar component property transp

Parameters

string	$value
string	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$transp; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createTrigger()

createTrigger() : string

creates formatted output for calendar component property trigger

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$trigger; calendarComponent::getConfig(); calendarComponent::_createElement(); iCalUtilityFunctions::_date2strdate(); calendarComponent::$intAttrDelimiter; iCalUtilityFunctions::_duration2str(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.16 2008-10-21

setTrigger()

setTrigger(mixed  $year, mixed  $month = null, integer  $day = null, integer  $week = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, boolean  $relatedStart = TRUE, boolean  $before = TRUE, array  $params = FALSE) : boolean

set calendar component property trigger

Parameters

mixed	$year
mixed	$month
integer	$day
integer	$week
integer	$hour
integer	$min
integer	$sec
boolean	$relatedStart
boolean	$before
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$trigger; iCalUtilityFunctions::_setParams(); iCalUtilityFunctions::_isArrayTimestampDate(); iCalUtilityFunctions::_timestamp2date(); iCalUtilityFunctions::_strdate2date(); iCalUtilityFunctions::_duration2arr()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createTzid()

createTzid() : string

creates formatted output for calendar component property tzid

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$tzid; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_strrep(); calendarComponent::$format; calendarComponent::$nl

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.2 2012-12-18

setTzid()

setTzid(string  $value, array  $params = FALSE) : boolean

set calendar component property tzid

Parameters

string	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$tzid; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createTzname()

createTzname() : string

creates formatted output for calendar component property tzname

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$tzname; calendarComponent::_createParams(); calendarComponent::_createElement(); iCalUtilityFunctions::_strrep(; calendarComponent::$format; calendarComponent::$nl; calendarComponent::getConfig()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.2 2012-12-18

setTzname()

setTzname(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property tzname

Parameters

string	$value
array	$params
integer	$index

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::_createParams(); calendarComponent::$tzname; iCalUtilityFunctions::_setMval()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createTzoffsetfrom()

createTzoffsetfrom() : string

creates formatted output for calendar component property tzoffsetfrom

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$tzoffsetfrom; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-21

setTzoffsetfrom()

setTzoffsetfrom(string  $value, array  $params = FALSE) : boolean

set calendar component property tzoffsetfrom

Parameters

string	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$tzoffsetfrom; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createTzoffsetto()

createTzoffsetto() : string

creates formatted output for calendar component property tzoffsetto

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$tzoffsetto; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-21

setTzoffsetto()

setTzoffsetto(string  $value, array  $params = FALSE) : boolean

set calendar component property tzoffsetto

Parameters

string	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$tzoffsetto; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createTzurl()

createTzurl() : string

creates formatted output for calendar component property tzurl

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$tzurl; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-21

setTzurl()

setTzurl(string  $value, array  $params = FALSE) : \boll

set calendar component property tzurl

Parameters

string	$value
array	$params

Returns

\boll

Inherited from: \calendarComponent
Uses: calendarComponent::$tzurl; calendarComponent::getConfig(); calendarComponent::$tzurl; iCalUtilityFunctions::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

createUid()

createUid() : string

creates formatted output for calendar component property uid

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$uid; calendarComponent::_makeuid();; calendarComponent::_createParams(); calendarComponent::_createElement()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.19.1 2014-02-21

_makeUid()

_makeUid() : void

create an unique id for this calendar component object instance

Inherited from: \calendarComponent
Uses: calendarComponent::$uid; calendarComponent::getConfig()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.2.7 2007-09-04

setUid()

setUid(string  $value, array  $params = FALSE) : boolean

set calendar component property uid

Parameters

string	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::$uid; calendarComponent::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.19.1 2014-02-21

createUrl()

createUrl() : string

creates formatted output for calendar component property url

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$url; calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.4.8 2008-10-21

setUrl()

setUrl(string  $value, array  $params = FALSE) : boolean

set calendar component property url

Parameters

string	$value
array	$params

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$url; calendarComponent::_setParams()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.21 2013-06-23

_createFormat()

_createFormat() : boolean

create element format parts

Returns

boolean

Inherited from: \iCalBase
Uses: iCalBase::$format; iCalBase::$objName; iCalBase::$componentStart1; iCalBase::$elementStart1; iCalBase::$componentStart2; iCalBase::$elementStart2; iCalBase::$componentEnd1; iCalBase::$elementEnd1; iCalBase::$componentEnd2; iCalBase::$elementEnd2; iCalBase::$nl;; iCalBase::$intAttrDelimiter; iCalBase::$attributeDelimiter; iCalBase::$valueInit

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-31

_format_recur()

_format_recur(array  $recurlabel, array  $recurdata) : string

creates formatted output for calendar component property data value type recur

Parameters

array	$recurlabel
array	$recurdata

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::_createElement(); calendarComponent::_createParams(); iCalUtilityFunctions::_date2strdate(); iCalUtilityFunctions::_recurBydaySort()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.16.25 2013-06-30

_notExistProp()

_notExistProp(string  $propName) : boolean

check if property not exists within component

Parameters

string

$propName

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::$lastmodified; calendarComponent::$percentcomplete; calendarComponent::$recurrenceid; calendarComponent::$relatedto; calendarComponent::$requeststatus; calendarComponent::getConfig(); calendarComponent::{$propname}

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.5.1 2008-10-15

getConfig()

getConfig(mixed  $config = FALSE) : \value

get general component config variables or info about subcomponents

Parameters

mixed

$config

Returns

\value

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$allowEmpty; calendarComponent::$compix; calendarComponent::$components; calendarComponent::$objName; calendarComponent::getProperty(); calendarComponent::$format; calendarComponent::$language; calendarComponent::$nl; iCalUtilityFunctions::$miscComps; calendarComponent::$uid; calendarComponent::_makeuid(); calendarComponent::dtstamp; calendarComponent::_makeDtstamp(); calendarComponent::$summary; calendarComponent::$description; calendarComponent::$dtstart; calendarComponent::$dtend; calendarComponent::$due; calendarComponent::$duration; calendarComponent::$rrule; calendarComponent::$rdate; calendarComponent::$exdate; calendarComponent::$exrule; calendarComponent::$action; calendarComponent::$attach; calendarComponent::$attendee; calendarComponent::$categories; calendarComponent::$class; calendarComponent::$comment; calendarComponent::$completed; calendarComponent::$contact; calendarComponent::$created; calendarComponent::$freebusy; calendarComponent::$geo; calendarComponent::$lastmodified; calendarComponent::$location; calendarComponent::$organizer; calendarComponent::$percentcomplete; calendarComponent::$priority; calendarComponent::$recurrenceid; calendarComponent::$relatedto; calendarComponent::$repeat; calendarComponent::$requeststatus; calendarComponent::$resources; calendarComponent::$sequence; calendarComponent::$sequence; calendarComponent::$status; calendarComponent::$transp; calendarComponent::$trigger; calendarComponent::$tzid; calendarComponent::$tzname; calendarComponent::$tzoffsetfrom; calendarComponent::$tzoffsetto; calendarComponent::$tzurl; calendarComponent::$url; calendarComponent::$xprop; calendarComponent::$dtzid; calendarComponent::$unique_id

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-21

setConfig()

setConfig(mixed  $config, string  $value = FALSE, boolean  $softUpdate = FALSE) : void

general component config setting

Parameters

mixed	$config
string	$value
boolean	$softUpdate

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$allowEmpty; calendarComponent::$format; calendarComponent::$language; calendarComponent::$nl; calendarComponent::$dtzid; calendarComponent::$unique_id; calendarComponent::$components; calendarComponent::copy()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.10.18 2013-09-06

deleteProperty()

deleteProperty(mixed  $propName = FALSE, integer  $propix = FALSE) : \bool,

delete component property value

Parameters

mixed	$propName	bool FALSE => X-property
integer	$propix	specific property in case of multiply occurences

Returns

\bool, —

if successfull delete TRUE

Inherited from: \calendarComponent
Uses: calendarComponent::_notExistProp(); iCalUtilityFunctions::$mProps2; calendarComponent::$propdelix; calendarComponent::$action; calendarComponent::deletePropertyM(); calendarComponent::$attendee; calendarComponent::$categories; calendarComponent::$class; calendarComponent::$comment; calendarComponent::$completed; calendarComponent::$contact; calendarComponent::$created; calendarComponent::$description; calendarComponent::$dtend; iCalUtilityFunctions::$miscComps; calendarComponent::$objName; calendarComponent::$dtstamp; calendarComponent::$dtstart; calendarComponent::$due; calendarComponent::$duration; calendarComponent::$exdate; calendarComponent::$exrule; calendarComponent::$freebusy; calendarComponent::$geo; calendarComponent::$lastmodified; calendarComponent::$location; calendarComponent::$organizer; calendarComponent::$percentcomplete; calendarComponent::$priority; calendarComponent::$rdate; calendarComponent::$recurrenceid; calendarComponent::$relatedto; calendarComponent::$repeat; calendarComponent::$requeststatus; calendarComponent::$resources; calendarComponent::$rrule; calendarComponent::$sequence; calendarComponent::$status; calendarComponent::$summary; calendarComponent::$transp; calendarComponent::$trigger; calendarComponent::$tzid; calendarComponent::$tzname; calendarComponent::$tzoffsetfrom; calendarComponent::$tzoffsetto; calendarComponent::$tzurl; calendarComponent::$uid; calendarComponent::$url; calendarComponent::$xprop

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.8.8 2011-03-15

deletePropertyM()

deletePropertyM(array  $multiprop, integer  $propix) : boolean

delete component property value, fixing components with multiple occurencies

Parameters

array	$multiprop	component (multi-)property
integer	$propix	removal counter

Returns

boolean —

TRUE

Inherited from: \calendarComponent

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.8.8 2011-03-15

getProperty()

getProperty(string  $propName = FALSE, integer  $propix = FALSE, boolean  $inclParam = FALSE, boolean  $specform = FALSE) : mixed

get component property value/params

if property has multiply values, consequtive function calls are needed

Parameters

string	$propName
integer	$propix	specific property in case of multiply occurences
boolean	$inclParam
boolean	$specform

Returns

mixed

Inherited from: \calendarComponent
Uses: calendarComponent::getProperty(); iCalUtilityFunctions::_geo2str2(); iCalUtilityFunctions::$geoLatFmt; iCalUtilityFunctions::$geoLongFmt; calendarComponent::_notExistProp(); iCalUtilityFunctions::$mProps2; calendarComponent::$propix; calendarComponent::$action; calendarComponent::$attendee; calendarComponent::$categories; calendarComponent::$class; calendarComponent::$comment; calendarComponent::$completed; calendarComponent::$contact; calendarComponent::$created; calendarComponent::$description; calendarComponent::$dtend; iCalUtilityFunctions::$miscComps; calendarComponent::$dtstamp; calendarComponent::_makeDtstamp(); calendarComponent::$dtstart; calendarComponent::$due; calendarComponent::$duration; iCalUtilityFunctions::_duration2date(); calendarComponent::$exdate; calendarComponent::$exrule; calendarComponent::$freebusy; calendarComponent::$geo; calendarComponent::$lastmodified; calendarComponent::$location; calendarComponent::$organizer; calendarComponent::$percentcomplete; calendarComponent::$priority; calendarComponent::$rdate; calendarComponent::$recurrenceid; calendarComponent::$relatedto; calendarComponent::$repeat; calendarComponent::$requeststatus; calendarComponent::$resources; calendarComponent::$rrule; calendarComponent::$sequence; calendarComponent::$status; calendarComponent::$summary; calendarComponent::$transp; calendarComponent::$trigger; calendarComponent::$tzid; calendarComponent::$tzname; calendarComponent::$tzoffsetfrom; calendarComponent::$tzoffsetto; calendarComponent::$tzurl; calendarComponent::$uid; calendarComponent::$objName; calendarComponent::_makeuid(); calendarComponent::$url; calendarComponent::$xprop

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.13 2015-03-29

_getProperties()

_getProperties(string  $propName, array  $output)

returns calendar property unique values for 'ATTENDEE', 'CATEGORIES', 'CONTACT', 'RELATED-TO' or 'RESOURCES' and for each, number of occurrence

Parameters

string	$propName
array	$output	incremented result array

Inherited from: \calendarComponent
Uses: iCalUtilityFunctions::$mProps1; calendarComponent::getProperty()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-21

setProperty()

setProperty() : void

general component property setting

Inherited from: \calendarComponent
Uses: calendarComponent::getProperty(); calendarComponent::_notExistProp(); calendarComponent::getConfig(); calendarComponent::setAction(); calendarComponent::setAttendee(); calendarComponent::setCategories(); calendarComponent::setClass(); calendarComponent::setComment(); calendarComponent::setCompleted(); calendarComponent::setContact(); calendarComponent::setCreated(); calendarComponent::setDescription(); calendarComponent::setDtend(); calendarComponent::setDtstamp(); calendarComponent::setDtstart(); calendarComponent::setDue(); calendarComponent::setDuration(); calendarComponent::setExdate(); calendarComponent::setExrule(); calendarComponent::setFreebusy(); calendarComponent::setGeo(); calendarComponent::setLastmodified(); calendarComponent::setLocation(); calendarComponent::setOrganizer(); calendarComponent::setPercentcomplete(); calendarComponent::setPriority(); calendarComponent::setRdate(); calendarComponent::setRecurrenceid(); calendarComponent::setRelatedto(); calendarComponent::setRepeat(); calendarComponent::setRequeststatus(); calendarComponent::setResources(); calendarComponent::setRrule(); calendarComponent::setSequence(); calendarComponent::setStatus(); calendarComponent::setSummary(); calendarComponent::setTransp(); calendarComponent::setTrigger(); calendarComponent::setTzid(); calendarComponent::setTzname(); calendarComponent::setTzoffsetfrom(); calendarComponent::setTzoffsetto(); calendarComponent::setTzurl(); calendarComponent::setUid(); calendarComponent::$objName; calendarComponent::setUrl(); calendarComponent::setXprop()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.5.1 2008-11-05

parse()

parse(mixed  $unparsedtext = null) : boolean

parse component unparsed data into properties

Parameters

mixed

$unparsedtext

strict rfc2445 formatted, single property string or array of strings

Returns

boolean —

FALSE if error occurs during parsing

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); iCalUtilityFunctions::convEolChar(); calendarComponent::$unparsed; calendarComponent::$components; calendarComponent::copy(); iCalUtilityFunctions::_splitContent(); calendarComponent::setProperty(); iCalUtilityFunctions::_strunrep(); calendarComponent::parse()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.20.3 2015-03-05

copy()

copy() : object

return a copy of this component

Returns

object

Inherited from: \calendarComponent

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.15.4 2012-10-18

deleteComponent()

deleteComponent(mixed  $arg1, mixed  $arg2 = FALSE) : void

delete calendar subcomponent from component container

Parameters

mixed	$arg1	ordno / component type / component uid
mixed	$arg2	ordno if arg1 = component type

Inherited from: \calendarComponent
Uses: calendarComponent::$components; calendarComponent::$objName; calendarComponent::getProperty()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.8.8 2011-03-15

getComponent()

getComponent(mixed  $arg1 = FALSE, mixed  $arg2 = FALSE) : object

get calendar component subcomponent from component container

Parameters

mixed	$arg1	ordno/component type/ component uid
mixed	$arg2	ordno if arg1 = component type

Returns

object

Inherited from: \calendarComponent
Uses: calendarComponent::$components; calendarComponent::$compix; calendarComponent::$objName; calendarComponent::copy(); calendarComponent::getProperty()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.8.8 2011-03-15

addSubComponent()

addSubComponent(object  $component) : void

add calendar component as subcomponent to container for subcomponents

Parameters

object

$component

calendar component

Inherited from: \calendarComponent
Uses: calendarComponent::setComponent(

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	1.x.x 2007-04-24

newComponent()

newComponent(string  $compType) : object

create new calendar component subcomponent, already included within component

Parameters

string

$compType

subcomponent type

Returns

object —

(reference)

Inherited from: \calendarComponent
Uses: calendarComponent::getConfig(); calendarComponent::$components; calendarComponent::calendarComponent()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.6.33 2011-01-03

setComponent()

setComponent(object  $component, mixed  $arg1 = FALSE, mixed  $arg2 = FALSE) : boolean

add calendar component as subcomponent to container for subcomponents

Parameters

object	$component	calendar component
mixed	$arg1	ordno/component type/ component uid
mixed	$arg2	ordno if arg1 = component type

Returns

boolean

Inherited from: \calendarComponent
Uses: calendarComponent::$components; calendarComponent::setConfig(); calendarComponent::getConfig(); calendarComponent::$objName; iCalUtilityFunctions::$miscComps; calendarComponent::getProperty(); calendarComponent::copy(); iCalUtilityFunctions::$mComps

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-21

createSubComponent()

createSubComponent() : string

creates formatted output for subcomponents

Returns

string

Inherited from: \calendarComponent
Uses: calendarComponent::$objName; calendarComponent::$components; calendarComponent::getProperty(); iCalUtilityFunctions::$fmt; calendarComponent::copy(); calendarComponent::setConfig(); calendarComponent::getConfig(); calendarComponent::createComponent(); calendarComponent::$xcaldecl()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-10

createXprop()

createXprop() : string

creates formatted output for calendar/component property x-prop

Returns

string

Inherited from: \iCalBase
Uses: iCalBase::$xprop; vcalendar::getConfig(); calendarComponent::getConfig(); iCalBase::_createElement(); iCalBase::_createParams(); iCalUtilityFunctions::_strrep(); iCalBase::$format; iCalBase::$nl

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-31

setXprop()

setXprop(string  $label, string  $value, array  $params = FALSE) : boolean

set calendar property x-prop

Parameters

string	$label
string	$value
array	$params	optional

Returns

boolean

Inherited from: \iCalBase
Uses: vcalendar::getConfig(); iCalUtilityFunctions::_setParams(); iCalBase::$xprop

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-31

createComponent()

createComponent(array  $xcaldecl) : string

create formatted output for calendar component VEVENT object instance

Parameters

array

$xcaldecl

Returns

string

Uses: calendarComponent::_createFormat(); calendarComponent::$componentStart1; calendarComponent::$componentStart2; calendarComponent::$nl;; calendarComponent::createUid(); calendarComponent::createDtstamp(); calendarComponent::createAttach(); calendarComponent::createAttendee(); calendarComponent::createCategories(); calendarComponent::createComment(); calendarComponent::createContact(); calendarComponent::createClass(); calendarComponent::createCreated(); calendarComponent::createDescription(); calendarComponent::createDtstart(); calendarComponent::createDtend(); calendarComponent::createDuration(); calendarComponent::createExdate(); calendarComponent::createExrule(); calendarComponent::createGeo(); calendarComponent::createLastModified(); calendarComponent::createLocation(); calendarComponent::createOrganizer(); calendarComponent::createPriority(); calendarComponent::createRdate(); calendarComponent::createRrule(); calendarComponent::createRelatedTo(); calendarComponent::createRequestStatus(); calendarComponent::createRecurrenceid(); calendarComponent::createResources(); calendarComponent::createSequence(); calendarComponent::createStatus(); calendarComponent::createSummary(); calendarComponent::createTransp(); calendarComponent::createUrl(); calendarComponent::createXprop(); calendarComponent::createSubComponent(); calendarComponent::$componentEnd1; calendarComponent::$componentEnd2; calendarComponent::$xcaldecl

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.10.16 2011-10-28

_createElement()

_createElement(string  $label, string  $attributes = null, string  $content = FALSE) : string

creates formatted output for calendar component property

Parameters

string	$label	property name
string	$attributes	property attributes
string	$content	property content (optional)

Returns

string

Inherited from: \iCalBase
Uses: iCalBase::$format; iCalBase::$elementStart1; iCalBase::$xcaldecl; iCalBase::$intAttrDelimiter; iCalBase::$attributeDelimiter; iCalBase::_createElement(); iCalBase::$elementStart2; iCalBase::$nl; iCalBase::$valueInit; iCalUtilityFunctions::_size75(); iCalBase::$elementEnd1; iCalBase::$elementEnd2

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-31

_createParams()

_createParams(array  $params = array(), array  $ctrKeys = array()) : string

creates formatted output for calendar component property parameters

Parameters

array	$params	optional
array	$ctrKeys	optional

Returns

string

Inherited from: \iCalBase
Uses: iCalBase::$intAttrDelimiter; vcalendar::getConfig(); calendarComponent::getConfig()

Tags

author	Kjell-Inge Gustafsson, kigkonsult ical@kigkonsult.se
since	2.21.11 2015-03-31