Docs For Class vcalendar

constructor vcalendar [line 90]

vcalendar vcalendar(
)

[ Top ]

method addComponent [line 780]

void addComponent(
object
$component)

add calendar component to container

alias to setComponent

Tags:

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

Parameters:

object

$component

calendar component

[ Top ]

method createCalendar [line 1525]

string createCalendar(
)

creates formatted output for calendar object instance

Tags:

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

[ Top ]

method createCalscale [line 123]

string createCalscale(
)

creates formatted output for calendar property calscale

Tags:

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

[ Top ]

method createMethod [line 157]

string createMethod(
)

creates formatted output for calendar property method

Tags:

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

[ Top ]

method createProdid [line 195]

string createProdid(
)

creates formatted output for calendar property prodid

Tags:

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

[ Top ]

method createVersion [line 248]

string createVersion(
)

creates formatted output for calendar property version

Tags:

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

[ Top ]

method createXprop [line 292]

string createXprop(
)

creates formatted output for calendar property x-prop, iCal format only

Tags:

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

[ Top ]

method deleteComponent [line 792]

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

delete calendar component from container

Tags:

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

Parameters:

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

[ Top ]

method deleteProperty [line 343]

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

delete calendar property value

Tags:

return:	if successfull delete
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 getComponent [line 832]

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

get calendar component from 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 481]

value getConfig(
string
$config)

get vcalendar config values or * calendar components

Tags:

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

Parameters:

string

$config

[ Top ]

method getProperty [line 390]

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

get calendar property value/params

Tags:

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

Parameters:

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

[ Top ]

method parse [line 1275]

bool parse(
[string
$filename = FALSE])

parse iCal file into vcalendar, components, properties and parameters

Tags:

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

Parameters:

string

$filename

optional filname (incl. opt. directory/path) or URL

[ Top ]

method returnCalendar [line 1617]

redirect returnCalendar(
)

a HTTP redirect header is sent with created, updated and/or parsed calendar

Tags:

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

[ Top ]

method saveCalendar [line 1643]

bool saveCalendar(
[string
$directory = FALSE], [string
$filename = FALSE], [string
$delimiter = FALSE])

save content in a file

Tags:

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

Parameters:

string	$directory	optional
string	$filename	optional
string	$delimiter	optional

[ Top ]

method selectComponents [line 900]

array selectComponents(
[int
$startY = FALSE], [int
$startM = FALSE], [int
$startD = FALSE], [int
$endY = FALSE], [
$endM = FALSE], [
$endD = FALSE], [mixed
$cType = FALSE], [bool
$flat = FALSE], [bool
$any = TRUE], [bool
$split = TRUE])

select components from calendar on date basis

Ensure DTSTART is set for every component. No date controls occurs.

Tags:

return:	or FALSE
author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.4.1 - 2008-02-05

Parameters:

int	$startY	optional, start Year, default current Year
int	$startM	optional, start Month, default current Month
int	$startD	optional, start Day, default current Day
int	$endY	optional, end Day, default $startD
mixed	$cType	optional, calendar component type(-s), default FALSE=all else string/array type(-s)
bool	$flat	optional, FALSE (default) => output : array[Year][Month][Day][] TRUE => output : array[] (ignores split)
bool	$any	optional, TRUE (default) - select component that take place within period FALSE - only components that starts within period
bool	$split	optional, TRUE (default) - one component copy every day it take place during the period (implies flat=FALSE) FALSE - one occurance of component only in output array</tr>
	$endM
	$endD

[ Top ]

method setCalscale [line 143]

void setCalscale(
string
$value)

set calendar property calscale

Tags:

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

Parameters:

string

$value

[ Top ]

method setComponent [line 1141]

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

add calendar component to container

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 566]

void setConfig(
string
$config, string
$value)

general vcalendar config setting

Tags:

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

Parameters:

string	$config
string	$value

[ Top ]

method setMethod [line 177]

void setMethod(
string
$method)

set calendar property method

Tags:

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

Parameters:

string

$method

[ Top ]

method setProperty [line 445]

void setProperty(
mixed
$args)

general vcalendar property setting

Tags:

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

Parameters:

mixed

$args

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

[ Top ]

method setVersion [line 278]

void setVersion(
string
$version)

set calendar version

Tags:

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

Parameters:

string

$version

version

[ Top ]

method setXprop [line 325]

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

set calendar property x-prop

Tags:

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

Parameters:

string	$label
string	$value
array	$params	optional

[ Top ]

method sort [line 1260]

void sort(
)

[ Top ]

method useCachedCalendar [line 1674]

redirect/FALSE useCachedCalendar(
[string
$directory = FALSE], [string
$filename = FALSE], [string
$delimiter = FALSE], [int
$timeout = 3600])

if recent version of calendar file exists (default one hour), an HTTP redirect header is sent else FALSE is returned

Tags:

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

Parameters:

string	$directory	optional alt. int timeout
string	$filename	optional
string	$delimiter	optional
int	$timeout	timeout optional, default 3600 sec

[ Top ]

method validDate [line 674]

bool validDate(
mixed
$year, [mixed
$month = FALSE], [int
$day = FALSE], [int
$hour = FALSE], [int
$min = FALSE], [int
$sec = FALSE], [mixed
$tz = FALSE], [bool
$utc = FALSE])

validDate

convert input parameters to (valid) iCalcreator date in array format (or FALSE) if $utc=TRUE and $tz = utc offset ([[+/]-]HHmm) input (local) date array + UTC offset returns ouput in UTC format date

Tags:

return:	false / array $date
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
mixed	$tz	optional
bool	$utc	optional

[ Top ]

method _cmpfcn [line 1197]

sort _cmpfcn(

$a, 
$b)

sort iCal compoments, only local date sort

Tags:

return:	param
author:	Kjell-Inge Gustafsson <ical@kigkonsult.se>
since:	2.2.9 - 2007-10-02

Parameters:

	$a
	$b

[ Top ]

method _makeProdid [line 214]

void _makeProdid(
)

make default value for calendar prodid

Tags:

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

[ Top ]

method _makeUnique_id [line 231]

void _makeUnique_id(
)

make default unique_id for calendar prodid

Tags:

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

[ Top ]

method _makeVersion [line 267]

void _makeVersion(
)

set default calendar version

Tags:

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

[ Top ]

Class: vcalendar

Class Overview

Author(s):

Variables

Methods

Class Details

Tags:

Class Variables

$allowEmpty =

$attributeDelimiter =

$calscale =

$components =

$delimiter =

$directory =

$filename =

$format =

$language =

$method =

$nl =

$prodid =

$unique_id =

$url =

$valueInit =

$version =

$xcaldecl =

$xprop =

Class Methods

constructor vcalendar [line 90]

method addComponent [line 780]

Tags:

Parameters:

method createCalendar [line 1525]

Tags:

method createCalscale [line 123]

Tags:

method createMethod [line 157]

Tags:

method createProdid [line 195]

Tags:

method createVersion [line 248]

Tags:

method createXprop [line 292]

Tags:

method deleteComponent [line 792]

Tags:

Parameters:

method deleteProperty [line 343]

Tags:

Parameters:

method getComponent [line 832]

Tags:

Parameters:

method getConfig [line 481]

Tags:

Parameters:

method getProperty [line 390]

Tags:

Parameters:

method parse [line 1275]

Tags:

Parameters:

method returnCalendar [line 1617]

Tags:

method saveCalendar [line 1643]

Tags:

Parameters:

method selectComponents [line 900]

Tags:

Parameters:

method setCalscale [line 143]

Tags:

Parameters:

method setComponent [line 1141]

Tags:

Parameters:

method setConfig [line 566]

Tags:

Parameters:

method setMethod [line 177]

Tags: