Docs For Class calendarComponent

constructor calendarComponent [line 1797]

calendarComponent calendarComponent(
)

constructor for calendar component object

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.1 - 2007-11-19

[ Top ]

method addSubComponent [line 6834]

void addSubComponent(
object
$component)

add calendar component as subcomponent to container for subcomponents

Tags:

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

Parameters:

object

$component

calendar component

[ Top ]

method copy [line 6725]

object copy(
)

return a copy of this component

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.16 - 2007-11-07

[ Top ]

method createAction [line 1867]

string createAction(
)

creates formatted output for calendar component property action

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createAttach [line 1897]

string createAttach(
)

creates formatted output for calendar component property attach

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createAttendee [line 1934]

string createAttendee(
)

creates formatted output for calendar component property attendee

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-20

[ Top ]

method createCategories [line 2079]

string createCategories(
)

creates formatted output for calendar component property categories

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-24

[ Top ]

method createClass [line 2123]

string createClass(
)

creates formatted output for calendar component property class

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createComment [line 2154]

string createComment(
)

creates formatted output for calendar component property comment

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createCompleted [line 2191]

string createCompleted(
)

creates formatted output for calendar component property completed

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createContact [line 2231]

string createContact(
)

creates formatted output for calendar component property contact

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-24

[ Top ]

method createCreated [line 2268]

string createCreated(
)

creates formatted output for calendar component property created

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createDescription [line 2311]

string createDescription(
)

creates formatted output for calendar component property description

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createDtend [line 2348]

string createDtend(
)

creates formatted output for calendar component property dtend

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.19 - 2007-03-27

[ Top ]

method createDtstamp [line 2389]

string createDtstamp(
)

creates formatted output for calendar component property dtstamp

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.4 - 2007-08-01

[ Top ]

method createDtstart [line 2446]

string createDtstart(
[bool
$localtime = FALSE])

creates formatted output for calendar component property dtstart

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

Parameters:

bool

$localtime

optional, default FALSE

[ Top ]

method createDue [line 2489]

string createDue(
)

creates formatted output for calendar component property due

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.19 - 2007-03-27

[ Top ]

method createDuration [line 2529]

string createDuration(
)

creates formatted output for calendar component property duration

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createExdate [line 2579]

string createExdate(
)

creates formatted output for calendar component property exdate

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createExrule [line 2697]

string createExrule(
)

creates formatted output for calendar component property exrule

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.7.28 - 2006-09-13

[ Top ]

method createFreebusy [line 2756]

string createFreebusy(
)

creates formatted output for calendar component property freebusy

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-16

[ Top ]

method createGeo [line 2866]

string createGeo(
)

creates formatted output for calendar component property geo

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createLastModified [line 2903]

string createLastModified(
)

creates formatted output for calendar component property last-modified

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createLocation [line 2947]

string createLocation(
)

creates formatted output for calendar component property location

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createOrganizer [line 2979]

string createOrganizer(
)

creates formatted output for calendar component property organizer

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createPercentComplete [line 3018]

string createPercentComplete(
)

creates formatted output for calendar component property percent-complete

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createPriority [line 3049]

string createPriority(
)

creates formatted output for calendar component property priority

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createRdate [line 3081]

string createRdate(
[bool
$localtime = FALSE])

creates formatted output for calendar component property rdate

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-13

Parameters:

bool

$localtime

optional, default FALSE

[ Top ]

method createRecurrenceid [line 3376]

string createRecurrenceid(
)

creates formatted output for calendar component property recurrence-id

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-26

[ Top ]

method createRelatedTo [line 3412]

string createRelatedTo(
)

creates formatted output for calendar component property related-to

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-25

[ Top ]

method createRepeat [line 3457]

string createRepeat(
)

creates formatted output for calendar component property repeat

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createRequestStatus [line 3487]

string createRequestStatus(
)

creates formatted output for calendar component property request-status

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-16

[ Top ]

method createResources [line 3533]

string createResources(
)

creates formatted output for calendar component property resources

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-24

[ Top ]

method createRrule [line 3576]

string createRrule(
)

creates formatted output for calendar component property rrule

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.7.43 - 2006-09-15

[ Top ]

method createSequence [line 3633]

string createSequence(
)

creates formatted output for calendar component property sequence

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createStatus [line 3665]

string createStatus(
)

creates formatted output for calendar component property status

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createSubComponent [line 6902]

string createSubComponent(
)

creates formatted output for subcomponents

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.13 - 2007-10-25

[ Top ]

method createSummary [line 3696]

string createSummary(
)

creates formatted output for calendar component property summary

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createTransp [line 3728]

string createTransp(
)

creates formatted output for calendar component property transp

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createTrigger [line 3759]

string createTrigger(
)

creates formatted output for calendar component property trigger

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.19 - 2007-03-27

[ Top ]

method createTzid [line 3915]

string createTzid(
)

creates formatted output for calendar component property tzid

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-25

[ Top ]

method createTzname [line 3949]

string createTzname(
)

creates formatted output for calendar component property tzname

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-25

[ Top ]

method createTzoffsetfrom [line 3987]

string createTzoffsetfrom(
)

creates formatted output for calendar component property tzoffsetfrom

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createTzoffsetto [line 4020]

string createTzoffsetto(
)

creates formatted output for calendar component property tzoffsetto

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createTzurl [line 4053]

string createTzurl(
)

creates formatted output for calendar component property tzurl

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createUid [line 4086]

string createUid(
)

creates formatted output for calendar component property uid

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createUrl [line 4140]

string createUrl(
)

creates formatted output for calendar component property url

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

[ Top ]

method createXprop [line 4173]

string createXprop(
)

creates formatted output for calendar component property x-prop

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-25

[ Top ]

method deleteComponent [line 6742]

void deleteComponent(
mixed
$arg1, [mixed
$arg2 = FALSE])

delete calendar subcomponent from component container

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.0.4 - 2007-06-20

Parameters:

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

[ Top ]

method deleteProperty [line 5806]

bool, deleteProperty(
string
$propName, [int
$propix = FALSE])

delete component property value

Tags:

return:	if successfull delete TRUE
author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.15 - 2007-10-29

Parameters:

string	$propName
int	$propix	@propix, optional, if specific property is wanted in case of multiply occurences

[ Top ]

method duration2date [line 4682]

array, duration2date(
[
$startdate = FALSE], [
$duration = FALSE], array
$startdate,, array
$duration,)

convert duration to date in array format based on dtstart value

Tags:

return:	date format
author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.11 - 2007-12-02

Parameters:

array	$startdate,	optional
array	$duration,	optional
	$startdate
	$duration

[ Top ]

method getComponent [line 6782]

object getComponent(
[mixed
$arg1 = FALSE], [mixed
$arg2 = FALSE])

get calendar component subcomponent from component container

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.16 - 2007-11-11

Parameters:

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

[ Top ]

method getConfig [line 5633]

value getConfig(
string
$config)

get general component config variables or info about subcomponents

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.13 - 2007-10-23

Parameters:

string

$config

[ Top ]

method getProperty [line 6067]

mixed getProperty(
[
$propName = FALSE], [int
$propix = FALSE], [
$inclParam = FALSE], [
$specform = FALSE], string
$propName,, bool
$inclParam=FALSE, bool
$specform=FALSE)

get component property value/params

if property has multiply values, consequtive function calls are needed

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.1.1 - 2007-07-07

Parameters:

string	$propName,	optional
bool	$inclParam=FALSE
bool	$specform=FALSE
int	$propix	@propix, optional, if specific property is wanted in case of multiply occurences
	$propName
	$inclParam
	$specform

[ Top ]

method parse [line 6444]

bool parse(
[
$unparsedtext = null], mixed
$unparsedtext,)

parse component unparsed data into properties

Tags:

return:	FALSE if error occurs during parsing
author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.4.2 - 2008-02-07

Parameters:

mixed	$unparsedtext,	strict rfc2445 formatted, single property string or array of property strings
	$unparsedtext

[ Top ]

method setAction [line 1882]

void setAction(
string
$value, [mixed
$params = FALSE])

set calendar component property action

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.2 - 2006-11-16

Parameters:

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

[ Top ]

method setAttach [line 1917]

void setAttach(
string
$value, [string
$params = FALSE])

set calendar component property attach

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.22 - 2007-04-10

Parameters:

string	$value
string	$params

[ Top ]

method setAttendee [line 2003]

void setAttendee(
string
$value, [array
$params = FALSE])

set calendar component property attach

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-24

Parameters:

string	$value
array	$params	optional

[ Top ]

method setCategories [line 2106]

void setCategories(
mixed
$value, [array
$params = FALSE])

set calendar component property categories

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-24

Parameters:

mixed	$value
array	$params	optional

[ Top ]

method setClass [line 2139]

void setClass(
string
$value, [array
$params = FALSE])

set calendar component property class

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2003-03-18

Parameters:

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

[ Top ]

method setComment [line 2175]

void setComment(
string
$value, [array
$params = FALSE])

set calendar component property comment

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
array	$params	optional

[ Top ]

method setCompleted [line 2217]

void setCompleted(
mixed
$year, [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [array
$params = FALSE])

set calendar component property completed

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-08-02

Parameters:

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

[ Top ]

method setComponent [line 6847]

void setComponent(
object
$component, [mixed
$arg1 = FALSE], [mixed
$arg2 = FALSE])

add calendar component as subcomponent to container for subcomponents

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.16 - 2007-11-11

Parameters:

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

[ Top ]

method setConfig [line 5773]

void setConfig(
string
$config, string
$value)

general component config setting

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.13 - 2007-10-25

Parameters:

string	$config
string	$value

[ Top ]

method setContact [line 2252]

void setContact(
string
$value, [array
$params = FALSE])

set calendar component property contact

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-25

Parameters:

string	$value
array	$params	optional

[ Top ]

method setCreated [line 2294]

void setCreated(
[mixed
$year = FALSE], [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [mixed
$params = FALSE])

set calendar component property created

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-08-02

Parameters:

mixed	$year	optional
mixed	$month	optional
int	$day	optional
int	$hour	optional
int	$min	optional
int	$sec	optional
mixed	$params	optional

[ Top ]

method setDescription [line 2332]

void setDescription(
string
$value, [array
$params = FALSE])

set calendar component property description

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
array	$params	optional

[ Top ]

method setDtend [line 2375]

void setDtend(
mixed
$year, [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [string
$tz = FALSE], [array
$params = FALSE])

set calendar component property dtend

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-07-29

Parameters:

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

[ Top ]

method setDtstamp [line 2431]

void setDtstamp(
mixed
$year, [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [array
$params = FALSE])

set calendar component property dtstamp

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-08-02

Parameters:

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

[ Top ]

method setDtstart [line 2475]

void setDtstart(
mixed
$year, [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [string
$tz = FALSE], [array
$params = FALSE])

set calendar component property dtstart

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-07-29

Parameters:

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

[ Top ]

method setDue [line 2515]

void setDue(
mixed
$year, [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [
$tz = FALSE], [array
$params = FALSE])

set calendar component property due

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-07-29

Parameters:

mixed	$year
mixed	$month	optional
int	$day	optional
int	$hour	optional
int	$min	optional
int	$sec	optional
array	$params	optional
	$tz

[ Top ]

method setDuration [line 2552]

void setDuration(
[mixed
$week = FALSE], [mixed
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [array
$params = FALSE])

set calendar component property duration

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

mixed	$week
mixed	$day	optional
int	$hour	optional
int	$min	optional
int	$sec	optional
array	$params	optional

[ Top ]

method setExdate [line 2618]

void setExdate(
array
$exdates, [array
$params = FALSE])

set calendar component property exdate

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.0.5 - 2007-06-22

Parameters:

array	$params	optional
array	$exdates	exdates

[ Top ]

method setExrule [line 2713]

void setExrule(
array
$exruleset, [array
$params = FALSE])

set calendar component property exdate

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

array	$exruleset
array	$params	optional

[ Top ]

method setFreebusy [line 2809]

void setFreebusy(
string
$fbType, array
$fbValues, [array
$params = FALSE])

set calendar component property freebusy

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$fbType
array	$fbValues
array	$params	optional

[ Top ]

method setGeo [line 2887]

void setGeo(
float
$latitude, float
$longitude, [array
$params = FALSE])

set calendar component property geo

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

float	$latitude
float	$longitude
array	$params	optional

[ Top ]

method setLastModified [line 2929]

void setLastModified(
[mixed
$year = FALSE], [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [array
$params = FALSE])

set calendar component property completed

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-08-02

Parameters:

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

[ Top ]

method setLocation [line 2964]

void setLocation(
string
$value, [array
$params = FALSE])

set calendar component property location

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
array	$params	params optional

[ Top ]

method setOrganizer [line 2997]

void setOrganizer(
string
$value, [array
$params = FALSE])

set calendar component property organizer

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.0.9 - 2007-06-30

Parameters:

string	$value
array	$params	params optional

[ Top ]

method setPercentComplete [line 3034]

void setPercentComplete(
int
$value, [array
$params = FALSE])

set calendar component property percent-complete

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

int	$value
array	$params	optional

[ Top ]

method setPriority [line 3065]

void setPriority(
int
$value, [array
$params = FALSE])

set calendar component property priority

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

int	$value
array	$params	optional

[ Top ]

method setProperty [line 6287]

void setProperty(
mixed
$args)

general component property setting

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.13 - 2007-10-25

Parameters:

mixed

$args

variable number of function arguments, first argument is ALWAYS component name, second ALWAYS component value!

[ Top ]

method setRdate [line 3186]

void setRdate(
array
$rdates, [array
$params = FALSE])

set calendar component property rdate

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.14 - 2007-10-30

Parameters:

array	$rdates
array	$params	optional

[ Top ]

method setRecurrenceid [line 3398]

void setRecurrenceid(
mixed
$year, [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [
$tz = FALSE], [array
$params = FALSE])

set calendar component property recurrence-id

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-07-29

Parameters:

mixed	$year
mixed	$month	optional
int	$day	optional
int	$hour	optional
int	$min	optional
int	$sec	optional
array	$params	optional
	$tz

[ Top ]

method setRelatedTo [line 3433]

void setRelatedTo(
float
$relid, [array
$params = FALSE])

set calendar component property related-to

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-24

Parameters:

float	$relid
array	$params	optional

[ Top ]

method setRepeat [line 3473]

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

set calendar component property transp

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
array	$params	optional

[ Top ]

method setRequestStatus [line 3513]

void setRequestStatus(
float
$statcode, string
$text, [string
$extdata = FALSE], [array
$params = FALSE])

set calendar component property request-status

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-16

Parameters:

float	$statcode
string	$text
string	$extdata	optional
array	$params	params optional

[ Top ]

method setResources [line 3559]

void setResources(
mixed
$value, [array
$params = FALSE])

set calendar component property recources

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-24

Parameters:

mixed	$value
array	$params	params optional

[ Top ]

method setRrule [line 3591]

void setRrule(
array
$rruleset, [array
$params = FALSE])

set calendar component property rrule

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

array	$rruleset
array	$params	optional

[ Top ]

method setSequence [line 3648]

void setSequence(
[int
$value = FALSE], [array
$params = FALSE])

set calendar component property sequence

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-04-25

Parameters:

int	$value	optional
array	$params	optional

[ Top ]

method setStatus [line 3681]

void setStatus(
string
$value, [array
$params = FALSE])

set calendar component property status

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
array	$params	optional

[ Top ]

method setSummary [line 3713]

void setSummary(
string
$value, [string
$params = FALSE])

set calendar component property summary

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
string	$params	optional

[ Top ]

method setTransp [line 3744]

void setTransp(
string
$value, [string
$params = FALSE])

set calendar component property transp

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
string	$params	optional

[ Top ]

method setTrigger [line 3797]

void setTrigger(
[mixed
$year = FALSE], [mixed
$month = FALSE], [int
$day = FALSE], [int
$week = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [bool
$relatedEnd = FALSE], [bool
$after = FALSE], [string
$tz = FALSE], [array
$params = FALSE])

set calendar component property trigger

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.1.1 - 2007-07-07

Parameters:

mixed	$year
mixed	$month	optional
int	$day	optional
int	$week	optional
int	$hour	optional
int	$min	optional
int	$sec	optional
bool	$relatedEnd	optional
bool	$after	optional
string	$tz	optional
array	$params	optional

[ Top ]

method setTzid [line 3931]

void setTzid(
string
$value, [array
$params = FALSE])

set calendar component property tzid

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-25

Parameters:

string	$value
array	$params	optional

[ Top ]

method setTzname [line 3969]

void setTzname(
string
$value, [string
$params = FALSE])

set calendar component property tzname

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.2 - 2007-11-25

Parameters:

string	$value
string	$params	optional

[ Top ]

method setTzoffsetfrom [line 4003]

void setTzoffsetfrom(
string
$value, [string
$params = FALSE])

set calendar component property tzoffsetfrom

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-25

Parameters:

string	$value
string	$params	optional

[ Top ]

method setTzoffsetto [line 4036]

void setTzoffsetto(
string
$value, [string
$params = FALSE])

set calendar component property tzoffsetto

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
string	$params	optional

[ Top ]

method setTzurl [line 4069]

void setTzurl(
string
$value, [string
$params = FALSE])

set calendar component property tzurl

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
string	$params	optional

[ Top ]

method setUid [line 4123]

void setUid(
string
$value, [string
$params = FALSE])

set calendar component property uid

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
string	$params	optional

[ Top ]

method setUrl [line 4156]

void setUrl(
string
$value, [string
$params = FALSE])

set calendar component property url

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.18 - 2007-03-18

Parameters:

string	$value
string	$params	optional

[ Top ]

method setXprop [line 4200]

void setXprop(
string
$label, mixed
$value, [array
$params = FALSE])

set calendar component property x-prop

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.0.7 - 2007-06-21

Parameters:

string	$label
mixed	$value
array	$params	optional

[ Top ]

method _createElement [line 4259]

string _createElement(
string
$label, string
$attributes, [string
$content = FALSE])

creates formatted output for calendar component property

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.15 - 2007-01-08

Parameters:

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

[ Top ]

method _createFormat [line 4217]

string _createFormat(
)

create element format parts

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.0.6 - 2006-06-20

[ Top ]

method _createParams [line 4385]

string _createParams(
[array
$params = array()], [array
$ctrKeys = array()])

creates formatted output for calendar component property parameters

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.22 - 2007-04-10

Parameters:

array	$params	optional
array	$ctrKeys	optional

[ Top ]

method _date2duration [line 4430]

array _date2duration(
[
$startdate = FALSE], [
$enddate = FALSE], array
$startdate,, array
$duration,)

convert local startdate/enddate (Ymd[His]) to duration

uses this component dates if missing input dates

Tags:

return:	duration
author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.11 - 2007-11-03

Parameters:

array	$startdate,	optional
array	$duration,	optional
	$startdate
	$enddate

[ Top ]

method _date2timestamp [line 4463]

timestamp _date2timestamp(
array
$datetime, [string
$tz = null])

convert date/datetime to timestamp

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-07-29

Parameters:

array	$datetime	datetime/(date)
string	$tz	timezone

[ Top ]

method _date_time_array [line 4494]

array _date_time_array(
array
$datetime, [int
$parno = FALSE])

ensures internal date-time/date format for input date-time/date in array format

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.3.0 - 2006-08-15

Parameters:

array	$datetime
int	$parno	optional, default FALSE

[ Top ]

method _date_time_string [line 4533]

array _date_time_string(
array
$datetime, [int
$parno = FALSE])

ensures internal date-time/date format for input date-time/date in string fromat

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.10 - 2007-10-19

Parameters:

array	$datetime
int	$parno	optional, default FALSE

[ Top ]

method _duration_array [line 4632]

array _duration_array(
array
$duration)

ensures internal duration format for input in array format

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.1.1 - 2007-06-24

Parameters:

array

$duration

[ Top ]

method _duration_string [line 4734]

array _duration_string(
string
$duration)

ensures internal duration format for input in string format

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.0.5 - 2007-03-14

Parameters:

string

$duration

[ Top ]

method _existRem [line 4789]

int _existRem(

&$array, string
$expkey, [string
$expval = FALSE], [int
$hitval = null], array
$array)

if exist, remove key with expected value from array and return spec. value

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.19 - 2007-03-18

Parameters:

array	$array
string	$expkey
string	$expval
int	$hitval	optional
	&$array

[ Top ]

method _formatPropertyName [line 5010]

string _formatPropertyName(
string
$propertyName)

create property name case - lower/upper

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

Parameters:

string

$propertyName

[ Top ]

method _format_date_time [line 4810]

string _format_date_time(
array
$datetime, [
$parno = 6], int
$parno,)

creates formatted output for calendar component property data value type date/date-time

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-07-29

Parameters:

array	$datetime
int	$parno,	optional, default 6
	$parno

[ Top ]

method _format_duration [line 4875]

string _format_duration(
array
$duration)

creates formatted output for calendar component property data value type duration

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-13

Parameters:

array

$duration

( week, day, hour, min, sec )

[ Top ]

method _format_recur [line 4922]

string _format_recur(
array
$recurlabel, array
$recurdata)

creates formatted output for calendar component property data value type recur

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	0.9.7 - 2006-11-20

Parameters:

array	$recurlabel
array	$recurdata

[ Top ]

method _makeDtstamp [line 2408]

void _makeDtstamp(
)

computes datestamp for calendar component object instance dtstamp

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-13

[ Top ]

method _makeUid [line 4101]

void _makeUid(
)

create an unique id for this calendar component object instance

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.7 - 2007-09-04

[ Top ]

method _recur2date [line 5035]

array _recur2date(

&$result, 
$recur, 
$wdate, 
$startdate, [
$enddate = FALSE], array
$result,, array
$recur,, array
$wdate,, array
$startdate,, array
$enddate,)

remakes a recur pattern to an array of dates

if missing, UNTIL is set 1 year from startdate (emergency break)

Tags:

return:	of recurrence (start-)dates as index
author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
todo:	BYHOUR, BYMINUTE, BYSECOND, ev. BYSETPOS due to ambiguity, WEEKLY at year end/start
since:	2.2.11 - 2007-11-26

Parameters:

array	$result,	array to update, array([timestamp] => timestamp)
array	$recur,	pattern for recurrency (only value part, params ignored)
array	$wdate,	component start date
array	$startdate,	start date
array	$enddate,	optional
	&$result
	$recur
	$wdate
	$startdate
	$enddate

[ Top ]

method _recurBYcntcheck [line 5369]

void _recurBYcntcheck(

$BYvalue, 
$upValue, 
$downValue)

Parameters:

	$BYvalue
	$upValue
	$downValue

[ Top ]

method _recurIntervalIx [line 5378]

void _recurIntervalIx(

$freq, 
$date, 
$wkst)

Parameters:

	$freq
	$date
	$wkst

[ Top ]

method _setDate [line 5412]

array _setDate(
mixed
$year, [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [
$tz = FALSE], [array
$params = FALSE])

convert format for input date to internal date with parameters

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-08-01

Parameters:

mixed	$year
mixed	$month	optional
int	$day	optional
int	$hour	optional
int	$min	optional
int	$sec	optional
array	$params	optional
	$tz

[ Top ]

method _setDate2 [line 5498]

array _setDate2(
mixed
$year, [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [array
$params = FALSE])

convert format for input date (UTC) to internal date with parameters

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-08-02

Parameters:

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

[ Top ]

method _setParams [line 5543]

array _setParams(
array
$params, [array
$defaults = FALSE])

set input (formatted) parameters- component property attributes

default parameters can be set, if missing

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	1.x.x - 2007-05-01

Parameters:

array	$params
array	$defaults

[ Top ]

method _size75 [line 6938]

string _size75(

$string, string
$value)

break lines at pos 75

Lines of text SHOULD NOT be longer than 75 octets, excluding the line break. Long content lines SHOULD be split into a multiple line representations using a line "folding" technique. That is, a long line can be split between any two characters by inserting a CRLF immediately followed by a single linear white space character (i.e., SPACE, US-ASCII decimal 32 or HTAB, US-ASCII decimal 9). Any sequence of CRLF followed immediately by a single linear white space character is ignored (i.e., removed) when processing the content type.

Edited 2007-08-26 by Anders Litzell, anders@litzell.se to fix bug where the reserved expression "\n" in the arg $string could be broken up by the folding of lines, causing ambiguity in the return string. Fix uses var $breakAtChar=75 and breaks the line at $breakAtChar-1 if need be.

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.8 - 2006-09-03

Parameters:

string	$value
	$string

[ Top ]

method _stepdate [line 5579]

void _stepdate(

&$date, 
&$timestamp, [
$step = array( 'day' => 1 )], array
$date,, int
$timestamp, array
$step,)

step date, return updated date, array and timpstamp

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.15 - 2007-11-12

Parameters:

array	$date,	date to step
int	$timestamp
array	$step,	default array( 'day' => 1 )
	&$date
	&$timestamp
	$step

[ Top ]

method _strrep [line 6964]

string _strrep(
string
$string)

special characters management output

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.3 - 2007-12-20

Parameters:

string

$string

[ Top ]

method _strunrep [line 7008]

string _strunrep(
string
$string)

special characters management input (from iCal file)

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.3.3 - 2007-11-23

Parameters:

string

$string

[ Top ]

method _tz2offset [line 5597]

integer _tz2offset(

$tz, string
$offset)

convert (numeric) tz to offset seconds

Tags:

author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.2 - 2007-07-29

Parameters:

string	$offset
	$tz

[ Top ]

Class: calendarComponent

Class Overview

Author(s):

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$action =

$allowEmpty =

$attach =

$attendee =

$attributeDelimiter =

$categories =

$class =

$comment =

$completed =

$componentEnd1 =

$componentEnd2 =

$components =

$componentStart1 =

$componentStart2 =

$contact =

$created =

$description =

$dtend =

$dtstamp =

$dtstart =

$due =

$duration =

$elementEnd1 =

$elementEnd2 =

$elementStart1 =

$elementStart2 =

$exdate =

$exrule =

$format =

$freebusy =

$geo =

$intAttrDelimiter =

$language =

$lastmodified =

$location =

$nl =

$objName =

$organizer =

$percentcomplete =

$priority =

$rdate =

$recurrenceid =

$relatedto =

$repeat =

$requeststatus =

$resources =

$rrule =

$sequence =

$status =

$summary =

$transp =

$trigger =

$tzid =

$tzname =

$tzoffsetfrom =

$tzoffsetto =

$tzurl =

$uid =

$unique_id =

$url =

$valueInit =

$xcaldecl =

$xprop =

Class Methods

constructor calendarComponent [line 1797]

Tags:

method addSubComponent [line 6834]

Tags:

Parameters:

method copy [line 6725]

Tags: