iCalcreator v2.12
iCalcreator v2.12
copyright (c) 2007-2012 Kjell-Inge Gustafsson, kigkonsult
kigkonsult.se iCalcreator
kigkonsult.se contact
iCalcreator is a PHP class package managing iCal files, supporting (non-)calendar systems and applications to process and communicate calendar information like events, agendas, tasks, reports, totos and journaling information.
iCalcreator features create, parse, edit and select calendar and calendar components.
The iCalcreator package, built of a calendar class with support of a function class and helper functions, are calendar component property oriented. Development environment is PHP version 5.x but coding is done to meet 4.x backward compatibility and may work. Some functions requires PHP >= 5.2.0.
The iCalcreator main class, utility class and helper functions are included in the "iCalcreator.class.php" file.
More iCalcreator supplementary and "howto" information will be found at kigkonsult.se iCalcreator implement examples and test pages. A strong recommendation is to have this document open in parallell when exploiting the link.
. ..allows for the capture and exchange of information
normally stored within a calendaring and scheduling application.
. ..is an exchange format between applications or systems.
rfc5545 and rfc5546 obsoletes, respectively, rfc2445 and rfc2446.
A short iCal description is found at Wikipedia. If You are not familiar with iCal, read this first! Knowledge of calendar protocol rfc5545/rfc5546 is to recommend.
Any references to rfc2445, below, corresponds to rfc5545.
iCalcreator also supports xCal (iCal xml) rfc6321, "xCal: The XML Format for iCalendar", to be downloaded from
A short xCal description is found at Wikipedia.
This style is used for text.
This style is used for formats.
This style is used for PHP coding examples. // this style is used for coding comments.
This style is used for content details.
This style is used for RFC2445 quotes.
The release numbering convention used is major.minor(.micro / suffix).
The main support channel is using iCalcreator Sourceforge forum.
Use the contact page for queries, improvement/development issues or professional support and development. Please note that paid support or consulting service has the highest priority.
kigkonsult offer services for software support, design and development of customizations and adaptations of PHP/MySQL solutions with a special focus on software long term utility and reliability, supported through our agile acquire/design/transition process model.
You can show your appreciation for our free software, and can support future development by making a donation to the kigkonsult project iCalcreator.
Make a donation of any size by clicking here. Thanks in advance!
Unpack to any folder
- add this folder to your include-path
- or unpack to your application-(include)-folder
Add
require_once "[folder/]iCalcreator.class.php";
to your PHP-script.
If using PHP version 5.1 or higher, the default timezone need to be set/altered, now "Europe/Stockholm", line 50 in the iCalcreator.class.php file.
When creating a new calendar/component instance, review config settings.
To really boost performance, kigkonsult can now offer PHP (4 and 5) packages (iCalcreator etc) in byte coded files, using ionCube encoder.
Encoded files use a platform independent file format, and can be run on any platform for which ionCube supply a (free) Loader. Currently supported platforms are Windows (e.g. NT, XP, W2K), Intel Linux, FreeBSD, NetBSD, OpenBSD, OS X, and Sparc Solaris.
Visit kigkonsult.se contact page for information and purchase.
Use basic install (above), install ionCube Loader (requires an update of "php.ini" or additional file in "/etc/php.d" folder AND the execute rights to use the PHP "dl" function) and simply replace the PHP class files with the encoded files.
The following properties (as described in wikipedia:iCal) may be required when importing iCal files into some calendaring software (MS etc.):
Example
Recommendation is also to set unique_id when creating a new vcalendar/component instance, to ensure accurate setting of all components UID property, even before parse.
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); $vcalendar->setProperty( "method", "PUBLISH" ) $vcalendar->setProperty( "x-wr-calname", "Calendar Sample" ); $vcalendar->setProperty( "X-WR-CALDESC", "Calendar Description" ); $uuid = "3E26604A-50F4-4449-8B3E-E4F4932D05B5"; $vcalendar->setProperty( "X-WR-RELCALID", $uuid ); $vcalendar->setProperty( "X-WR-TIMEZONE", "Europe/Stockholm" ); .. .
Download iCalcreator coding samples.
If you are downloading the iCalcreatorusing sub-package, there are free iCal/xCal icons in the images directory, to use as buttons on a web page.
The PHP coding in this document or "coding samples" (above) are only for display of usage, recommendation is to use a coding standard, the following, incomplete, list is a good start;
Quote from RFC2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar)! (Described in iCal output format, content corresponds to xCal format.)
icalobject = 1*("BEGIN" ":" "VCALENDAR" CRLF
icalbody
"END" ":" "VCALENDAR" CRLF)
icalbody = calprops component
calprops = 2*(
"prodid" and "version" are both REQUIRED, but MUST NOT occur more than once
prodid / version /
"calscale"and "method"are optional, but MUST NOT occur more than once
)
component = 1*(eventc / todoc / journalc / freebusyc / timezonec / iana-comp* / x-comp*)
iana-comp = "BEGIN" ":" iana-token CRLF
1*contentline
"END" ":" iana-token CRLF
x-comp = "BEGIN" ":" x-name CRLF
1*contentline
"END" ":" x-name CRLF
*) not supported by iCalcreator
[index] [top] [up]"BEGIN" ":" "VEVENT" CRLF
eventprop *alarmc
"END" ":" "VEVENT" CRLF
eventprop = *(
the following are optional,but MUST NOT occur more than once
class / created / description / dtstart /
geo / last-mod / location / organizer / priority /
dtstamp / seq / status / summary /
transp / uid / url / recurid /
either "dtend" or "duration" may appear in a "eventprop",
but "dtend" and "duration" MUST NOT occur in the same "eventprop"
the following are optional, and MAY occur more than once
attach / attendee / categories / comment /
contact / exdate / exrule / rstatus /
related / resources / rdate / rrule / x-prop
)
[index] [top] [up]"BEGIN" ":" "VTODO" CRLF
todoprop *alarmc
"END" ":" "VTODO" CRLF
todoprop = *(
the following are optional, but MUST NOT occur more than once
class / completed / created / description / dtstamp / dtstart /
geo / last-mod / location / organizer / percent / priority /
recurid / seq / status / summary /uid / url /
either "due" or "duration" may appear in a "todoprop",
but "due" and "duration" MUST NOT occur in the same "todoprop"
the following are optional,and MAY occur more than once
attach / attendee / categories / comment /
contact / exdate / exrule / rstatus /
related / resources / rdate / rrule / x-prop
)
[index] [top] [up]journalc = "BEGIN" ":" "VJOURNAL" CRLF
jourprop
"END" ":" "VJOURNAL" CRLF
jourprop = *(
the following are optional, but MUST NOT occur more than once
class / created / description / dtstart /
dtstamp / last-mod / organizer / recurid /
seq / status / summary /uid / url /
the following are optional,and MAY occur more than once
attach / attendee / categories / comment /
contact / exdate / exrule / related /
rdate / rrule / rstatus / x-prop
)
[index] [top] [up]"BEGIN" ":" "VFREEBUSY" CRLF
fbprop
"END" ":" "VFREEBUSY" CRLF
fbprop = *(
the following are optional, but MUST NOT occur more than once
contact / dtstart / dtend / duration /
dtstamp / organizer / uid / url /
the following are optional,and MAY occur more than once
attendee / comment / freebusy / rstatus / x-prop
)
[index] [top] [up]"BEGIN" ":" "VALARM" CRLF
(audioprop / dispprop / emailprop / procprop)
"END" ":" "VALARM" CRLF
audioprop = 2*(
"action" and "trigger" are both REQUIRED, but MUST NOT occur more than once
"duration" and "repeat" are both optional,and MUST NOT occur more than once each,
but if one occurs, so MUST the other
the following is optional, but MUST NOT occur more than once
attach /
the following is optional, and MAY occur more than once
)
dispprop = 3*(
the following are all REQUIRED, but MUST NOT occur more than once
action / description / trigger /
"duration" and "repeat" are both optional,and MUST NOT occur more than once each,
but if one occurs, so MUST the other
the following is optional, and MAY occur more than once
)
emailprop = 5*(
the following are all REQUIRED, but MUST NOT occur more than once
action / description / trigger / summary
the following is REQUIRED, and MAY occur more than once
attendee /
"duration" and "repeat" are both optional, and MUST NOT occur more than once each,
but if one occurs, so MUST the other
the following are optional, and MAY occur more than once
)
procprop = 3*(
the following are all REQUIRED, but MUST NOT occur more than once
"duration" and "repeat" are both optional, and MUST NOT occur more than once each,
but if one occurs, so MUST the other
"description" is optional, and MUST NOT occur more than once
the following is optional, and MAY occur more than once
)
[index] [top] [up]"BEGIN" ":" "VTIMEZONE" CRLF
2*(
"tzid" is required, but MUST NOT occur more than once
tzid /
"last-mod" and "tzurl" are optional, but MUST NOT occur more than once
one of "standardc" or "daylightc" MUST occur and each MAY occur more than once.
standardc / daylightc /
the following is optional, and MAY occur more than once
)
"END" ":" "VTIMEZONE" CRLF
standardc = "BEGIN" ":" "STANDARD" CRLF
tzprop
"END" ":" "STANDARD" CRLF
daylightc = "BEGIN" ":" "DAYLIGHT" CRLF
tzprop
"END" ":" "DAYLIGHT" CRLF
tzprop = 3*(
the following are each REQUIRED, but MUST NOT occur more than once
dtstart / tzoffsetto / tzoffsetfrom /
the following are optional, and MAY occur more than once
comment /rdate / rrule / tzname / x-prop
)
[index] [top] [up]A comprehensive table showing relation between calendar components and properties. vtimezone properties are not included.
| 0-1 | OPTIONAL property, MUST NOT occur more than once. | |||||||
| 0-m | OPTIONAL property, MAY occur more than once. | |||||||
| 0 / 1=1 | A pair of OPTIONAL properties, MUST NOT occur more than once each. If one occurs, so MUST the other |
|||||||
| 0*1 | A pair of OPTIONAL properties, MUST NOT occur more than once each. If one occurs, so MUST NOT the other |
|||||||
| 1-m | REQUIRED property, MAY occur more than once. | |||||||
| 1 | REQUIRED property, MUST NOT occur more than once. | |||||||
| v e v e n t |
v t o d o |
v j o u r n a l |
v f r e e b u s y |
v a l a r m | ||||
a u d i o |
d i s p l a y |
e m a i l |
p r o c e d u r e |
|||||
| action | 1 | 1 | 1 | 1 | ||||
| attach | 0-m | 0-m | 0-m | 0-1 | 0-m | 1 | ||
| attendee | 0-m | 0-m | 0-m | 0-m | 1-m | |||
| categories | 0-m | 0-m | 0-m | |||||
| class | 0-1 | 0-1 | 0-1 | |||||
| comment | 0-m | 0-m | 0-m | 0-m | ||||
| completed | 0-1 | |||||||
| contact | 0-m | 0-m | 0-m | 0-1 | ||||
| created | 0-1 | 0-1 | 0-1 | |||||
| description | 0-1 | 0-1 | 0-m | 1 | 1 | 0-1 | ||
| dtend | 0*1 | 0-1 | ||||||
| dtstamp | 0-1 | 0-1 | 0-1 | 0-1 | ||||
| dtstart | 0-1 | 0-1 | 0-1 | 0-1 | ||||
| due | 0*1 | |||||||
| duration | 0*1 | 0*1 | 0-1 | 0 / 1=1 | 0 / 1=1 | 0 / 1=1 | 0 / 1=1 | |
| exdate | 0-m | 0-m | 0-m | |||||
| exrule | 0-m | 0-m | 0-m | |||||
| freebusy | 0-m | |||||||
| geo | 0-1 | 0-1 | ||||||
| last-mod | 0-1 | 0-1 | 0-1 | |||||
| location | 0-1 | 0-1 | ||||||
| organizer | 0-1 | 0-1 | 0-1 | 0-1 | ||||
| percent | 0-1 | |||||||
| priority | 0-1 | 0-1 | ||||||
| rdate | 0-m | 0-m | 0-m | |||||
| recurid | 0-1 | 0-1 | 0-1 | |||||
| related | 0-m | 0-m | 0-m | |||||
| repeat | 0 / 1=1 | 0 / 1=1 | 0 / 1=1 | 0 / 1=1 | ||||
| resources | 0-m | 0-m | ||||||
| rrule | 0-m | 0-m | 0-m | |||||
| rstatus | 0-m | 0-m | 0-m | 0-m | ||||
| sequence | 0-1 | 0-1 | 0-1 | |||||
| status | 0-1 | 0-1 | 0-1 | |||||
| summary | 0-1 | 0-1 | 0-1 | 1 | ||||
| transp | 0-1 | |||||||
| trigger | 1 | 1 | 1 | 1 | ||||
| uid | 0-1 | 0-1 | 0-1 | 0-1 | ||||
| url | 0-1 | 0-1 | 0-1 | 0-1 | ||||
| x-prop | 0-m | 0-m | 0-m | 0-m | 0-m | 0-m | 0-m | 0-m |
If not set, the DTSTAMP and UID properties
are automatically created by iCalcreator
for vevent,vtodo, vjournal and vfreebusy components
when using calendar functions saveCalendar or returnCalendar
or when fetching DTSTAMP/UID property value with the component function getProperty.
Create a new VCALENDAR object.
Format
vcalendar()
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ...
Format 1
Create a new VEVENT object using a calendar factory-method, returning a reference to the new component.
newComponent( "vevent" )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vevent = & $vcalendar->newComponent( "vevent" ); $vevent->setProperty(... ...
Format 2
Create a new VEVENT object.
vevent()
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vevent = new vevent(); $vevent->setProperty(... ... $vcalendar->setComponent( $vevent ); ...
Format 1
Create a new VTODO object using a calendar factory-method, returning a reference to the new component.
newComponent( "vtodo" )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vtodo = & $vcalendar->newComponent( "vtodo" ); $vtodo->setProperty(... ...
Format 2
Create a new VTODO object.
vtodo()
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vtodo = new vtodo(); $vtodo->setProperty(... ... $vcalendar->setComponent( $vtodo ); ...
Format 1
Create a new VJOURNAL object using a calendar factory-method, returning a reference to the new component.
newComponent( "vjournal" )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vjournal = & $vcalendar->newComponent( "vjournal" ); $vjournal->setProperty(... ...
Format 2
Create a new VJOURNAL object.
vjournal()
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vjournal = new vjournal(); $vjournal->setProperty(... ... $vcalendar->setComponent( $vjournal ); ...
Format 1
Create a new VFREEBUSY object using a calendar factory-method, returning a reference to the new component.
newComponent( "vfreebusy" )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vfreebusy = & $vcalendar->newComponent( "vfreebusy" ); $vfreebusy->setProperty(... ...
Format 2
Create a new VFREEBUSY object.
vfreebusy()
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vfreebusy = new vfreebusy(); $vfreebusy->setProperty(... ... $vcalendar->setComponent( $vfreebusy ); ...
Format 1
Create a new VALARM object using a component factory-method, returning a reference to the new (sub-)component.
newComponent( "valarm" )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vevent = & $vcalendar->newComponent( "vevent" ); $vevent->setProperty(... ... $valarm = & $vevent->newComponent( "valarm" ); $valarm->setProperty(... ...
Format 2
Create a new VALARM object.
valarm()
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vevent = new vevent(); $vevent->setProperty(... ... $valarm = new valarm(); $valarm->setProperty(... ... $vevent->setComponent( $valarm ); ... $vcalendar->setComponent( $vevent ); ...
The vtimezone component describe, at a minimum, the base offset from UTC for the time zone. For dates with UTC DATE-TIME, read this!
Format 1
Create a new VTIMEZONE object using a calendar factory-method, returning a reference to the new component.
newComponent( "vtimezone" )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vtimezone = & $vcalendar->newComponent( "vtimezone" ); $vtimezone->setProperty(... ...
Format 2
Create a new VTIMEZONE object.
vtimezone()
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vtimezone = new vtimezone(); $vtimezone->setProperty(... ... $vcalendar->setComponent( $vtimezone ); ...
It is possible to create timezone components, using a function in iCalUtilityFunctions class, createTimezone and utilizing The PHP DateTimeZone class (PHP 5 >= 5.2.0).
Format 1
Create a new VTIMEZONE standard object using a component factory-method, returning a reference to the new (sub-)component.
newComponent( "standard" )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vtimezone = & $vcalendar->newComponent( "vtimezone" ); $vtimezone->setProperty(... ... $standard = & $vtimezone->newComponent( "standard" ); $standard->setProperty(... ... $daylight = & $vtimezone->newComponent( "daylight" ); $daylight->setProperty(... ...
Format 2
Create a new VTIMEZONE STANDARD object.
vtimezone( "standard" )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vtimezone = new vtimezone(); $vtimezone->setProperty(... ... $standard = new vtimezone( "standard" ); $standard->setProperty(... ... $vtimezone->setComponent( $standard ); ... $daylight = new vtimezone( "daylight" ); $daylight->setProperty(... ... $vtimezone->setComponent( $daylight ); ... $vcalendar->setComponent( $vtimezone ); ...
Format 1
Create a new VTIMEZONE daylight object using a component factory-method, returning a reference to the new (sub-)component.
newComponent( "standard" )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vtimezone = & $vcalendar->newComponent( "vtimezone" ); ... $standard = & $vtimezone->newComponent( "standard" ); ... $daylight = & $vtimezone->newComponent( "daylight" ); ...
Format 2
Create a new VTIMEZONE DAYLIGHT object.
vtimezone( "daylight" )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vtimezone = new vtimezone(); ... $standard = new vtimezone( "standard" ); ... $vtimezone->setComponent( $standard ); $daylight = new vtimezone( "daylight" ); ... $vtimezone->setComponent( $daylight ); $vcalendar->setComponent( $vtimezone ); ...
Generic calendar deleteProperty function, simplifying removal of calendar properties.
FALSE is returned if no property exists or when end-of-properties at consecutive function calls.
Format
deleteProperty( [ PropName [, order=1 ] )
propName = (string) case independent, rfc2445 component property names, unknown/missing propName will be regarded as X-property. order = (int) if missing 1st/next occurrence, used with multiple (property) occurrences
Example
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); if( !$vcalendar->deleteProperty( "method" )) echo "METHOD property not found"; .. .
Format 1
Generic calendar getProperty function, simplifying fetch of calendar properties.
FALSE is returned if no property exists or when end-of-properties at consecutive function calls.
getProperty( [ PropName [, order=1 [, complete=FALSE ]]] )
propName = (string) case independent, rfc2445 component property names, unknown/missing propName will be regarded as X-property. order = (int) if missing 1st/next occurrence, used with multiply (property) occurrences complete = (bool) FALSE (default) : output only property value TRUE : output = array( "value"=> <value> ,"params" => <parameter array>)
Example 1
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $calscale = $vcalendar->getProperty( "calscale" ); .. .
Example 2
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); while( $xprop = $vcalendar->getProperty( )) { // get x-properties .. .
Format 2
Ability to fetch specific property (unique) values and number of occurrences. Supported properties are ATTENDEE, CATEGORIES, DTSTART, LOCATION, ORGANIZER, PRIORITY, RESOURCES, STATUS, SUMMARY, UID or "RECURRENCE-ID-UID" (alt. "R-UID" ). The search includes in ALL components within calendar.
Outputs an array( *[ (string) unique-property-value => (int) number_of_occurrence ] )
or an empty array if no hits.
The array is sorted by (asc.) key.
If a property contains multiple values (ex. "CATAGORIES:course1,courseB" or "RESOURCES:pc,developer"), they are split into unique values.
To select components based on property values, see selectComponents (Format 2).
getProperty( PropName )
propName = (string) case independent, property name Using DTSTART as argument returns dates in format "YYYYMMDD" (please note, except the origin start date (DTSTART), dates within a RDATE/RRULE recurrence set are NOT included). Using "RECURRENCE-ID-UID"returns UID values for component(-s) where RECURRENCE-ID is set. The ATTENDEE and ORGANIZER values are prefixed by "protocol" like "MAILTO:chair@kigkonsult.se".
Example 1
Fetch all attendees in calendar.
.. . $attendees = $vcalendar->getProperty( "ATTENDEE" ); foreach( $attendees as $attendee => $occurrCount ) { .. .
Example 2
Fetch all DTSTARTs in calendar.
.. . $startDates = $vcalendar->getProperty( "DTSTART" ); foreach( $startDates as $startDate => $occurrCount ) { .. .
Generic calendar setProperty function,simplifying insert of calendar properties.
A successful update returns TRUE.
Format
setProperty( PropName, Proparg_1 *[, Proparg_n] )
propName = (string) case independent, strict rfc2445 calendar property names, unknown propName will be regarded as X-property. Proparg = (mixed) property argument
Example
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); // initiate new CALENDAR $vcalendar->setProperty( "calscale", "GREGORIAN" );
This property defines the calendar scale used for the calendar information specified in the iCalendar object.
The default value is "GREGORIAN", implied when missing.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createCalscale()
Example
$vcalendar->createCalscale();
Remove CALSCALE from calendar.
Format
deleteProperty( "calscale" )
Example
$vcalendar->deleteProperty( "CALSCALE" );
If set, returns property value, otherwise FALSE.
Format
getProperty( "calscale" )
Example
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $calscale = $vcalendar->getProperty( "calscale" ); .. .
Insert property value.
Format
setProperty( "calscale", value )
value = (string) calscale value
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); // initiate new CALENDAR $vcalendar->setProperty( "calscale", "GREGORIAN" ); .. .
This property defines the iCalendar object method associated with the calendar object.
METHOD property (value PUBLISH etc.) may be required when importing iCal files into some calendaring software (MS etc.), as well as x-properties "X-WR-CALNAME", "X-WR-CALDESC" and "X-WR-TIMEZONE" and the (automatically created) DTSTAMP and UID properties.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createMethod()
Example
$vcalendar->createMethod();
Remove METHOD from calendar.
Format
deleteProperty( "METHOD" )
Example
$vcalendar->deleteProperty( "METHOD" );
If set, returns property value, otherwise FALSE.
Format
getProperty( "method" );
Example
$config = array( "unique_id" => "kigkonsult.se"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $method = $vcalendar->getProperty( "method" ) .. .
Insert property value.
Format
setProperty( "method", value )
value = (string) method value
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); // initiate new CALENDAR $vcalendar->setProperty( "method", "PUBLISH" )
This property specifies the identifier corresponding to the version number of the iCalendar specification. This property is always placed first in the calendar file.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createVersion()
Example
$vcalendar->createVersion();
Fetch property value.
Format
getProperty( "version" )
Example
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $version = $vcalendar->getProperty( "version" ) .. .
Insert property value. Only version 2.0 valid, version is AUTO generated at calendar creation.
Format
setProperty( "version", version )
version = (string) iCal version
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); // initiate new CALENDAR $vcalendar->setProperty( "version", "2.0" )
A calendar, non-standard property with a TEXT value and a name with an "X-" prefix. In a calendar, an x-property, with an unique name, can occur only once but the number of x-properties are unlimited.
X-properties "X-WR-CALNAME", "X-WR-CALDESC" and "X-WR-TIMEZONE" may be required when importing iCal files into some calendaring software (MS etc.), as well as METHOD property (value PUBLISH etc.) and the (automatically created) DTSTAMP and UID properties.
The value type is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createXprop()
Example
$vcalendar->createXprop();
Remove X-PROPERTY from calendar.
Format
deleteProperty( "<X-PROPERTY>" )
Example 1
Delete the x-property named "X-PROPERTY".
$vcalendar->deleteProperty( "X-PROPERTY" );
Example 2
Delete all x-properties.
while( $vcalendar->deleteProperty()) continue;
If set, returns property (name and) value, otherwise FALSE.
Format
getProperty()
getProperty( "<X-PROPERTY>" )
output = array( propertyName1, propertyData2 )
getProperty( FALSE, propOrderNo/FALSE, TRUE )
propOrderNo = (int) specific property value
output = array( propertyName1 , array( "value" => propertyData2 ) , "params" => params 3))
Example 1
Read all x-prop values in a loop.
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); while( $xprop = $vcalendar->getProperty( )) { .. .
$xprop = array( propertyName1, propertyData2 )
Example 2
If exists, read X-WR-TIMEZONE x-prop
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); if( $xprop = $vcalendar->getProperty( "X-WR-TIMEZONE" )) { .. .
$xprop = array( "X-WR-TIMEZONE", propertyData2 )
Example 3
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); while( $xprop = $vcalendar->getProperty( FALSE, FALSE, TRUE )) { .. .
$xprop = array( propertyName1 , array( "value " => propertyData2 ) , "params "=> params 3 )
Format
setProperty( propertyName, propertyData [, params ] )
propertyName1 = (string) Any property name with a "X-" prefix propertyData2 = (string) Value type TEXT params3 = (array) ( ["LANGUAGE" => (string) "<lang>"] [, xparams] ) xparams = *[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); // initiate new CALENDAR // set some X-properties.. . $vcalendar->setProperty( "x-wr-calname", "Calendar Sample" ) $vcalendar->setProperty( "X-WR-CALDESC", "Calendar Description" ); $vcalendar->setProperty( "X-WR-TIMEZONE", "Europe/Stockholm" );
Remove component from calendar.
FALSE is returned if no property exists or when end-of-properties at consecutive function calls.
format 1
Remove component with order number (1st=1, 2nd=2.. .).deleteComponent( orderNumber )
orderNumber = (int) order number
format 2
Remove component with component type (e.g. "vevent") and order 1 alt. suborder number.
deleteComponent( componentType [, componentSuborderNumber])
componentType = (string) component type componentSuborderNumber = (int) order number
format 3
Remove component with UID. N.B UID is NOT set for ALARM / TIMEZONE components.
deleteComponent( UID )
Example 1
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcal = new vcalendar( $config ); $vcal->parse(); $vcal->deleteComponent( 1 ); $vcal->deleteComponent( "vtodo", 2 ); $vcal->deleteComponent( "20070803T194810CEST-0123U3PXiX@kigkonsult.se"); .. .
Example 2
Deleting all components, using format 2 without order number.
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcal = new vcalendar( $config ); $vcal->parse(); .. . while( $vcal->deleteComponent( "vevent")) continue; .. . $vtodo = $vcal->getComponent( "vtodo" ); while( $vtodo->deleteComponent( "valarm")) continue; .. .
Get component from calendar.
FALSE is returned if no property exists or when end-of-properties at consecutive function calls.
format 1
Get next component, until end-of-components.
getComponent()
format 2
Get specific component with order number (1st=1, 2nd=2.. .).
getComponent( orderNumber )
orderNumber = (int) order number
format 3
Get (first/next) component with component type (until end-of-components) alt. get specific component with component type and suborder number (1st=1, 2nd=2.. .).
getComponent( componentType [, componentSuborderNumber])
componentType = (string) component type componentSuborderNumber = (int) order number
format 4
Get (first/next) component with UID as key. (UID is NOT set for ALARM / TIMEZONE components.)
getComponent( UID )
format 5
Get (first/next) component based on specific property contents; DTSTART, DTEND, DUE, CREATED, COMPLETED, DTSTAMP, LAST-MODIFIED, RECURRENCE-ID, ATTENDEE, CATEGORIES, LOCATION, ORGANIZER, PRIORITY, RESOURCES, STATUS, SUMMARY, UID. For the property "SUMMARY" ,if a search value (any case) exists within property value, a hit exists. For the other, non-date, properties an exact (strict case) match is required.
Note, ATTENDEE and ORGANIZER values must be prefixed by protocol ex."MAILTO:chair@ical.net".
getComponent( search )
search = (array) ( *[ propertyName => uniqueValue] ) propertyName = (string) property name, above propertyData = (string) unique property value (strict case), date format "YYYYMMDD" (if any side is DATE, only dates are used), datetime format "YYYYMMDDTHHMMSS"
Example 1
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); while( $comp = $vcalendar->getComponent()) { .. . } .. .
Example 2
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); if( $comp = $vcalendar->getComponent( 1 )) { .. . } .. .
Example 3
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); if( $comp = $vcalendar->getComponent( "vtodo", 2 ) { .. . } .. .
Example 4
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $uid = "20070803T194810CEST-0123U3PXiX@kigkonsult.se"; if($comp = $vcalendar->getComponent( $uid ){ .. . } .. .
Create component (EVENT / VTODO / VJOURNAL / VFREEBUSY / VTIMEZONE) using a calendar factory-method, returning a reference to the new component.
Format
newComponent( componentType )
componentType = (string) component type
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vevent = & $vcalendar->newComponent( "vevent" ); ...
Format 1
Selects EVENT / VTODO / VJOURNAL / VFREEBUSY components from calendar on based on dates (notice date restriction), based on the initial DTSTART property along with the RRULE, RDATE, EXDATE and EXRULE properties in the component.
Requirement:
Limitations:
FALSE is returned if no selected component exists.
selectComponents([ startYear, startMonth, startDay [, endYear, endMonth, endDay [, cType [, flat [, any [, split]]]]]])
Returns an array with components (events.. .).
For all recurrent instances of a calendar component, an x-property,
"X-CURRENT-DTSTART" and opt. also "X-CURRENT-DTEND" alt. "X-CURRENT-DUE",
has been created with a TEXT content, "Y-m-d [H:i:s][timezone/UTC offset]"
showing the current start and opt. also end alt. due date.
Also a "X-RECURRENCE" x-property is set with order number (valid if selectComponents is called from DTSTART date).
startYear : (int) start year (4*digit), default current year startMonth : (int) start month (1-2*digit), default current month startDay : (int) start day (1-2*digit), default current day endYear : (int) end year (4*digit), default startYear endMonth : (int) end month (1-2*digit), default startMonth endDay : (int) end day (1-2*digit), default startDay cType : (mixed) calendar component type(-s), (string/array) ("vevent", "vtodo", "vjournal", "vfreebusy") (bool) FALSE (default) => all flat : (bool) TRUE => output : array[] (ignores split) component where recurrence pattern exists within period FALSE (default) => output : array[Year][Month][Day][] any : (bool) TRUE (default) => select components with recurrence within period FALSE => only components that starts (DTSTART) within period split : (bool) TRUE (default) => one component copy for every day it occurs within the period FALSE => one occurrence of component in output array, start date/recurrence (start) date valid flat any split combinations (defaults in upper case) 1 FALSE TRUE TRUE 2 FALSE TRUE false 3 FALSE false [false] (split set to false if flat=FALSE and any=false) 4 true TRUE [false] (split set to false if flat=true) 5 true false [false] (split set to false if flat=true)
Example
$config = array( "unique_id" => "kigkonsult.se", "directory" => "import", "filename" => "file.ics" ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $vcalendar->sort(); $events_arr = $vcalendar->selectComponents( 2007,11,1,2007,11,30,"vevent"); // select all events occurring 1-30 nov. 2007 foreach( $events_arr as $year => $year_arr ) { foreach( $year_arr as $month => $month_arr ) { foreach( $month_arr as $day => $day_arr ) { foreach( $day_arr as $event ) { $currddate = $event->getProperty( "x-current-dtstart" ); // if member of a recurrence set, returns // array(" x-current-dtstart", // <(string) date("Y-m-d [H:i:s][timezone/UTC offset]")>) $startDate = $event->getProperty( "dtstart" ); $summary = $event->getProperty( "summary" ); $description = $event->getProperty( "description" ); .. .
format 2
Using this format, the function selects components based on specific property value(-s),
ATTENDEE, CATEGORIES, LOCATION, ORGANIZER, PRIORITY, RESOURCES, STATUS, SUMMARY or UID.
For the property "SUMMARY" ,if a search value (any case) exists within property value, a hit is found.
For the other properties an exact (strict case) match is required.
ATTENDEE and ORGANIZER search values must be prefixed by protocol ex. "MAILTO:chair@ical.net".
Multiple search properties may coexist.
To retrieve property values, see getProperty (Format 2) on calendar level.
selectComponents( searchArray )
Outputs an array of matched (unique) components in UID order.
searchArray : (array) *( propertyName => propertyValue ) propertyName : (string) above (any case) propertyValue : (string) value / (array) ( *[ (string) propertyValue] )
Example
$config = array( "unique_id" => "kigkonsult.se", "directory" => "import", "filename" => "file.ics" ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $vcalendar->sort(); $searchArray = array( "PRIORITY" => array( 1, 2, 3, 4 )); $highPrioArr = $vcalendar->selectComponents( $searchArray ); // select all components with PRIORITY set to high (1-4) if( !empty( $highPrioArr )) { $highPrioCal = new vcalendar( array( "unique_id" => "kigkonsult.se" )); $highPrioCal->setProperty( "X-WR-CALDESC", "High priority events" ); foreach( $highPrioArr as $highPrioComponent ) $highPrioCal->setComponent( $highPrioComponent ); $highPrioCal->returnCalendar(); } .. .
Replace or update component in calendar. Also add calendar component to calendar when calendar component is created with the procedural (non-factory) method, see example VEVENT, format 2.
A successful update returns TRUE.
format 1
Insert last in component chain.
setComponent( component ) addComponent( component ) // alias
component = (object) iCalcreator component instance
addComponent, may be removed i future versions.
format 2
Insert/replace component with order number (1st=1, 2nd=2.. .). If replace and orderNumber is not found, component is inserted last in chain.
setComponent( component, orderNumber )
component = (object) iCalcreator component instance int = (int) order numder
format 3
Replace component with component type and 1st alt. component order number. If orderNumber is not found, component is inserted last in chain.
setComponent( component, componentType [, componentSuborderNo])
component = (object) iCalcreator component instance componentType = (string) component type componentSuborderNo = (int) component Suborder Number
format 4
Replace component with UID. N.B UID is NOT set for ALARM / TIMEZONE components. If UID is not found, component is inserted last in chain.
setComponent( component, UID )
component = (object) iCalcreator component instance
Example
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $vevent = vcalendar->getComponent( 1 ); //fetch first EVENT $vevent->setProperty( "dtstart" //update DTSTART property , 2006, 12, 24, 19, 30, 00 ); .. . $vcalendar->setComponent( $vevent, 1 ); // replace first component .. .
Parse iCal file(-s) or string/array calendar content into a single vcalendar object (components, properties and parameters), including multiple vcalendars (within a single ICS file) parse, e.g. Oracle Calendar exports.
As long as php.ini directive "allow_url_fopen" is enabled, remote files, URLs; protocol "http" ("webcal"), are supported. A remote file, URL, must be prefixed by "http://" ("webcal://") and suffixed by a valid filename.! Recommendation is to download (cache) remote file before parsing, due to execution time and control.
If missing, component property UID is created when parsing. For that reason UNIQUE_ID might need to be set before parsing, Se examples below.
Notice date restriction!
If parse error occurs (like file access error, invalid calendar file or calendar file without components), FALSE is returned.
Format
parse( [ textToParse ] )
textToParse = (string) calendarContent ex. result from - file_get_contents( "filename") (array) calendarContent ex. result from - file( "filename", FILE_IGNORE_NEW_LINES )
parse example 1
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics"); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); .. .
parse example 2
$config = array( "unique_id" => "kigkonsult.se", "url" => "http://www.ical.net/calendars/calendar.ics" ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); .. .
parse example 3
$config = array( "unique_id" => "kigkonsult.se", "url" => "http://www.ical.net/calendars/calendar.ics" ); $vcalendar = new vcalendar( $config ); ... $str = array( "BEGIN:VCALENDAR", "PRODID:-//kigkonsult.se//NONSGML kigkonsult.se iCalcreator 2.12//", "VERSION:2.0", "BEGIN:VEVENT", "DTSTART:20101224T190000Z", "DTEND:20101224T200000Z", "DTSTAMP:20101020T103827Z", "UID:20101020T113827-1234GkdhFR@test.org", "DESCRIPTION:example", "END:VEVENT", "END:VCALENDAR"); $vcalendar->parse( $str ); ...
merge example
$config = array( "unique_id" => "kigkonsult.se", "directory" => "import" ); $vcalendar = new vcalendar( $config ); $vcalendar->setConfig( "filename", "file1.ics" ); $vcalendar->parse(); $vcalendar->setConfig( "filename", "file2.ics" ); $vcalendar->parse(); $vcalendar->sort(); $vcalendar->setConfig( "directory", "export" ); $vcalendar->setConfig( "filename", "icalmerge.ics" ); $vcalendar->saveCalendar(); .. .
Format
createCalendar()
Example
.. . $str = $vcalendar->createCalendar(); echo $str;
Redirect calendar content to user browser. Filename, addressed to browser, is automatically generated if missing or not set;
$filename = date( "YmdHis" ).".ics" .
Format
returnCalendar( [ utf8Encode [, gzip ]] )
utf8Encode = (bool) TRUE: utf8 encoded output, FALSE: (default) no encoding gzip = (bool) TRUE: gzip compressed output Header "Content-Length" only sent when gzip=TRUE FALSE: (default) no compressing
Example 1
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); .. . $vevent = & $vcalendar->newComponent( "vevent" ); $vevent->setProperty( "dtstart", array( "year" => 2007 , "month" => 4 , "day" => 1 , "hour" => 19 )); $vevent->setProperty( "duration", 0, 0, 3 )); $vevent->setProperty( "LOCATION", "Central Plaza" ); $vevent->setProperty( "summary", "PHP summit" ); .. . $vcalendar->returnCalendar();
Example 2
$config = array( "unique_id" => "kigkonsult.se", "directory" => "import", "filename" => "file.ics" ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $utf8Encode = TRUE; $hacPar = "HTTP_ACCEPT_ENCODING"; if( isset( $_SERVER[$hacPar] ) && ( FALSE !== strpos( strtolower( $_SERVER[$hacPar] ), "gzip" ))) $gzip = TRUE; else $gzip = FALSE; $vcalendar->returnCalendar( $utf8Encode, $gzip );
Save ical calendar in a file, uses present directory if directory not set, filename is automatically generated if missing or not set;
$filename = date( "YmdHis" ).".ics" .
Directory/filename must be writeable, delimiter default PHP constant DIRECTORY_SEPARATOR.
If file error occurs, FALSE is returned.
Format
saveCalendar ( [ directory [, filename [, delimiter ]]] )
directory = (string) directory, default FALSE filename = (string file name, default FALSE delimiter = (string) path directory/filename separator, default FALSE
Parameters for directory/filename/delimiter, kept for backward compatibility, may be removed i future versions. Recommendation is to use setConfig, Se example below.Example
.. . $vcalendar->setConfig( array( "directory" => "depot", "filename" => "calendar.ics" )); $result = $vcalendar->saveCalendar(); if( !$result ) echo "error when saving.. ."
Format 1
Sort created/parsed calendar components on the following (prioritized) keys:
1 - X-CURRENT-DTSTART - X-CURRENT-DTEND/X-CURRENT-DUE
(if created in function selectComponents)
1 - DTSTART - DTEND alt. DURATION (VEVENT and VFREEBUSY components)
1 - DTSTART - DUE alt. DURATION (VTODO components)
1 - DTSTART (VJOURNAL components)
2 - CREATED / DTSTAMP
3 - UID
VTIMEZONE component is always placed first in chain, including
STANDARD / DAYLIGHT sub-components are sorted (on asc. key DTSTART) when calling
createCalendar (or returnCalender).
ALARM sub-components, if exists, are not sorted.
sort()
Example
$config = array( "unique_id" => "kigkonsult.se", "directory" => "import", "filename" => "file.ics" ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $vcalendar->sort(); $vcalendar->returnCalendar();
Format 2
Sort created/parsed calendar components on specific property values and ascending order.
sort( sortArgument )
sortArgument: (string) "ATTENDEE" / "CATEGORIES" / "DTSTAMP" / "LOCATION"" / "ORGANIZER" / "RESOURCES" / "PRIORITY" / "STATUS" / "SUMMARY". For a property where multiple occurrence may exist (ATTENDEE, CATEGORIES, RESOURCES) lowest (alphabetic) value is used as sort parameter.
If recent version of local (non-empty and saved) calendar file exists, an HTTP redirect header is sent otherwise FALSE is returned.
Format
useCachedCalendar( [ timeout ] )
useCachedCalendar( [ directory [, filename [, delimiter [, timeout ]]]] )
directory = (string) directory, default FALSE
filename = (string file name, default FALSE
delimiter = (string) path directory/filename separator, default FALSE
timeout = (int) default 3600 sec
Second format with parameters for directory/filename/delimiter,
kept for backward compatibility, may be removed i future
versions. Recommendation is to use setConfig, Se example below.
Example
.. . $vcalendar->setConfig( "directory", "depot" ); $vcalendar->setConfig( "filename", "calendar.ics" ); $vcalendar->useCachedCalendar();
All configuration keys (allowEmpty, compsInfo etc.) case independent.
| key | calendar | component | remark |
| allowEmpty | * | * | |
| Compsinfo | * | * | getConfig only |
| Delimiter | * | ||
| Directory | * | ||
| Filename | * | ||
| Dirfile | * | getConfig only | |
| Filesize | * | getConfig only | |
| Format | * | ||
| Language | * | * | |
| NewlineChar | * | * | |
| TZID | * | * | |
| Unique_id | * | * | |
| URL | * |
getConfig( [ key ] )
key = (string) config key
Example 1
.. . $filename = $vcalendar->getConfig( "filename" ); .. .
In this example, notice FilenameExample 2
.. . $config = $vcalendar->getConfig(); .. .
Output= array( string key => mixed value *[, string key => mixed value] )
Format
When creating a new calendar.
vcalendar( [ config ] )
config = (array) ( key => value *[, key => value] ) key = (string) config key value = (mixed) config value
Example 1
$config = array( "unique_id" => "kigkonsult.se", "directory" => "import", "filename" => "file.ics" ); $vcalendar = new vcalendar( $config ); .. .
When creating a new calendar component.
component( [ config ] )
config = (array) ( key => value *[, key => value] ) key = (string) config key value = (mixed) config value
Example 2
$config = array( "unique_id" => "kigkonsult.se" ); $vevent = new vevent( $config ); .. .
Example 3
. .. $config = $vcalendar->getConfig(); $vevent = new vevent( $config ); .. .
Only component relevant configuration are set. If using the newComponent function, configuration is set automatically.
A successful "setConfig" returns TRUE.
Format 1
setConfig( [ config ] )
config = (array) ( key => value *[, key => value] ) key = (string) config key value = (mixed) config value
Example 1
$config = array( "unique_id" => "kigkonsult.se", "directory" => "import", "filename" => "file.ics" ); $vcalendar = new vcalendar(); $vcalendar->setConfig( $config ); .. .
Example 2
$config = array( "unique_id" => "kigkonsult.se" ); $vevent = new vevent(); $vevent->setConfig( $config ); .. .
Format 2
setConfig( key, value )
key = (string) config key value = (mixed) config value
Example 1
$vcalendar = new vcalendar(); $vcalendar->setConfig( "directory", "depot" ); .. .
Example 2
$vevent = new vevent(); $vevent->setConfig( "unique_id", "kigkonsult.se" ); .. .
Allow or reject empty calendar properties, default allow (TRUE). Used in createCalendar, returnCalender or create<Property> methods, creating rfc2445 formats.
Only to use with function getConfig.
Get information about calendar components. Returns array with basic information about all components (in array format) within calendar.
Output = array ( *compinfo ) compinfo = array ( "ordno" => int ordno, // order number (1st=1, 2nd=2..) , "type" => string type // component type (vevent, vtodo.. . , "uid" => string uid // component UID (not for ALARM / TIMEZONE) , "props" => array( *[ propertyName => Property count ]) // for every set property , "sub" => array( *compinfo )) // if subcomponents exists, an array for each subcomponent
Example
$config = array( "unique_id" => "kigkonsult.se", "directory" => "import", "filename" => "file.ics" ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $compsinfo = $vcalendar->getConfig( "compsinfo" ); foreach( $compsinfo as compinfo) { echo " order number : ".$compinfo["ordno"]."<br />"; echo " type : ".$compinfo["type"]."<br />"; echo " UID : ".$compinfo["uid"]."<br />"; foreach( $compinfo["props"] as $propertyName => $propertyCount ) echo " $propertyName = $propertyCount"; if( is_array( $compinfo["sub"] )) { foreach( $compinfo["sub"] as $subcompinfo ) { echo " order number : ".$subcompinfo["ordno"]."<br />"; /* .. dito if subcomponents exists .. . */ } } }
Directory/filename delimiter.
Default PHP constant DIRECTORY_SEPARATOR. If used, must be set BEFORE filename!
Local directory to store/read iCal files, default ".".
Directory must be set BEFORE filename and must exist and be writeable otherwise FALSE is returned. If set using an config array and together with Filename, Directory are set automatically first. When setting Directory any previously set URL is removed.
Only available in function getConfig, giving information in array format about directory, filename and filesize.
Example
$fileinfo = $vcalendar->getConfig( "fileinfo" );
output = array( <directory>, <filename>, <filesize> )
iCal local file name, default created like (if not set):
$filename = date( "YmdHis" ).".ics";
$filename = date( "YmdHis" ).".xml"; // if format set to "xcal"
If not set, filename is created when requested, ex. in functions saveCalendar or getConfig("filename").
Local filename must be set AFTER setting directory (and opt. delimiter)! Filename (and opt. directory) must be readable/writeable otherwise FALSE is returned.
Only when getting configuration (using function getConfig).
Returns the size of the file in bytes, to be called
- after "saveCalendar()"
or
- after a "setConfig( "directory" / "filename" )" and before/after "parse()".
Getting the filesize for a remote file (URL) will always return zero.
Format for calendar output, "iCal"/"xCal", any case.
"iCal" is default (rfc2445), "xCal" force xml formatted output, according to
"draft-ietf-calsch-many-xcal-01.txt" (now obsolete).
For converting to and from XML, according to rfc6321, "xCal: The XML Format for iCalendar", use functions
- iCal2XML converts an iCalcreator instance to XML
- XML2iCal converts XML (string/file) to an icalcreator instance.
Language for calendar and component TEXT value properties as defined in [RFC 1766].
If NOT set in TEXT property parameters, language from "setConfig( "language", .." at component level will be used, if set, otherwise language from "setConfig( "language", .." at calendar level will be used, if set.
Character(s) used for carriage return + line feed (CR+LF), default "\r\n".
Default (local?) timezone, will be used if no TZID parameter is supplied when setting DTSTART, DTEND, DUE or RECURRENCE-ID (auto completion). Note, some calendar software also require X-WR-TIMEZONE on calendar level and X-LIC-LOCATION in vtimezone component (to be set manually, examine also the createTimezone function).
"Unique_id" is used in property PRODID at calendar level and UID at component level, both created automatically, if not set manually.
PRODID The identifier is RECOMMENDED to be the identical syntax to the [RFC 822] addr-spec. A good method to assure uniqueness is to put the domain name or a domain literal IP address of the host on which.. .
Default AUTOMATICALLY generated by using PHP function gethostbyname( $_SERVER["SERVER_NAME"] ) when running in a web server environment or "localhost" when using command line interface. Used when setting other (domain) name than server name.
The property PRODID (at calendar level) is always recreated when setting unique_id.
If missing, the property UID at component level is created at first use of functions createCalendar, returnCalendar or saveCalendar
A strong recommendation is always to set unique_id when creating a new vcalendar or component object, to ensure accurate creation of all components UID property, also before parse, in case of missing UID.
When reading remote files with URL (using the parse() method), only protocol "http" ("webcal") is supported, i.e. URL must be prefixed by "http://" ("webcal://") and suffixed by a valid filename.
When setting URL, any previously set Directory is removed.
The URL filename part can be retrieved by - getConfig( "filename" ).
When storing a remote iCal file locally, only directory need to be set, filename remains unchanged (i.e. 1. set URL, 2. parse, 3. set directory, 4. saveCalendar).
Example
Parse of rempte file, then local save in "depot" folder, using original filename
$config = array( "unique_id" => "kigkonsult.se", "url", "http://www.iCal.net/depot/calendar.ics" ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $vcalendar->sort(); .. . .. . $vcalendar->setConfig( "directory", "depot" ); $vcalendar->saveCalendar();
All calendar component property functions for get/set data.
For property format in detail, see
RFC2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar).
RFC2445: The date with UTC time, or absolute time, is identified by a LATIN CAPITAL LETTER Z suffix character (US-ASCII decimal 90), the UTC designator, appended to the time value. For example, the following represents January 19, 1998, at 0700 UTC:
DTSTART:19980119T070000Z
The TZID property parameter MUST NOT be applied to DATE-TIME properties whose time values are specified in UTC.
Notice: date limitation.
Due to a limitation in PHP date functions, e.g. mktime,
strtotime, a date (e.g. while setting DTSTART property)
before "January 1 1970 00:00:00 GMT" may force a PHP date function to generate an error or set date to "January 1 1970".
Format
deleteProperty( [ PropName [, order ] )
propName = (string) case independent, rfc2445 component property names, unknown/missing propName will be used as X-property. order = (int) if missing 1st/next occurrence, used with multiply (property) occurrences
Example
Remove all COMMENT properties.
$config = array( "unique_id" => "kigkonsult.se", "directory" => "import", "filename" => "file.ics" ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $e = $vcalendar->getComponent( "vevent" ); while( $e->deleteProperty( "comment" )) continue; .. .
Generic get property function, simplifying fetch of calendar properties.
FALSE is returned if no property exists or when end-of-properties at consecutive function calls.
Format
getProperty( PropName [, order [, complete ]] )
propName = (string) case independent, rfc2445 component property names, unknown/missing propName will be used as X-property. order = (int) if missing/FALSE 1st/next occurrence, otherwise with multiply occurrences (1st=1, 2nd=2.. .) complete - (bool) FALSE (default): output only property value TRUE : output = array("value" => <value> ,"params"=> <parameter array>)
Example
$config = array( "unique_id" => "kigkonsult.se", "directory" => "import", "filename" => "file.ics" ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); while( $vevent = $vcalendar->getComponent( "vevent" )) { $dtstart = $vevent->getProperty( "dtstart" ); // one occurrence $description = $vevent->getProperty( "description" ); // one occurrence while( $comment = $vevent->getProperty( "comment" )) { // MAY occur more than once .. . } .. .
Parse strict rfc2445 component property text and/or ALARMs.
A rfc2445 strict formatted property text, in string or array format and starting with property name.
Complete ALARMs, all properties included, in array format and first array row as "BEGIN:VALARM", last as "END:VALARM" as well as TIMEZONE and standard/daylight subcomponents.
FALSE is returned if (read-file) problems occur.
Format
parse( propertyText )
propertyText = (string) rcf2445 formatted property, (array) rcf2445 formatted properties, property name must start string / rows(-s)
example
.. . $vevent = & $vcalendar->newComponent( "vevent" ); $e->parse( "DTSTAMP:19970324T1200Z" ); $e->parse( "SEQUENCE:0" ); $e->parse( "ORGANIZER:MAILTO:jdoe@host1.com" ); $e->parse( array( "ATTENDEE;RSVP=TRUE:MAILTO:jsmith@host1.com", "ATTENDEE;RSVP=TRUE:MAILTO:jsmith@host2.com", "ATTENDEE;RSVP=TRUE:MAILTO:jsmith@host3.com", "ATTENDEE;RSVP=TRUE:MAILTO:jsmith@host4.com" )); $e->parse( "DTSTART:19970324T123000Z" ); $e->parse( "DTEND:19970324T210000Z" ); $e->parse( "CATEGORIES:MEETING,PROJECT" ); $e->parse( "CLASS:PUBLIC" ); $e->parse( "SUMMARY:Calendaring Interoperability Planning Meeting" ); $e->parse( "STATUS:DRAFT" ); $e->parse( array( "DESCRIPTION:Project xyz Review Meeting Minutes" ,"Agenda" ,"1. Review of project version 1.0 requirements." ,"2. Definition of project processes." ,"3. Review of project schedule." ,"Participants: John Smith, Jane Doe, Jim Dandy" ,"- It was decided that the requirements need to be signed off by ". "product marketing." ,"- Project processes were accepted." ,"- Project schedule needs to account for scheduled holidays and employee". " vacation time. Check with HR for specific dates." ,"- New schedule will be distributed by Friday." ,"- Next weeks meeting is cancelled. No meeting until 3/23." )); $e->parse( "LOCATION:LDB Lobby" ); $e->parse( "ATTACH;FMTTYPE=application/postscript:ftp://xyz.com/pub/conf/bkgrnd.ps" ); $e->parse( array( "BEGIN:VALARM", "ACTION:AUDIO", "TRIGGER;VALUE=DATE-TIME:19970224T070000Z", "ATTACH;FMTTYPE=audio/basic:http://host.com/pub/audio-files/ssbanner.aud", "REPEAT:4", "DURATION:PT1H", "X-alarm:non-standard ALARM property", "END:VALARM" )); $e->parse( "X-xomment:non-standard property will be displayed, comma escaped"); .. .
Generic set property function, simplifying insert of component properties. For properties where multiple occurrences are allowed, last parameter is an index, implementing replaceProperty functionality.
A successful update returns TRUE.
Format
setProperty( PropName, Proparg_1 *[, Proparg_n] )
propName = (string) case independent, rfc2445 component property names, unknown propName will be regarded as X-property. Proparg_n = (mixed) property content
Example
$vevent = & $vcalendar->newComponent( "vevent" ); $vevent->setProperty( "dtstart" , array("year"=>2007,"month"=>4,"day"=>1,"hour"=>19)); $vevent->setProperty( "duration", 0, 0, 3 )); $vevent->setProperty( "LOCATION", "Central Plaza" ); $vevent->setProperty( "summary", "PHP summit" ); .. .
This property defines the action to be invoked when an VALARM is triggered,
"AUDIO" / "DISPLAY" / "EMAIL" / "PROCEDURE". This property is REQUIRED and MUST NOT occur more than once.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createAction()
Example
$component->createAction();
Remove ACTION from component.
Format
deleteProperty( "Action" )
Example
$valarm->deleteProperty( "Action" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "Action" )
output = actionValue 1
Format 2
getProperty( "Action", FALSE , TRUE )
output = array( "value" => actionValue1 , "params" => xparams2 )
Example
$action = $valarm->getProperty( "action" );
Insert property value.
Format
setProperty( "Action", actionValue [, xparams ] )
actionValue1 = (string) one of "AUDIO" / "DISPLAY" / "EMAIL" / "PROCEDURE" xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$valarm->setProperty( "action", "DISPLAY" );
The property provides the capability to associate a document object with a calendar component. The property is is REQUIRED and MUST NOT occur more than once in an "ALARM" ("ACTION" "procedure"), OPTIONAL and MUST NOT occur more than once in an "ALARM" ("ACTION" "audio") and OPTIONAL and MAY occur more than once in VEVENT, VTODO, VJOURNAL and VALARM ("ACTION" "email") components.
The default value type for ATTACH is URI. The value type can also be set to BINARY to indicate inline binary encoded content (params 2).
If using other parameters than the recommended "FMTTYPE" and the mandatory "ENCODING" (="BASE64")and "VALUE" (="BINARY") for an inline binary encoded attachment, please use only characters within the ASCII character set in parameter name and content, to ensure proper line folding when using createCalendar and/or returnCalendar.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createAttach()
Example
$component->createAttach();
Remove ATTACH from component.
Format
deleteProperty( "ATTACH" )
Example 1
$valarm->deleteProperty( "ATTACH" );
Example 2
Delete ATTACH property no 2.$valarm->deleteProperty( "ATTACH", 2 );
Example 3
Deleting all ATTACH properties.while( $valarm->deleteProperty( "ATTACH" )) continue;
If set, returns property value(-s), otherwise FALSE.
Format 1
getProperty( "Attach" )
output = attachValue1
Format 2
getProperty( "ATTACH", propOrderNo/FALSE , TRUE )
propOrderNo = (int) specific property value,
output = array( "value" => attachValue1 , "params" => params2 )
Format 3
getProperty( "Attach", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo ATTACH
Example
$attach = $valarm->getProperty( "attach" );
Insert property value. Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "attach", attachValue1 [, params [, propOrderNo ]] )
attachValue1 = (string) URI / inline binary encoded content params2 = (array ) ( [ "ENCODING" => "BASE64", "VALUE" => "BINARY" ] [, "FMTTYPE" => contentType ] [, xparams ] ) contentType = (string) The parameter value MUST be the TEXT for either an IANA registered content type or a non-standard content type. xparams = (array) (*[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
Example
$vevent->setProperty( "attach" , "ftp://domain.com/pub/docs/agenda.doc" , array( "FMTTYPE" => "application/binary" ));
The property defines an "Attendee" within a calendar component and is OPTIONAL and MUST NOT occur more than once in a VALARM ("ACTION" "email"), OPTIONAL and MAY occur more than once in VEVENT, VTODO, VJOURNAL and VFREEBUSY components.
This value type for ATTENDEE is URI, a calendar user address.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createAttendee()
Example
$component->createAttendee();
Remove ATTENDEE from component.
Format
deleteProperty( "ATTENDEE" )
Example 1
Delete (single/first) ATTENDEE property
$valarm->deleteProperty( "ATTENDEE" );
Example 2
Delete ATTENDEE property no 2.
$valarm->deleteProperty( "ATTENDEE", 2 );
Example 3
Deleting all ATTENDEE properties.while( $valarm->deleteProperty( "ATTENDEE" )) continue;
If set, returns property value(-s), otherwise FALSE.
Format 1
getProperty( "Attendee" )
output = attendeeValue 1
Format 2
getProperty( "ATTENDEE", propOrderNo/FALSE , TRUE )
propOrderNo = (int) specific property value
output = array( "value" => attendeeValue1 , "params" => array( params2 ))
Format 3
getProperty( "ATTENDEE", propOrderNo )
propOrderNo = (int) specific property value
output = attendeeValue1
Example
$attendee = $valarm->getProperty( "attendee" );
Insert property value. If exist, default parameter values are removed after input (params2). Property value must be prefixed by protocol (ftp://, http://,mailto:, file://.. . ref. rfc 1738 ), if missing, "mailto:" is set (ex. indicating an internet mail address). Also MEMBER and DIR parameters must be prefixed by protocol. DELEGATED-TO, DELEGATED-FROM, SENT-BY parameters must use protocol "mailto:", prefixed if missing (ex. indicating an internet mail address).
Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "attendee", attendeeValue [, params [, propOrderNo ]] )
attendeeValue1 = (string) a calendar user address, a URI as defined by [RFC 1738] or any other IANA registered form for a URI. params2 = (array) ( [CUTYPE] [,MEMBER] [,ROLE] [,PARTSTAT] [,RVSP] [,DELEGATED-TO] [,DELEGATED-FROM] [,SENT-BY] [,CN] [,DIR] [,LANGUAGE] [,xparams] ) CUTYPE = "CUTYPE" => "INDIVIDUAL" (An individual, Default) / "GROUP" (A group of individuals) / "RESOURCE" (A physical resource) / "ROOM" (A room resource) / "UNKNOWN" (Otherwise not known) / (string) x-name (Experimental type) / iana-token (string) (Other IANA registered type) MEMBER = "MEMBER" => array( *[ (string) "single member of the group or list membership"]) ROLE = "ROLE" => "CHAIR" (Indicates chair of the calendar entity) / "REQ-PARTICIPANT" (required participation, Default) / "OPT-PARTICIPANT" (optional participation) / "NON-PARTICIPANT" (information purposes only) / (string) x-name (Experimental role) / (string) iana-token (Other IANA role) PARTSTAT = "PARTSTAT" => "NEEDS-ACTION" (Event needs action, Default) / "ACCEPTED" (Event accepted) / "DECLINED" (Event declined) / "TENTATIVE" (Event tentatively accepted) / "DELEGATED" (Event delegated) / "NEEDS-ACTION" (To-do needs action, Default) / "ACCEPTED" (To-do accepted) / "DECLINED" (To-do declined) / "TENTATIVE" (To-do tentatively accepted) / "DELEGATED" (To-do delegated) / "COMPLETED" (To-do completed. COMPLETED property has date/time completed) / "IN-PROCESS" (To-do in process of being completed) / "NEEDS-ACTION" (Journal needs action, Default) / "ACCEPTED" (Journal accepted) / "DECLINED" (Journal declined) / (string) x-name (Experimental status) / (string) iana-token (Other IANA registered status) RSVP = "RSVP" => (string) "TRUE" / "FALSE", Default (reply expectation) DELEGATED-TO = "DELEGATED-TO" => array(*[(string) "single calendar user to specified by the property has delegated participation"]) DELEGATED-FROM = "DELEGATED-FROM" => array( *[ (string) "single calendar user that have delegated their participation to the calendar user specified by the property" ] ) SENT-BY = "SENT-BY" => (string) single calendar user that is acting on behalf of the calendar user specified by the property" LANGUAGE = "LANGUAGE" => (string) "language for text values in CN parameter" CN = "CN" => (string) "common name to be associated with the calendar user specified by the property" DIR = "DIR" => (string) "reference to a directory entry associated with the calendar user specified by the property" xparams = *[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
See rules in detail in RFC2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar).
Example
$vevent->setProperty( "attendee" , "attendee1@ical.net" $vevent->setProperty( "attendee" , "attendee2@ical.net" , array( "cutype" => "INDIVIDUAL" , "member" => array( "member1@ical.net" , "member2@ical.net" , "member3@ical.net" ) , "role" => "CHAIR" , "PARTSTAT" => "ACCEPTED" , "RSVP" => "TRUE" , "DELEgated-to" => array( "part1@ical.net" , "part2@ical.net" , "part3@ical.net" ) , "delegateD-FROM" =>array( "cio@ical.net" , "vice.cio@ical.net") , "SENT-BY" => "secretary@ical.net" , "LANGUAGE" => "us-EN" , "CN" => "John Doe" , "DIR" => "http://www.ical.net/info.doc" , "x-agenda" => "status reports" // xparam , "x-length" => "15 min" )); // xparam
This property defines the categories for a calendar component and is OPTIONAL and MAY occur more than once in VEVENT, VTODO and VJOURNAL components.
The value type for CATEGORIES is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createCategories()
Example
$component->createCategories();
Remove CATEGORIES from component.
Format
deleteProperty( "CATEGORIES" )
Example 1
Delete (single/first) CATEGORIES property
$vevent->deleteProperty( "CATEGORIES" );
Example 2
Delete CATEGORIES property no 2.
$vevent->deleteProperty( "CATEGORIES", 2 );
Example 3
Deleting all CATEGORIES properties.
while( $vevent->deleteProperty( "CATEGORIES" )) continue;
If set, returns property value(-s), otherwise FALSE.
Format 1
getProperty( "CATEGORIES" )
output = categoryValue1
Format 2
getProperty( "CATEGORIES", propOrderNo/FALSE , TRUE )
propOrderNo = (int) specific property value
output = array( "value" => categories1 , "params" => params2 )
Format 3
getProperty( "CATEGORIES", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo CATEGORIES
Example
$categories = $valarm->getProperty( "categories" );
Insert property value. Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "categories", categories [, params [, propOrderNo ]] )
categories1 = (string) categoryValue / (array) ( *categoryValue ) categoryValue = (string) textual categories or subtypes of the calendar component, can be specified as a list of categories separated by the COMMA character params2 = (array) ( ["LANGUAGE" => (string) "<lang>"][, xparams] ) xparams = *[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
Example
$vevent->setProperty( "categories", "project_x" );
This property defines the access classification for a calendar component and is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO and VJOURNAL components.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createClass()
Example
$component->createClass();
Remove CLASS from component.
Format
deleteProperty( "CLASS" )
Example
$vjournal->deleteProperty( "CLASS" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "CLASS" )
output = classValue1
Format 2
getProperty( "CLASS", FALSE , TRUE )
output = array "value" => classValue1 , "params" => xparams2 )
Example
$class = $valarm->getProperty( "class" );
Insert property value.
Format
setProperty( "class", classvalue [, xparams ] )
classvalue1 = "PUBLIC" / "PRIVATE" / "CONFIDENTIAL" / (string) iana-token / (string) x-name xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$vevent->setProperty( "class", "CONFIDENTIAL" );
This property specifies non-processing information intended to provide a comment to the calendar user and is OPTIONAL and MAY occur more than once in VEVENT, VTODO, VJOURNAL, VFREEBUSY, STANDARD and DAYLIGHT components.
The value type for COMMENT is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createComment()
Example
$component->createComment();
Remove COMMENT from component.
Format
deleteProperty( "COMMENT" )
Example 1
Delete (single/first) COMMENT property
$vevent->deleteProperty( "COMMENT" );
Example 2
Delete COMMENT property no 2.
$vevent->deleteProperty( "COMMENT", 2 );
Example 3
Deleting all COMMENT properties.
while( $vevent->deleteProperty( "COMMENT" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "COMMENT" )
output = commentValue1
Format 2
getProperty( "COMMENT", propOrderNo/FALSE , TRUE )
propOrderNo = (int) specific property value
output = array( "value" => commentValue1 , "params" => params2 )
Format 3
getProperty( "COMMENT", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo COMMENT
Example
$comment = $vevent->getProperty( "comment" );
Insert property value. Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "comment", commentValue [, params [, propOrderNo ]] )
commentValue1 = (string) Value type Text params2 = (array) ( [ "ALTREP" => (string) "<an alternate text representation, URI>"] [, "LANGUAGE" => (string) "<lang>"] [, xparams ] ) xparams = *[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
Example
$vevent->setProperty( "comment", "this is a comment" );
This property defines the date and time that a VTODO was actually completed and is OPTIONAL and MUST NOT occur more than once.
The value type for COMPLETED is UTC DATE-TIME.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createCompleted()
Example
$component->createCompleted();
Remove COMPLETED from component.
Format
deleteProperty( "COMPLETED" )
Example
$vtodo->deleteProperty( "COMPLETED" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "COMPLETED" )
output = completedDate1
Format 2
getProperty( "COMPLETED", FALSE , TRUE )
output = array( "value" => completedDate1 , "params" => xparams2 )
Example
$completed = $vtodo->getProperty( "completed" );
Insert property value. Input date is always a UTC DATE-TIME or, if "offset" parameter is used, converted to a UTC DATE-TIME. Notice, use function transformDateTime to change a local datetime to UTC datetime.
Format
setProperty( "completed", completedDate [, xparams ] )
completedDate1 = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
, "tz" => offset ]] )
completedDate = (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec ]
completedDate = (array) ( (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, offset ]] )
completedDate = (array) ( "timestamp" => (int) timestamp [, "tz" => offset])
completedDate = (string) date/datetime string*
offset = (int) (+/-)HHmm[ss], local date + UTC offset => UTC DATE-TIME
xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
trailing characters (digits), if exists, will be interpreted as offset
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example 1
$config = array( "unique_id" => "kigkonsult.se"); $vcalendar = new vcalendar( $config ); $vtodo = & $vcalendar->newComponent( "vtodo" ); .. . $vtodo->setProperty( "completed", 2006, 8, 10, 10, 0, 0 ); // 10 august 2006 10.00 UTC
Example 2
$date = array("year" => 2006, "month" => 10, "day" => 10, "hour" => 10, "min" => 0, "sec" => 0, "tz" => "+0200"); // local date + UTC offset => UTCDATE-TIME $vtodo->setProperty( "completed", $date );
The property is used to represent textual contact information or alternately a reference to textual contact information associated with the calendar component. The property is OPTIONAL and MUST NOT occur more than once in a VFREEBUSY or MAY occur more than once in VEVENT, VTODO and VJOURNAL components.
The value type for CONTACT is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createContact()
Example
$component->createContact();
Remove CONTACT from component.
Format
deleteProperty( "CONTACT" )
Example 1
Delete (single/first) CONTACT property
$vevent->deleteProperty( "CONTACT" );
Example 2
Delete CONTACT property no 2.
$vevent->deleteProperty( "CONTACT", 2 );
Example 3
Deleting all CONTACT properties.
while( $vevent->deleteProperty( "CONTACT" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "CONTACT" )
output = contactValue1
Format 2
getProperty( "CONTACT", propOrderNo/FALSE , TRUE )
propOrderNo = (int) specific property value
output = array( "value" => contactValue1 , "params" => params2 )
Format 3
getProperty( "CONTACT", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo CONTACT
Example
$contact = $vevent->getProperty( "contact" );
Insert property value. Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "contact", contactValue [, params [, propOrderNo ]] )
contactValue1 = (string) Value type TEXT params2 = (array) ( [ "ALTREP" => (string) "<an alternate text representation, URI>"] [, "LANGUAGE" => (string) "<lang>"] [, xparams] ) xparams = *[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
Example
$c->setProperty( "contact", "tel 012-34 56 789" )
This property specifies the date and time that the calendar information was created by the calendar user agent in the calendar store. Note: This is analogous to the creation date and time for a file in the file system. The property is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO and VJOURNAL components.
The value type for CREATED is UTC DATE-TIME.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createCreated()
Example
$component->createCreated();
Remove CREATED from component.
Format
deleteProperty( "CREATED" )
Example
$vevent->deleteProperty( "CREATED" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "CREATED" )
output = createdDate1
Format 2
getProperty( "CREATED", FALSE , TRUE )
output = array( "value" => createdDate1 , "params" => xparams2 )
Example
$created = $vevent->getProperty( "CREATED" );
Insert property value. Input date is always a UTC DATE-TIME or, if "offset" parameter is used, converted to a UTC DATE-TIME. Notice, use function transformDateTime to change a local datetime to UTC datetime.
Format
setProperty( "created", [ createdDate [, xparams ]] )
createdDate1 = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
, "tz" => offset ]] )
createdDate = (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec ]
createdDate = (array) ( (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, offset ]] )
createdDate = (array) ( "timestamp" => (int) timestamp [, "tz" => offset ])
createdDate = (string) date/datetime string*
offset = (int) (+/-)HHmm[ss], local date + UTC offset => UTC DATE-TIME
xparams2 = array( *[ (string) xparamkey => (string) xparamvalue ] )
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
trailing characters (digits), if exists, will be interpreted as offset
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example 1
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); $vtodo = & $vcalendar->newComponent( "vtodo" ); .. . $vtodo->setProperty( "created", 2006, 8, 11, 14, 30, 35 ); // 11 august 2006 14.30.35 UTC
Example 2
$date = array("year" => 2006, "month" => 10, "day" => 10, "hour" => 10, "min" => 0, "sec" => 0, "tz" => "+0200"); // local date + UTC offset => UTC DATE-TIME $vtodo->setProperty( "created", $date ); .. .
Example 3
$vevent->setProperty( "created" ); // current UTC date-time is set if called without parameters
This property provides a more complete textual description of the calendar component, than that provided by the SUMMARY property (, analogous to a mail BODY). The property is OPTIONAL, MUST NOT occur more than once within VEVENT, VTODO or VALARM (PROCEDURE) but can be specified multiple times within a VJOURNAL calendar component. The property is REQUIRED in VALARM (DISPLAY, EMAIL) component.
The value type for DESCRIPTION is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createDescription()
Example
$component->createDescription();
Remove DESCRIPTION from component.
Format
deleteProperty( "DESCRIPTION" )
Example 1
Delete (single/first) DESCRIPTION property.
$vevent->deleteProperty( "DESCRIPTION" );
Example 2
Delete DESCRIPTION property no 2.
$vjournal->deleteProperty( "DESCRIPTION", 2 );
Example 3
Deleting all DESCRIPTION properties.
while( $vjournal->deleteProperty( "DESCRIPTION" )) continue;
If set, returns property value(-s), otherwise FALSE.
Format 1
getProperty( "DESCRIPTION" )
output = descriptionValue1
Format 2
getProperty( "DESCRIPTION", FALSE , TRUE )
output = array( "value" => descriptionValue1 , "params" => params2 )
Example
$description = $vevent->getProperty( "description" );
Insert property value.
Format
setProperty( "description", descriptionValue [, params [, propOrderNo ]] )
descriptionValue1 = (string) Value type TEXT params2 = (array) ( [ "ALTREP" => (string) "<an alternate text representation, URI>"] [, "LANGUAGE" => (string) "<lang>"] [, xparams] ) xparams = *[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
Example
$vevent->setProperty( "description", "This is a description" );
This property specifies the date and time that a calendar component ends. The property is OPTIONAL and MUST NOT occur more than once in VFREEBUSY and VEVENT. In VEVENT, it only occurs if DURATION NOT occurs.
The default value type for DTEND is DATE-TIME, can be set to a DATE value type.
Notice that an end date without a time is in effect midnight of the day before the date,
so for timeless dates, use the date following the event date for it to be correct.
For an "all-day event" and using timeless dates, the DTEND is equal DTSTART plus one day,
example all-day event (2007-12-01)
DTSTART;VALUE=DATE:20071201
DTEND;VALUE=DATE:20071202.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createDtend()
Example
$component->createDtend();
Remove DTEND from component.
Format
deleteProperty( "DTEND" )
Example
$vevent->deleteProperty( "DTEND" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "DTEND" )
output = dtendDate1
Format 2
getProperty( "DTEND", FALSE , TRUE )
output = array( "value" => dtendDate1 , "params" => params2 )
Example
$dtend = $vevent->getProperty( "dtend" );
Insert property value. If DATE value type is expected, "VALUE" = "DATE" must be set (in params2) otherwise DATE-TIME (default) value type is set.
If no timezone parameter (tz or tzidparam below) is set (i.e.local time) and config TZID is set, date-time values will be set WITH timezone from config. Notice, use function transformDateTime to change a datetime from one time zone to another.
Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "dtend", dtendDate [, params2 ] )
dtendDate1 = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
[, "tz" => tz ]] )
dtendDate = (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, tz ]]
dtendDate = array( (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, tz ]] )
dtendDate = (array) ( "timestamp" => (int) timestamp [,"tz" => tz])
dtendDate = (string) date/datetime string*
dtendDate : Within the "VFREEBUSY" calendar component,
the time MUST be specified in the UTC time format.
tz = (string) <timezone identifier> / offset
(timezone will be used as tzidparam (below), if tzidparam not set)
offset = (int) (+/-)HHmm[ss], local date + UTC offset => UTC DATE-TIME
params2 = (array) ([ tzidparam/datetimeparam/dateparam ] *[,xparams])
tzidparam = "TZID" => (string) <timezone identifier>
// output as local date-time with timezone identifier
// if tzidparam="GMT"/"UTC" then
// output date-time are suffixed by 'Z'
datetimeparam = "VALUE" => "DATE-TIME" // default, output as date-time
dateparam = "VALUE" => "DATE" // output as DATE, ex. all-day event
xparams = (string) xparamkey => (string) xparamvalue
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
trailing characters (digits), if exists, will be interpreted as offset/timezone
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example 1
$vevent->setProperty( "dtend" , 2006, 8, 11, 16, 30, 0 ); // 11 august 2006 16.30.00 local date
Example 2
$vfreebusy->setProperty( "dtend" , 2006, 8, 11, 16, 30, 0, "-040000" ); // 11 august 2006 16.30.00 -040000 : local date + UTC offset => UTC DATE-TIME
Example 3
$vevent->setProperty( "dtend" , array( "year" =>, 2006, "month" => 8, "day"=> 11 ) , array( "VALUE" => "DATE" )); // end of one or more all-day events
The property indicates the date/time that the instance of the iCalendar object was created and is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO, VJOURNAL and VFREEBUSY components. However, DTSTAMP is AUTOMATICALLY GENERATED in iCalcreator.
DTSTAMP may be required when importing iCal files into some calendar software
(MS etc.),
as well as (calendar) x-properties "X-WR-CALNAME", "X-WR-CALDESC" and
"X-WR-TIMEZONE",
METHOD property (value PUBLISH etc.) and the (also created) UID property.
The value type for DTSTAMP is UTC DATE-TIME.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createDtstamp()
Example
$component->createDtstamp();
If DTSTAMP if removed from a component, DTSTAMP will automatically be recreated when output functions like createDtstamp (above), createCalendar, returnCalendar or saveCalendar is executed.
Format
deleteProperty( "DTSTAMP" )
Example
$vevent->deleteProperty( "DTSTAMP" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "DTSTAMP" )
output = dtstampDate1
Format 2
getProperty( "DTSTAMP", FALSE , TRUE )
output = array( "value" => dtstampDate1 , "params" => xparams2 )
Example
$dtstamp = $vevent->getProperty( "dtstamp" );
Insert property value. Input date is always a UTC DATE-TIME or, if "offset" parameter is used, converted to a UTC DATE-TIME. Notice, use function transformDateTime to change a (local) datetime to UTC time zone.
Format
setProperty( "dtstamp", dtstampDate [, xparams ] )
dtstampDate1 = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
, "tz" => offset ]] )
dtstampDate = (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec ]
dtstampDate = (array) ( (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, offset ]] )
dtstampDate = (array) ( "timestamp" => (int) timestamp [, "tz" => offset ])
dtstampDate = (string) (string) date/datetime string*
offset = (int) (+/-)HHmm[ss], local date + UTC offset => UTC DATE-TIME
xparams2 = array( *[ (string) xparamkey => (string) xparamvalue ] )
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
trailing characters (digits), if exists, will be interpreted as offset
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example 1
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); $vtodo = & $vcalendar->newComponent( "vtodo" ); .. . $vtodo->setProperty( "dstamp" , 2006, 8, 11, 7, 30, 1 ); // 11 august 2006 07.30.01 UTC
Example 2
$date = array("year" => 2006, "month" => 10, "day" => 10, "hour" => 10, "min" => 0, "sec" => 0, "tz" => "+0200"); // local date + UTC offset => UTC DATE-TIME $vtodo->setProperty( "dtstamp", $date ); .. .
This property specifies when the calendar component begins. The property is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO, VJOURNAL and VFREEBUSY components. The property is REQUIRED, but MUST NOT occur more than once in STANDARD and DAYLIGHT components.
The default value type for DTSTART is DATE-TIME, can be set to a DATE value type.
For an "all-day event" and using timeless dates, example (2007-12-01)
DTSTART;VALUE=DATE:20071201
DTEND;VALUE=DATE:20071202. // opt., in effect midnight of the day before the date!!
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createDtstart()
Example
$component->createDtstart();
Remove DTSTART from component.
Format
deleteProperty( "DTSTART" )
Example
$vevent->deleteProperty( "DTSTART" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "DTSTART" )
output = dtstartDate1
Format 2
getProperty( "DTSTART", FALSE , TRUE )
output = array( "value" => dtstartDate1 , "params" => params2 )
Example
$dtstart = $vevent->getProperty( "dtstart" );
Insert property value. If DATE value type is expected, "VALUE" = "DATE" must be set (in params2) otherwise DATE-TIME (default) value type is set.
If no timezone parameter (tz or tzidparam below) is set (i.e.local time) and config TZID is set, date-time values will be set WITH timezone from config. Notice, use function transformDateTime to change a datetime from one time zone to another.
Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "dtstart", dtstartDate [, params ] )
dtstartDate1 = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
[, "tz" => tz ]] )
dtstartDate = (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, tz ]]
dtstartDate = (array) ( (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, tz ]] )
dtstartDate = (array) ("timestamp" => (int) timestamp [, "tz" => tz])
dtstartDate = (string) date/datetime string*
dtstartDate : Within the "VFREEBUSY" calendar component,
the dtstartDate MUST be specified in the UTC time format.
tz = (string) <timezone identifier> / offset
(timezone will be used as tzidparam (below), if tzidparam not set)
offset = (int) (+/-)HHmm[ss], local date + UTC offset => UTC DATE-TIME
params2 = (array) ([ tzidparam/datetimeparam/dateparam ] *[, xparams])
tzidparam = "TZID" => (string) <timezone identifier>
// output as local date-time with timezone identifier
// if tzidparam="GMT"/"UTC" then
// output date-time are suffixed by 'Z'
datetimeparam = "VALUE" => "DATE-TIME" // default, output as date-time
dateparam = "VALUE" => "DATE" // output as DATE, ex. all-day event
xparams = (string) xparamkey => (string) xparamvalue
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
trailing characters (digits), if exists, will be interpreted as offset/timezone
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example 1
$vevent->setProperty( "dstart" , 2006, 8, 11, 7, 30, 1 ); // 11 august 2006 07.30.01 local date
Example 2
$vevent->setProperty( "dstart" , 2006, 8, 11, 16, 30, 0, "-040000" ); // 11 august 2006 16.30.00 -040000, // local date + UTC offset => UTC DATE-TIME
Example 3
$vevent->setProperty( "dtstart" , array( "year" =>, 2006, "month" => 8, "day"=> 11 ) , array( "VALUE" => "DATE" )); // start of an all-day event, or a period of (entire) days
This property defines the date and time when a VTODO is expected to be completed and is OPTIONAL and MUST NOT occur more than once and only if DURATION NOT occurs.
The default value type for DUE is DATE-TIME, can be set to a DATE value type.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createDue()
Example
$component->createDue();
Remove DUE from component.
Format
deleteProperty( "DUE" )
Example
$vtodo->deleteProperty( "DUE" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "DUE" )
output = dueDate1
Format 2
getProperty( "DUE", FALSE , TRUE )
output = array( "value" => dueDate1 , "params" => params2 )
Example
$due = $vtodo->getProperty( "due" );
Insert property value. If DATE value type is expected, "VALUE" = "DATE" must be set (in params2) otherwise DATE-TIME (default) value type is set.
If no timezone parameter (tz or tzidparam below) is set (i.e.local time) and config TZID is set, date-time values will be set WITH timezone from config. Notice, use function transformDateTime to change a datetime from one time zone to another.
Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "due", dueDate [, params ] )
dueDate1 = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
[, "tz" => tz ]] )
dueDate = (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, tz ]]
dueDate = (array) ( (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, tz ]] )
dueDate = (array) ( "timestamp" => (int) timestamp [, "tz" => tz])
dueDate = (string) date/datetime string*
tz = (string) <timezone identifier> / offset
(timezone will be used as tzidparam (below), if tzidparam not set)
offset = (int) (+/-)HHmm[ss], local date + UTC offset => UTC DATE-TIME
params2 = (array) ([ tzidparam/datetimeparam/dateparam ] *[, xparams])
tzidparam = "TZID" => (string) <timezone identifier>
// output as local date-time with timezone identifier
// if tzidparam="GMT"/"UTC" then
// output date-time are suffixed by 'Z'
datetimeparam = "VALUE" => "DATE-TIME" // default, output as date-time
dateparam = "VALUE" => "DATE" // output as DATE, "during the day"
xparams = (string) xparamkey => (string) xparamvalue
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
trailing characters (digits), if exists, will be interpreted as offset/timezone
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example 1
$vtodo->setProperty( "due" , 2006, 8, 11, 18, 0, 0 ); // 11 august 2005 18.00.00 local date
Example 2
$vtodo->setProperty( "due" , 2006, 8, 11, 16, 30, 0, "-040000" ); // 11 august 2006 16.30.00 -040000 // local date + UTC offset sets UTCDATE-TIME
Example 3
$vtodo->setProperty( "due" , array( "year" =>, 2006, "month" => 8, "day"=> 11 ) , array( "VALUE" => "DATE" )); // due "during the day"
The property specifies a positive duration of time.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createDuration()
Example
$component->createDuration();
Remove DURATION from component.
Format
deleteProperty( "DURATION" )
Example
$valarm->deleteProperty( "DURATION" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "DURATION" )
output = duration1
Format 2
getProperty( "DURATION", FALSE , TRUE )
output = array( "value" => duration1 , "params" => xparams2 )
Example
$duration = $vtodo->getProperty( "duration" );
option
If a 4th argument is used and set to TRUE, returned output is in a DATE-TIME output format (like DTEND / DUE), based on DTSTART value with the added DURATION value.
Insert property value.
Format
setProperty( "duration", duration [, xparams ] )
duration1 = (array) ( "week" => (int) week ) duration1 = array ( "day" => (int) day ) [, "hour" => (int) hour , "min" => (int) min , "sec" => (int) sec ]) duration = (array) ( "sec" => (int) sec ) duration = (array) ( (int) week/false [, (int) day/false [, (int) hour , (int) min , (int) sec ]] ) duration = (int) week/false [, (int) day/false [, (int) hour , (int) min , (int) sec ]] duration = (string) dur-value = ["+"] "P" (dur-date/dur-time/dur-week) dur-date = dur-day [dur-time] dur-time = "T" (dur-hour / dur-minute / dur-second) dur-week = 1*DIGIT "W" dur-hour = 1*DIGIT "H" [dur-minute] dur-minute = 1*DIGIT "M" [dur-second] dur-second = 1*DIGIT "S" dur-day = 1*DIGIT "D" xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
Example 1
One day duration.
$vtodo->setProperty "duration" , array( "day" => 1 ));
Example 2
Four hours duration.
$vtodo->setProperty( "duration" , "PT4H" );
This property defines the list of date/time exceptions for a recurring calendar component and is OPTIONAL and MAY occur more than once in VEVENT, VTODO, VJOURNAL components.
The default value type for EXDATE is DATE-TIME, can be set to a DATE value type.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createExdate()
Example
$component->createExdate();
Remove EXDATE from component.
Format
deleteProperty( "EXDATE" )
Example 1
$vtodo->deleteProperty( "EXDATE" );
Example 2
Delete EXDATE property no 2.
$vjournal->deleteProperty( "EXDATE", 2 );
Example 3
Deleting all EXDATE properties.
while( $vjournal->deleteProperty( "EXDATE" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "EXDATE" )
output = exdates1
Format 2
getProperty( "exdate", propOrderNo/FALSE, TRUE )
propOrderNo = (int) specific property value
output = array( "value" => exdates1 , "params" => xparams2 )
Format 3
getProperty( "EXDATE", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo EXDATE
Example
$exdate = $vtodo->getProperty( "exdate" );
Insert property value.
If "TZID" is set in params, ex. "TZID" = "CET",
all timezone or offset in dates are ignored and DATE-TIME value type is set.
If DATE value type is set in params ("VALUE" = "DATE"), all timezone or offset in dates are ignored.
If no "VALUE" parameter in params, DATE-TIME (default) value type is set.
If empty params and offset in 1st date, all remaining dates are set to UTC.
If no "TZID" is set in params and timezone in 1st date, all remaining dates are within this timezone and param "TZID" is set.
If none of the above rules are applicable, DATE-TIME and local date is set default.
Notice, use function transformDateTime to change a datetime from one time zone to another.
Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "exdate", exdates [, xparams [, propOrderNo ]] )
exdates1 = (array) ( date *[, date ] )
date = array( (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, tz ]] )
date1 = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
[, "tz" => tz ]] )
date = (array) ( "timestamp" => (int) timestamp [, "tz" => tz])
date = (string) date/datetime string*
tz = (string) <timezone identifier> / offset
(timezone will be used as tzidparam (below), if tzidparam not set)
offset = (int) (+/-)HHmm[ss], local date + UTC offset => UTC DATE-TIME
params2 = (array) ([(datetimeparam/dateparam) / tzidparam] [,xparams])
datetimeparam = "VALUE" => "DATE-TIME" // default, output as date-time
dateparam = "VALUE" => "DATE" // output as DATE
tzidparam = "TZID" => (string) <timezone identifier>
xparams = *[ (string) xparamkey => (string) xparamvalue ]
propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
trailing characters (digits), if exists, will be interpreted as offset/timezone
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example 1
$vevent->setProperty( "exdate" , array( array( 2006, 8, 14, 16, 0, 0 )); // >exclude 2006-08-14 16.00.00 (local date) from recurrence pattern
Example 2
$vevent->setProperty( "exdate" , array( array("year" =>,2006,"month" => 8,"day"=> 11)) , array( "VALUE" => "DATE" )); // exclude 2006-08-11 from recurrence pattern;
This property defines a rule or repeating pattern for an exception to a recurrence set and is OPTIONAL and MAY occur more than once in VEVENT, VTODO, VJOURNAL components.
EXRULE is deprecated in rfc5545!
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createExrule()
Example
$component->createExrule();
Remove EXRULE from component.
Format
deleteProperty( "EXRULE" )
Example 1
$vtodo->deleteProperty( "EXRULE" );
Example 2
Delete EXRULE property no 2.
$vjournal->deleteProperty( "EXRULE", 2 );
Example 3
Deleting all EXRULE properties.
while( $vjournal->deleteProperty( "EXRULE" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "EXRULE" )
output = recur1
Format 2
getProperty( "exrule", propOrderNo/FALSE, TRUE )
propOrderNo = (int) specific property value
output = array( "value" => recur1 , "params" => xparams2 )
Format 3
getProperty( "EXRULE", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo EXRULE
Example
$exrule = $vtodo->getProperty( "exrule" );
Insert property value. Notice, use function transformDateTimeto change a local datetime to a UTC datetime.
Parameters, will be ordered as prescribed in rcf2445.
Format
setProperty( "exrule", recur [, xparams [, propOrderNo ]] )
See rules in detail in RFC2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar).recur1 = (array) ( "FREQ" => freq
// either UNTIL or COUNT may appear in a "recur",
but UNTIL and COUNT MUST NOT occur in the same "recur"
[, "UNTIL" "=>" >enddate ]
[, "COUNT" "=>" 1*DIGIT ]
// the rest of these keywords are optional,
but MUST NOT occur more than once
[, "INTERVAL" "=>" 1*DIGIT ]
[, "BYSECOND" "=>" byseclist ]
[, "BYMINUTE" "=>" byminlist ]
[, "BYHOUR" "=>" byhrlist ]
[, "BYDAY" "=>" bywdaylist ]
[, "BYMONTHDAY" "=>" bymodaylist ]
[, "BYYEARDAY" "=>" byyrdaylist ]
[, "BYWEEKNO" "=>" bywknolist ]
[, "BYMONTH" "=>" bymolist ]
[, "BYSETPOS" "=>" bysplist ]
[, "WKST" "=>" weekday ]
[, x-name "=>" (string) text ] )
freq = "SECONDLY" /
"MINUTELY" /
"HOURLY" /
"DAILY" /
"WEEKLY" /
"MONTHLY" /
"YEARLY"
enddate = date (a DATE value or a UTC DATE-TIME value)
date = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec ])
date = (array) ( "timestamp" => (int) timestamp )
date = (string) date/datetime string*
byseclist = seconds
byseclist = (array) (seconds *(, seconds ))
seconds = 1DIGIT / 2DIGIT ;0 to 59
byminlist = minutes
byminlist = (array) ( minutes *(, minutes ))
minutes = 1DIGIT / 2DIGIT ;0 to 59
byhrlist = hour
byhrlist = (array) ( hour *(, hour ))
hour = 1DIGIT / 2DIGIT ;0 to 23
bywdaylist = weekdaynum
bywdaylist = (array) ( weekdaynum *("," weekdaynum ))
weekdaynum = (array) ( [([plus] ordwk / minus ordwk)], "DAY" => weekday )
plus = "+"
minus = "-"
ordwk = 1DIGIT / 2DIGIT ;1 to 53
weekday = "SU" / "MO" / "TU" / "WE" / "TH" / "FR" / "SA"
; Corresponding to
; SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY,
; FRIDAY, SATURDAY and SUNDAY days of the week.
bymodaylist = monthdaynum
bymodaylist = (array) ( monthdaynum *(, monthdaynum ))
monthdaynum = ( [plus] ordmoday ) / ( minus ordmoday )
ordmoday = 1DIGIT / 2DIGIT ;1 to 31
byyrdaylist = yeardaynum
byyrdaylist = (array) ( yeardaynum *(, yeardaynum ))
yeardaynum = ( [plus] ordyrday ) / ( minus ordyrday )
ordyrday = 1DIGIT / 2DIGIT / 3DIGIT ;1 to 366
bywknolist = weeknum
bywknolist = (array) ( weeknum *(, weeknum ))
weeknum = ( [plus] ordwk ) / ( minus ordwk )
bymolist = monthnum
bymolist = (array) ( monthnum *(, monthnum ))
monthnum = 1DIGIT / 2DIGIT ;1 to 12
bysplist = setposday
bysplist = (array) ( setposday *(, setposday ))
setposday = yeardaynum
xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example
$vevent->setProperty( "Exrule" , array( "FREQ" => "MONTHLY" , "UNTIL" => "20060831" // DATE / DATE-TIME in UTC format; string/array, see CREATED format , "INTERVAL" => 2 , "WKST" => "SU" , "BYSECOND" => 2 , "BYMINUTE" => array( 2, -4, 6 ) // (*) , "BYHOUR" => array( 2, 4, -6 ) // (*) , "BYMONTHDAY" => -2 // (*) , "BYYEARDAY" => 2 // (*) , "BYWEEKNO" => array( 2, -4, 6 ) // (*) , "BYMONTH" => 2 // (*) , "BYSETPOS" => array( 2, -4, 6 ) // (*) , "BYday" => array( array(-2, "DAY" => "WE" ) , array( 3, "DAY" => "TH") , array( 5, "DAY" => "FR") , array( "DAY" => "MO")) // (**) , "X-NAME" => "x-value" ) , array( "xparamkey" => "xparamValue" )); $vtodo->setProperty( >"exrule" , array( "FREQ" => "WEEKLY" , "COUNT" => 2 , "INTERVAL" => 2 , "WKST" => "SU" , "BYSECOND" => array( -2, 4, 6 ) // (*) , "BYMINUTE" => -2 // (*) , "BYHOUR" => 2 // (*) , "BYMONTHDAY" => array( 2, -4, 6 ) // (*) , "BYYEARDAY" => array( -2, 4, 6 ) // (*) , "BYWEEKNO" => -2 // (*) , "BYMONTH" => array( 2, 4, -6 ) // (*) , "BYSETPOS" => -2 // (*) , "BYday" => array( 5, "DAY" => "WE" ) // (**) , "X-NAME" => "x-value" ) , array( "xparamkey" => "xparamValue" )); //(*) single value/array of values //(**) single value array /array of arrays
The property defines one or more free or busy time intervals in a VFREEBUSY calendar component.
The value type for FREEBUSY is PERIOD. A PERIOD is a DATE-TIME/DATE-TIME or a DATE-TIME/duration.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createFreebusy()
Example
$component->createfreebusy();
Remove FREEBUSY from component.
Format
deleteProperty( "FREEBUSY" )
Example 1
Delete (single/first) FREEBUSY property
$vfreebusy->deleteProperty( "FREEBUSY" );
Example 2
Delete FREEBUSY property no 2.
$vfreebusy->deleteProperty( "FREEBUSY", 2 );
Example 3
Deleting all FREEBUSY properties.
while( $vfreebusy->deleteProperty( "FREEBUSY" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "FREEBUSY" )
output = array( "fbtyp" => freebusytype1 , periods2 )
Format 3
getProperty( "FREEBUSY", propOrderNo/FALSE , TRUE )
propOrderNo = (int) specific property value
output = array( "value" => array("fbtype" => freebusytype1 ,periods2) , "params" => xparams 3 )
Format 3
getProperty( "FREEBUSY", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo FREEBUSY
Example
$freebusy = $vfreebusy->getProperty( "FREEBUSY" );
Format
setProperty( "freebusy",freebusytype,fbperiods [,xparams [,propOrderNo ]] )
freebusytype1 = one of "FREE"
/ "BUSY" Default
/ "BUSY-UNAVAILABLE"
/ "BUSY-TENTATIVE"
/ x-name
fbperiods = (array) ( periods2 )
periods2 = (array) ( startdate, enddate/duration ) /
(array) ( *[, (array) ( startdate, enddate/duration )] )
startdate/enddate = (array) ( (int) year
, (int) month
, (int) day
, (int) hour
, (int) min
, (int) sec )
startdate/enddate = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec ) // output format
startdate/enddate = (array) ( "timestamp" => (int) timestamp )
startdate/enddate = (string) datetime string*
startdate/enddate : MUST be an UTC DATE-TIME
duration = (array) ( (int) week / FALSE
[, (int) day / FALSE
, (int) hour
, (int) min
, (int) sec] )
duration = (array) ( "week" => (int) week / FALSE
[, "day" => (int) day / FALSE
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec ]] ); // output format
duration = (array) ( "sec" => (int) sec )
duration = (string) dur-value
= (["+"]/"-") "P" (dur-date/dur-time/dur-week)
dur-date = dur-day [dur-time]
dur-time = "T" (dur-hour / dur-minute / dur-second)
dur-week = 1*DIGIT "W"
dur-hour = 1*DIGIT "H" [dur-minute]
dur-minute = 1*DIGIT "M" [dur-second]
dur-second = 1*DIGIT "S"
dur-day = 1*DIGIT "D"
xparams3 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
date/datetime string* recommended formats
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example
See rules in detail in RFC2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar).$fdate1 = array ( 2001, 1, 1, 1, 1, 1 ); alt. $fdate1 = array ( "year" => 2001 , "month" => 1 , "day" => 1 , "hour" => 1 , "min" => 1 , "sec" => 1 ); $fdate2 = array ( 2002, 2, 2, 2, 2, 2 ); $fdate3 = array ( 2003, 3, 3, 3, 3, 3 ); $fdate4 = "4 April 2005 4:4:4"; $fdate7 = array ( "year" => 2007 , "month" => 7 , "day" => 7 ); $fdur6 = array ( "week" => 0 , "day" => 5 , "hour" => 5 , "min" => 5 , "sec" => 5 ); $fdur7 = array ( 0, 0, 6 ); // duration for 6 hours $fdur8 = "P2D"; // duration two days $freebusy->setProperty "freebusy" , "FREE" , array( array( $fdate1, $fdate2 ) , array( $fdate3, $fdur6 ) , array( $fdate4, $fdate5 ))); $freebusy->setProperty("freebusy" , "Busy" , array( array( array( $fdate1, $fdate2 ) , array( $fdate3, $fdur8 ) , array( $fdate4, $fdur7 ) , array( $fdate1, $fdate3 )));
This property specifies information related to the global position for the activity specified by VEVENT and VTODO components and is OPTIONAL and MUST NOT occur more than once.
Value type for latitude and longitude is FLOAT. "Values for latitude and longitude shall be expressed as decimal fractions of degrees. Whole degrees of latitude shall be represented by a two-digit decimal number ranging from 0 through 90. Whole degrees of longitude shall be represented by a decimal number ranging from 0 through 180. When a decimal fraction of a degree is specified, it shall be separated from the whole number of degrees by a decimal point."
The output (float) value is presented with six decimals.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createGeo()
Example
$component->createGeo();
Remove GEO from component.
Format
deleteProperty( "GEO" )
Example
$vevent->deleteProperty( "GEO" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "GEO" )
output = array( "latitude" => <latitude> , "longitude" => <longitude>))
Format 2
getProperty( "GEO", FALSE , TRUE )
output = array( "value" => array ( "latitude" => <latitude> , "longitude" => <longitude>)) , "params" => xparams 1 )
Example
$geo = $vevent->getProperty( "GEO" );
Insert property value.
Format
setProperty( "geo", latitude, longitude [, xparams ] )
latitude = (float) latitude longitude = (float) longitude xparams 1 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$vevent->setProperty( "geo", 11.23456, -23.45678 );
The property specifies the date and time that the information associated with the calendar component was last revised in the calendar store. The property is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO, VJOURNAL and VTIMEZONE components.
The value type for LAST-MODIFIED is UTC DATE-TIME.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createLastModified()
Example
$component->createLastModified();
Remove LAST-MODIFIED from component.
Format
deleteProperty( "LAST-MODIFIED" )
Example
$vevent->deleteProperty( "LAST-MODIFIED" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "LAST-MODIFIED" )
output = moddate1
Format 2
getProperty( "LAST-MODIFIED", FALSE , TRUE )
output = array( "value" => moddate1 , "params" => xparams2 )
Example
$lastMod = $vevent->getProperty( "LAST-MODIFIED" );
Insert property value. Input date is always a UTC DATE-TIME or, if "offset" parameter is used, converted to a UTC DATE-TIME. Notice, use function transformDateTime to change a local datetime to a UTC datetime.
Format
setProperty( "Last-Modified" [, moddate [, xparams ]] )
moddate1 = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
, "tz" => offset ]] )
moddate = (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec ]
moddate = (array) ( (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, offset ]] )
moddate = (array) ( "timestamp" => (int) timestamp [, "tz" => offset])
moddate = (string) date/datetime string*
offset = (int) (+/-)HHmm[ss], local date + UTC offset => UTC DATE-TIME
xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
trailing characters (digits), if exists, will be interpreted as offset/timezone
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example 1
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); $vtodo = & $vcalendar->newComponent( "vtodo" ); .. . $vtodo->setProperty("last-modified" , 2006, 8, 14, 12, 1, 2 ); // 14 august 2006 12.01.02 UTC
Example 2
$date = array("year" => 2006, "month" => 10, "day" => 10, "hour" => 10, "min" => 0, "sec" => 0, "tz" => "+0200"); // local date + UTC offset => UTC DATE-TIME $vtodo->setProperty( "last-modified", $date ); .. .
Example 3
$vevent->setProperty( "last-modified" ); // current UTC DATE-TIME is set if called without parameters
The property defines the intended venue for the activity defined by a calendar component. The property is OPTIONAL and MUST NOT occur more than once in VEVENT and VTODO components.
The value type for LOCATION is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createLocation()
Example
$component->createLocation();
Remove LOCATION from component.
Format
deleteProperty( "LOCATION" )
Example
$vevent->deleteProperty( "LOCATION" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "LOCATION" )
output = location1
Format 2
getProperty( "LOCATION", FALSE , TRUE )
output = array( "value" => location1 , "params" => param2 )
Example
$location = $vevent->getProperty( "LOCATION" );
Insert property value.
Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "location", location [, param] )
location1 = (string) Value type TEXT params2 = (array) ( ["ALTREP" => (string) "<an alternate text representation, URI>"] [, "LANGUAGE" => (string) "<lang>"] [, xparams ] xparams = *[ (string) xparamkey => (string) xparamvalue ]
Example
$vevent->setProperty( "location", "Buckingham Palace" );
The property defines the organizer for a calendar component and is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO, VJOURNAL and VFREEBUSY components.
This value type for ORGANIZER is URI, a calendar user address.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createOrganizer()
Example
$component->createOrganizer();
Remove ORGANIZER from component.
Format
deleteProperty( "ORGANIZER" )
Example
$vevent->deleteProperty( "ORGANIZER" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "ORGANIZER" )
output = organizer1
Format 2
getProperty( "ORGANIZER", FALSE , TRUE )
output = array( "value" => organizer1 , "params" => params2 )
Example
$organizer = $vevent->getProperty( "ORGANIZER" );
Insert property value. Property value must be prefixed by protocol (ftp://, http://,mailto:, file://.. . ref. rfc 1738 ). Also DIR parameter must be prefixed by protocol. SENT-BY parameter must use protocol "mailto:", prefixed if missing.
Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "organizer", organizer [, params] )
organizer1 = (string) a calendar user address (cal-address), a URI as defined by [RFC 1738] or any other IANA registered form for a URI. params2 = (array) ( ["LANGUAGE" => (string) "<lang>" (applies to the CN parameter value) ] [, "CN" => (string) "common name to be associated with the calendar user specified by the property"] [, "DIR" => (string) "reference to a directory entry associated with the calendar user specified by the property" ] [, "SENT-BY" => (string) (cal-address, above) "single calendar user that is acting on behalf of the calendar user specified by the property" ] [, xparams ] xparams = *[ (string) xparamkey => (string) xparamvalue ]
Example
$dir = "ldap://domain.com:6666/o=3DDC%20Comp,c=3DUS??(cn=3DJohn%20Doe)"; $vevent->setProperty( "organizer" , "ical@domain.com" , array( "CN" => "John Doe" , "DIR" => $dir , "SENT-BY" => "secretary@domain.com" , "X-Key1" => "X-Value1" , "X-Key2" => "X-Value2" ));
This property is used by an assignee or delegatee of a VTODO to convey the percent completion of a VTODO to the Organizer and is OPTIONAL and MUST NOT occur more than once.
The property value is a positive integer between zero and one hundred. A value of "0" indicates the VTODO has not yet been started. A value of "100" indicates that the VTODO has been completed. Integer values in between indicate the percent partially complete.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createPercentComplete()
Example
$component->createPercentComplete();
Remove PERCENT-COMPLETE from component.
Format
deleteProperty( "PERCENT-COMPLETE" )
Example
$vtodo->deleteProperty( "PERCENT-COMPLETE" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "PERCENT-COMPLETE" )
output = percent1
Format 2
getProperty( "PRIORITY", FALSE , TRUE )
output = array( "value" => percent1 , "params" => xparams2 )
Example
$percent = $vtodo->getProperty( "PERCENT-COMPLETE" );
Insert property value.
Format
setProperty( "Percent-Complete", percent [, xparams ] )
percent1 = (int) Value type INTEGER xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$vtodo->setProperty( "percent-complete", 90 );
The property defines the relative priority for a calendar component and is OPTIONAL and MUST NOT occur more than once in VEVENT and VTODO components.
The priority is specified as an integer in the range zero to nine.
A value of zero (US-ASCII decimal 48) specifies an undefined priority.
A value of one (US-ASCII decimal 49) is the highest priority.
A value of two (US-ASCII decimal 50) is the second highest priority.
Subsequent numbers specify a decreasing ordinal priority.
A value of nine (US-ASCII decimal 58) is the lowest priority.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createPriority()
Example
$component->createPriority();
Remove PRIORITY from component.
Format
deleteProperty( "PRIORITY" )
Example
$vevent->deleteProperty( "PRIORITY" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "PRIORITY" )
output = priority1
Format 2
getProperty( "PRIORITY", FALSE , TRUE )
output = array( "value" => priority1 , "params" => xparams2 )
Example
$priority = $vevent->getProperty( "priority" );
Insert property value.
Format
setProperty( "priority", priority [, xparams ] )
priority1 = (int) Value type INTEGER xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$vevent->setProperty( "priority", 3 );
This property defines the list of date/times for a recurrence set and is OPTIONAL and MAY occur more than once in VEVENT, VTODO, VJOURNAL, STANDARD and DAYLIGHT components.
The default value type for RDATE is DATE-TIME, can be set to DATE or PERIOD (params2). In STANDARD and DAYLIGHT components, RDATE MUST be specified as a date-time value type with local time value.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createRdate()
Example
$component->createRdate();
Remove RDATE from component.
Format
deleteProperty( "RDATE" )
Example 1
Delete (single/first) RDATE property.
$vtodo->deleteProperty( "RDATE" );
Example 2
Delete RDATE property no 2.
$vjournal->deleteProperty( "RDATE", 2 );
Example 3
Delete all RDATE properties.
while( $vjournal->deleteProperty( "RDATE" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "RDATE" )
output = dates1
Format 2
getProperty( "RDATE", propOrderNo/FALSE , TRUE )
propOrderNo = (int) specific property value
output = array( "value" => dates1 , "params" => params2 )
Format 3
getProperty( "RDATE", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo RDATE
Example
$rdates = $vevent->getProperty( "RDATE" );
Insert property value.
If "TZID" is set in params, ex. "TZID" = "CET", all timezone or offset in dates are ignored and DATE-TIME value type is set.
If DATE value type is set in params ("VALUE" = "DATE"), all timezone or offset in dates are ignored.
If "PERIOD" is set in params ("VALUE" = "PERIOD"), DATE-TIME value type is set.
If no "VALUE" parameter in params, DATE-TIME (default) value type is set.
If empty params and offset in 1st date, all remaining dates are set to UTC.
If no "TZID" is set in params and timezone in 1st date, all remaining dates are within this timezone and param "TZID" is set.
If none of the above rules are applicable, DATE-TIME and local date is set default.
Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "rdate", dates [, params [, propOrderNo ]] )
dates1 = (array) ( date2 *[, date2 ] )
date2 = date / (array) ( startdate, enddate/duration )
startdate = date
enddate = date
date = (array) ( (int) year
, (int) month
, (int) day
[, (int) int hour
, (int) min
, (int) day
, tz ] )
date = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
[, "tz" => tz ]] )
// output format
date = (array) ( "timestamp" => (int) timestamp [, "tz" => tz ] )
date = (string) date/datetime string*
tz = <timezone identifier> / offset
(timezone will be used as tzidparam, if tzidparam not exists)
offset = (int) (+/-)HHmm[ss], local date + UTC offset => UTC DATE-TIME
duration = (array) ( (int) week/false
[, (int) day/false
, (int) hour
, (int) min
, (int) sec] )
duration = (array) ([ "week" => (int) week / FALSE ,] /
[ "day" => (int) day / FALSE
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec ]] );
// output format, only used keys
duration = (array) ( "sec" => (int) sec );
duration = (string) duration like "P15DT5H0M20S"
params2 = ([tzidparam ( / datetimeparam / dateparam / periodparam )]
*[, xparams ] )
tzidparam = "TZID" => (string) <timezone identifier>
// output as local DATE-TIME with timezone identifier
// if tzidparam="GMT"/"UTC" then
// output date-time are suffixed by 'Z'
datetimeparam = "VALUE" => "DATE-TIME" // default, output as DATE-TIME
dateparam = "VALUE" => "DATE" // output as DATE
periodparam = "VALUE" => "PERIOD" // output as PERIOD (datetime)
xparams = (string) xparamkey => (string) xparamvalue
propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
trailing characters (digits), if exists, will be interpreted as offset/timezone
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example
See rules in detail in RFC2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar).// $rdate1 = array ( 2001, 1, 1, 1, 1, 1 ); // alt. $rdate1 = array( "year" => 2001 , "month" => 1 , "day" => 1 , "hour" => 1 , "min" => 1 , "sec" => 1 , "tz" => "GMT" ); $rdate2 = array( 2002, 2, 2, 2, 2, 2, "GMT" ); $rdate3 = "3 March 2003 03.03.03"; $rdate4 = array( 2004, 4, 4, 4, 4, 4, "GMT" ); $rdate5 = array( 2005, 10, 5, 5, 5, 5 ); $rdate8 = array( "year" => 2007, "month" => 7, "day" => 7 ); $rdur6 = array( "week" => 0 , "day" => 0 , "hour" => 5 , "min" => 5 , "sec" => 5 ); $rdur7 = array( 0, 0, 6 ); // duration for 6 hours $rdur8 = array( "week" => 8 ); // duration for 8 weeks $vevent = & $vcalendar->newComponent( "vevent" ); $vevent->setProperty( "rdate", array( $rdate1 )); // one recurrence date, date in 7-params format (DATE-TIME) $vevent->setProperty( "rdate", array( $rdate1, $rdate2 )); // two dates, date 7-params format (DATE-TIME) $vevent->setProperty( "rdate", array( array( $rdate1, $rdate2 ) , array( $rdate3, $rdate4 )) , array( "VALUE" => "PERIOD" )); // Both fromdate and enddate must have 7 params (DATE-TIME) !!! $vevent->setProperty( "rdate", array( array( $rdate2, $rdur6 )) , array( "VALUE" => "PERIOD" )); // one duration (fromdate-duration) $vevent->setProperty( "rdate", array( array( $rdate1, $date2 ) , array( $rdate3, $rdur7 )) , array( "VALUE" => "PERIOD" )); // period, pairs of fromdate+enddate and fromdate-duration $vevent->setProperty( "rdate", array( $rdate5, $date8 )) , array( "VALUE" => "DATE" )); // dates in DATE format .. .
This property is used in conjunction with the UID and SEQUENCE property to identify a specific instance of a recurring VEVENT, VTODO or VJOURNAL calendar component and is OPTIONAL and MAY NOT occur more than once.
The property value is the effective value of the DTSTART property of the recurrence instance. The default value type is DATE-TIME, can be set to DATE (params 2).
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createRecurrenceid()
Example
$component->createRecurrenceid();
Remove RECURRENCE-ID from component.
Format
deleteProperty( "RECURRENCE-ID" )
Example
$vevent->deleteProperty( "RECURRENCE-ID" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "RECURRENCE-ID" )
output = recurrIdDate1
Format 2
getProperty( "RECURRENCE-ID", FALSE , TRUE )
output = array( "value" => recurrIdDate1 , "params" => params2 )
Example
$recurrDate = $vtodo->getProperty( "RECURRENCE-ID" );
Insert property value. If DATE value type is expected, "VALUE" = "DATE" must be set (in params2) otherwise DATE-TIME (default) value type is set.
If no timezone parameter (tz or tzidparam below) is set (local time) and config TZID is set, date-time values will be set WITH timezone from config. Notice, use function transformDateTime to change a datetime from one time zone to another (or UTC).
Format
setProperty( "recurrence-id", recurrIdDate [, params ] )
recurrIdDate1 = (array) ( "year" => (int) year
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
[, "tz" => tz ]] )
recurrIdDate = (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, tz ]]
recurrIdDate = (array) ( (int) year
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec
[, tz ]] )
recurrIdDate = (array) ( "timestamp" => (int) timestamp
[, "tz" => tz ] )
recurrIdDate = (string) date/datetime string*
tz = (string) <timezone identifier> / offset
(timezone will be used as tzidparam, if tzidparam not exists)
offset = (int) (+/-)HHmm[ss], local date + UTC offset => UTC DATE-TIME
params2 = (array) ([ datetimeparam/dateparam/tzidparam ]
[, rangeparam ]
[, xparams ] )
datetimeparam = "VALUE" => "DATE-TIME" // default, output as DATE-TIME
dateparam = "VALUE" => "DATE" // output as DATE
tzidparam = "TZID" => (string) <timezone identifier>
// output as local date-time with timezone identifier
// if tzidparam="GMT"/"UTC" then
// output date-time are suffixed by 'Z'
rangeparam = "RANGE" => ( "THISANDPRIOR" / "THISANDFUTURE" )
// range parameter
xparams = *[ string) xparamkey => (string) xparamvalue ]
date/datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
trailing characters (digits), if exists, will be interpreted as offset/timezone
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example
$vtodo->setProperty( "recurrence-id", "3 March 2003 03.03.03" ); // 3 march 2003 03.03.03 local time
The property is used to represent a relationship or reference between one calendar component and another and is OPTIONAL and MAY occur more than once in VEVENT, VTODO, VJOURNAL components.
The property value consists of the persistent, globally unique identifier of another calendar component. This value would be represented in a calendar component by the UID property.
The value type for RELATED-TO is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createRelatedTo()
Example
$component->createRelatedTo();
Remove RELATED-TO from component.
Format
deleteProperty( "RELATED-TO" )
Example 1
Delete /single/first) RELATED-TO property
$vtodo->deleteProperty( "RELATED-TO" );
Example 2
Delete RELATED-TO property no 2.
$vjournal->deleteProperty( "RELATED-TO", 2 );
Example 3
Deleting all RELATED-TO properties.
while( $vjournal->deleteProperty( "RELATED-TO" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "RELATED-TO" )
output = relid1
Format 2
getProperty( "RELATED-TO", propOrderNo/FALSE , TRUE )
propOrderNo = (int) specific property value
output = array( "value" => relid1 , "params" => params2 )
Format 3
getProperty( "RELATED-TO", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo RELATED-TO
Example
$relatedId = $vtodo->getProperty( "RELATED-TO" );
Insert property value.
Format
setProperty( "Related-To", relid [, params [, propOrderNo ]] )
relid1 = (string) Value type TEXT. params2 = (array) ( [ reltype ] [, xparams] ) reltype = "RELTYPE" => ("PARENT" (Default) / "CHILD" / "SIBLING" / (string) iana-token / (string) x-name ) xparams = *[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
Example
$vtodo->setProperty( "related-to", "19960401-080045-4000F192713@host.com");
This property defines the number of time the ALARM should be repeated, after the initial trigger. If the ALARM triggers more than once, then this property MUST be specified along with the DURATION property.
The value type for REPEAT is INTEGER.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createRepeat()
Example
$component->createRepeat();
Remove REPEAT from component.
Format
deleteProperty( "REPEAT" )
Example
$valarm->deleteProperty( "REPEAT" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "REPEAT" )
output = repeatTimes1
Format 2
getProperty( "REPEAT", FALSE , TRUE )
output = array( "value" => repeatTimes1 , "params" => xparams2 )
Example
$repeat = $vtodo->getProperty( "REPEAT" );
Insert property value.
Format
setProperty( "repeat", repeatTimes [, xparams ] )
repeatTimes1 = (int) Value type INTEGER xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$valarm->setProperty( "repeat", 2 );
This property defines the status code returned for a scheduling request and is OPTIONAL and MAY occur more than once in VEVENT, VTODO, VJOURNAL and VFREEBUSY components.
The value type for REQUEST-STATUS is TEXT and consists of
In output, the components are separated by (BACKSLASHed) SEMICOLON.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createRequestStatus()
Example
$component->createRequestStatus();
Remove REQUEST-STATUS from component.
Format
deleteProperty( "REQUEST-STATUS" )
Example 1
Delete (single/first) REQUEST-STATUS property.
$vtodo->deleteProperty( "REQUEST-STATUS" );
Example 2
Delete REQUEST-STATUS property no 2.
$vjournal->deleteProperty( "REQUEST-STATUS", 2 );
Example 3
Deleting all REQUEST-STATUS properties.
while( $vjournal->deleteProperty( "REQUEST-STATUS" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "REQUEST-STATUS" )
output = array( "statcode" => statcode1 , "text" => errtext2 [ , "extdata" => extraData 3 ] )
Format 2
getProperty( "REQUEST-STATUS", propOrderNo/FALSE, TRUE )
propOrderNo = (int) specific property value
output = array( "value" => array( "statcode" => statcode1 , "text" => errtext2 [ , "extdata" => extraData3 ] ) , "params" => params4 )
Format 3
getProperty( "REQUEST-STATUS", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo REQUEST-STATUS
Example
$requestStatus = $vtodo->getProperty( "REQUEST-STATUS" );
Insert property value.
Format
setProperty( "Request-Status" , statcode, errtext [,extraData/FALSE [,params [,propOrderNo]]])
statcode1 = (int) Hierarchical, numeric return status code (1*DIGIT "." 1*DIGIT 1*DIGIT) errtext2 = (string) Textual status description extraData3 = (string) Textual exception data. For example, the offending property name and value or complete property line. params4 = (array) ( ["LANGUAGE" => (string) "<lang>"] [, xparams ] ) xparams = *[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
Example
$vfreebusy->setProperty("request-status" , 2.00 , "Invalid property value" , "DTSTART:96-Apr-31");
This property defines the equipment or resources anticipated for an activity specified by a calendar entity and is OPTIONAL and MAY occur more than once in VEVENT and VTODO components.
The value type for RESOURCES is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createResources()
Example
$component->createResources();
Remove RESOURCES from component.
Format
deleteProperty( "RESOURCES" )
Example 1
Delete (single/first) RESOURCES property.
$vevent->deleteProperty( "RESOURCES" );
Example 2
Delete RESOURCES property no 2.
$vevent->deleteProperty( "RESOURCES", 2 );
Example 3
Delete all RESOURCES properties.
while( $vevent->deleteProperty( "RESOURCES" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "RESOURCES" )
output = resources1
Format 2
getProperty( "RESOURCES", propOrderNo/FALSE, TRUE )
propOrderNo = (int) specific property value
output = array( "value" => resources1 , "params" => params2 )
Format 3
getProperty( "RESOURCES", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo RESOURCES
Example
$resources = $vtodo->getProperty( "RESOURCES" );
Insert property value.
Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "resources", resources [, params [, propOrderNo ]] )
resources1 = (string) resource / (array) ( *resource ) resource = (string) textual resources or subtypes of the calendar component, can be specified as a list of resources separated by the COMMA character. params2 = (array) ( [ "ALTREP" => (string) "<an alternate text representation, URI>"] [, "LANGUAGE" => (string) "<lang>"] [, xparams] ) xparams = *[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
Example
$vevent->setProperty( "resources", "COMPUTER PROJECTOR" );
This property defines a rule or repeating pattern for recurring EVENTs, TODOs, STANDARD or DAYLIGHT definitions and is OPTIONAL and MAY occur more than once.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createRrule()
Example
$component->createRrule();
Remove RRULE from component.
Format
deleteProperty( "RRULE" )
Example 1
Delete (single/first) RRULE property.
$vevent->deleteProperty( "RRULE" );
Example 2
Delete RRULE property no 2.
$vevent->deleteProperty( "RRULE", 2 );
Example 3
Delete all RRULE properties.
while( $vevent->deleteProperty( "RRULE" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "RRULE" )
output = recur1
Format 2
getProperty( "RRULE", propOrderNo/FALSE, TRUE )
propOrderNo = (int) specific property value
output = array( "value" => recur1 , "params" => xparams2 )
Format 3
getProperty( "RRULE", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo RRULE
Example
$rrules = $vtodo->getProperty( "RRULE" );
Insert property value.
Parameters will be ordered as prescribed in rcf2445.
Format
setProperty( "rrule", recur [, xparams [, propOrderNo ]] )
For rules example see Exrule format and in detail in RFC2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar).
recur1 = see Exrule xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] ) propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
This property defines the revision sequence number of the calendar component within a sequence of revisions. The property is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO and VJOURNAL components.
It is monotonically incremented by the ORGANIZER's CUA (Calendar User Agent) each time the ORGANIZER makes a significant revision to the calendar component. When the ORGANIZER makes changes to one of the following properties, the sequence number MUST be incremented: DTSTART, DTEND, DUE, RDATE, RRULE, EXDATE, EXRULE, STATUS. In addition, changes made by the ORGANIZER to other properties can also force the sequence number to be incremented. The ORGANIZER CUA MUST increment the sequence number when ever it makes changes to properties in the calendar component that the ORGANIZER deems will jeopardize the validity of the participation status of the Attendees. For example, changing the location of a meeting from one locale to another distant locale could effectively impact the participation status of the Attendees.
The value type of SEQUENCE is INTEGER.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createSequence()
Example
$component->createSequence();
Remove SEQUENCE from component.
Format
deleteProperty( "SEQUENCE" )
Example
$vtodo->deleteProperty( "SEQUENCE" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "SEQUENCE" )
output = sequence1
Format 2
getProperty( "SEQUENCE", FALSE , TRUE )
output = array( "value" => sequence1 , "params" => xparams2 )
Example
$sequence = $vtodo->getProperty( "SEQUENCE" );
Insert property value.
Format
setProperty( "sequence" [, sequence [, xparams ]] )
sequence1 = (int) Value type INTEGER xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
Example 1
$vevent->setProperty( "sequence", 2 ); // set sequence number to 2
Example 2
$vevent->setProperty( "sequence" ); // force sequence number to be set to 0 // or, if sequence exists, incremented by 1
This property defines the overall status or confirmation for the calendar component. The property is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO and VJOURNAL components.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createStatus()
Example
$component->createStatus();
Remove STATUS from component.
Format
deleteProperty( "STATUS" )
Example
$vtodo->deleteProperty( "STATUS" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "STATUS" )
output = status1
Format 2
getProperty( "STATUS", FALSE , TRUE )
output = array( "value" => status1 , "params" => xparams2 )
Example
$status = $vtodo->getProperty( "STATUS" );
Insert property value.
Format
setProperty( "status", status [, xparams ] )
// Status values for a VEVENT status1 = "TENTATIVE" // Indicates event is tentative / "CONFIRMED" // Indicates event is definite / "CANCELLED" // Indicates event was cancelled // Status values for VTODO status1 = "NEEDS-ACTION" // Indicates to-do needs action / "COMPLETED" // Indicates to-do completed / "IN-PROCESS" // Indicates to-do in process of / "CANCELLED" // Indicates to-do was cancelled // Status values for VJOURNAL status1 = "DRAFT" // Indicates journal is draft / "FINAL" // Indicates journal is final / "CANCELLED" // Indicates journal is removed xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$vevent->setProperty( "Status", "COMPLETED" );
This property defines a short ("one line") summary or subject for the calendar component. (In "rfc2445, Recommended Practices", up to 255 characters) (, analogous to a mail SUBJECT). The property is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO and VJOURNAL components. The property is REQUIRED and MUST occur once in VALARM (EMAIL) calendar component.
The value type for SUMMARY is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createSummary()
Example
$component->createSummary();
Remove SUMMARY from component.
Format
deleteProperty( "SUMMARY" )
Example
$vevent->deleteProperty( "SUMMARY" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "SUMMARY" )
output = summary1
Format 2
getProperty( "SUMMARY", FALSE , TRUE )
output = array( "value" => summary1 , "params" => params2 )
Example
$summary = $vtodo->getProperty( "SUMMARY" );
Insert property value.
Parameters, if any, will be ordered as prescribed in rcf2445.
Format
setProperty( "summary", summary [, params ] )
summary1 = (string) Value type TEXT, a short, one line summary about the activity or journal entry. params2 = array( ["ALTREP" => (string) "<an alternate text representation, URI>"] [, "LANGUAGE" => (string) "<lang>"] [, xparams ] ) xparams = *[ (string) xparamkey => (string) xparamvalue ]
Example
$vevent->setProperty( "summary", "This is a summary" );
This property defines whether an EVENT is transparent or not to busy time searches and is OPTIONAL and MUST NOT occur more than once.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createTransp()
Example
$component->createTransp();
Remove TRANSP from component.
Format
deleteProperty( "TRANSP" )
Example
$vevent->deleteProperty( "TRANSP" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "TRANSP" )
output = transp1
Format 2
getProperty( "TRANSP", FALSE , TRUE )
output = array( "value" => transp1 , "params" => xparams2 )
Example
$transp = $vtodo->getProperty( "TRANSP" );
Insert property value.
Format
setProperty( "transp", transp [, xparams ] )
transp1 = "OPAQUE" / "TRANSPARENT" xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$vevent->setProperty( "transp", "TRANSPARENT" );
This property specifies when an ALARM will trigger and is REQUIRED and MUST NOT occur more than once.
The default value type is DURATION. The value type can be set to a DATE-TIME value type, in which case the value MUST specify an UTC formatted DATE-TIME value.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createTrigger()
Example
$component->createTrigger();
Remove TRIGGER from component.
Format
deleteProperty( "TRIGGER" )
Example
$valarm->deleteProperty( "TRIGGER" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "TRIGGER" )
output = duration/date
Format 2
getProperty( "TRIGGER", FALSE , TRUE )
output = array( "value" => duration1/date3 ) , "params" => params4 )
Example
$trigger = $vtodo->getProperty( "TRIGGER" );
Insert property value.
Note, use function transformDateTime to change a (local) datetime to UTC time zone.
Format 1
setProperty( "trigger", duration1 [, params4 ] )
Format 2
setProperty( "trigger", duration2 [, params4 ] )
Format 3
setProperty( "trigger", date3 [, params4 ] )
Format
setProperty( "trigger", (int) year / FALSE , (int) month / FALSE , (int) day / FALSE [, (int) week / FALSE [, (int) hour / FALSE , (int) min / FALSE , (int) sec / FALSE [, relatedStart [, before [, params4 ]]]]] )
duration1 = (array) ( "week" => (int) week
, "relatedStart" => relatedStart
, "before" => before )
duration1 = (array) ( "day" => (int) day
, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec
, "relatedStart" => relatedStart
, "before" => before )
relatedStart = (bool) TRUE : related start (default),
FALSE : related end
before = (booL) TRUE : before relatedStart (default),
FALSE : after relatedStart
duration2 = (string) dur-value = (["+"]/"-")"P"(dur-date/dur-time/dur-week)
dur-date = dur-day [dur-time]
dur-time = "T" (dur-hour / dur-minute / dur-second)
dur-week = 1*DIGIT "W"
dur-day = 1*DIGIT "D"
dur-hour = 1*DIGIT "H" [dur-minute]
dur-minute = 1*DIGIT "M" [dur-second]
dur-second = 1*DIGIT "S"
date3 = (array) ( "year" => (int) year // UTC DATE-TIME
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec ])
date3 = (array) ( "timestamp" => (int) timestamp ) // UTCDATE-TIME
date3 = (string) datetime string*
params4 = (array) ( [[ reltype [, trigRelparam ]] / datetimeparam ]
[, xparams ] )
reltyp = "RELATED" => "START" (default) / "END"
trigRelparam = "VALUE" => "DURATION"
datetimeparam= "VALUE" => "DATE-TIME"
xparams = *[ (string) xparamkey => (string) xparamvalue ]
datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example 1
A duration, 1 hour 2 min 3 sec, before start
$valarm->setProperty( "trigger" , FALSE, FALSE, FALSE, FALSE, 1, 2, 3 );
Example 2
A duration, 1 hour 2 min 3 sec, before start
$valarm->setProperty( "trigger" , array ("hour"=>1,"min"=>2,"sec"=>3 );
Example 3
A duration, 1 hour 2 min 3 sec, before start
$valarm->setProperty( "trigger" , "PT1H2M3S" );
Example 4
A duration, 1 week after end.
$valarm->setProperty( "trigger" , FALSE, FALSE, FALSE, 1 , FALSE, FALSE, FALSE, FALSE, FALSE );
Example 5
A duration, 1 week after end.
$valarm->setProperty( "trigger" , array ( "week" => 1 , "relatedStart" => FALSE , "before" => FALSE ));
Example 6
A duration, 1 week after end.
$valarm->setProperty( "trigger" , "P1W" , array( "related" => "END" ));
Example 7
$valarm->setProperty( "trigger" , array( "year" => 2007 , "month" => 6 , "day" => 5, , "hour" => 2 , "min" => 2 , "sec" => 3 ));
This property specifies the text value that uniquely identifies the VTIMEZONE calendar component and is REQUIRED, but MUST NOT occur more than once.
The value type for TZID is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createTzid()
Example
$component->createTzid();
Remove TZID from component.
Format
deleteProperty( "TZID" )
Example
$vtimezone->deleteProperty( "TZID" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "TZID" )
output = tzid1
Format 2
getProperty( "TZID", FALSE , TRUE )
output = array( "value" => tzid1 , "params" => xparams2 )
Example
$tzid = $vtimezone->getProperty( "TZID" );
Insert property value.
Format
setProperty( "tzid", tzid [, xparams ] )
tzid1 = (string) Value type TEXT xparams2 = (array)( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); $vtimezone = & $vcalendar->newComponent( "vtimezone" ); $vtimezone->setProperty( "tzid", "US-Eastern" ); .. .
This property specifies the customary designation for a STANDARD or DAYLIGHT description and is OPTIONAL and MAY occur more than once.
The value type for TZNAME is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createTzname()
Example
$component->createTzname();
Remove TZNAME from component.
Format
deleteProperty( "TZNAME" )
Example 1
Delete (single/first) TZNAME property.
$vtimezonestd->deleteProperty( "TZNAME" );
Example 2
Delete TZNAME property no 2.
$vtimezonestd->deleteProperty( "TZNAME", 2 );
Example 3
Deleting all TZNAME properties.
while( $vtimezonestd->deleteProperty( "TZNAME" )) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "TZNAME" )
output = tzname1
Format 2
getProperty( "TZNAME", propOrderNo/FALSE, TRUE )
propOrderNo = (int) specific property value
output = array( "value" => tzname1 , "params" => params2 )
Format 3
getProperty( "TZNAME", propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo TZNAME
Example
$tzname = $timezonestandard->getProperty( "TZNAME" );
Insert property value.
Format
setProperty( "tzname", tzname [, params [, propOrderNo ]] )
tzname1 = (string) Value type TEXT params2 = (array) ( [ "LANGUAGE" => (string) "<lang>" ] [, xparams ] ) xparams = *[ (string) xparamkey => (string) xparamvalue ] propOrderNo = (int) ordernumber, 1=1st, 2=2nd etc
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); $vtimezone = & $vcalendar->newComponent( "vtimezone" ); $vtimezone->setProperty( "Tzid", "US-Eastern" ); $vtimezone->setProperty( "Last-Modified", "19870101" ); $standard = & $vtimezone->newComponent( "standard" ); $standard->setProperty( "tzname", "EST" ); .. .
This property specifies the offset which is in use prior to this TIMEZONE observance. The property is REQUIRED, but MUST NOT occur more than once in STANDARD and DAYLIGHT components.
The value type is UTC-OFFSET, "+" / "-" time-hour (2*DIGIT) time-minute (2*DIGIT) [time-second (2*DIGIT)].
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createTzoffsetfrom()
Example
$component->createTzoffsetfrom();
Remove TZOFFSETFROM from component.
Format
deleteProperty( "TZOFFSETFROM" )
Example
$vtimezonestd->deleteProperty( "TZOFFSETFROM" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "TZOFFSETFROM" )
output = tzoffsetfrom1
Format 2
getProperty( "TZOFFSETFROM", FALSE , TRUE )
output = array( "value" => tzoffsetfrom1 , "params" => xparams2 )
Example
$tzoffsetfrom = $timezonestandard->getProperty( "TZOFFSETFROM" );
Insert property value.
Format
setProperty( "tzoffsetfrom", tzoffsetfrom [, xparams ] )
tzoffsetfrom1 = (int) (+/-)HHmm[ss], UTC offset xparams2 = (array) ( *[ /string) xparamkey => (string) xparamvalue ] )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); $vtimezone = & $vcalendar->newComponent( "vtimezone" ); $vtimezone->setProperty( "Tzid", "US-Eastern" ); $vtimezone->setProperty( "Last-Modified", "19870101" ); $standard = & $vtimezone->newComponent( "standard" ); $standard->setProperty( "tzname", "EST" ); $standard->setProperty( "tzoffsetfrom", "-0500" ); .. .
This property specifies the offset which is in use in this TIMEZONE observance. The property is REQUIRED, but MUST NOT occur more than once in STANDARD and DAYLIGHT components.
The value type is UTC-OFFSET, "+" / "-" time-hour (2*DIGIT) time-minute (2*DIGIT) [time-second (2*DIGIT)].
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createTzoffsetto()
Example
$component->createTzoffsetto();
Remove TZOFFSETTO from component.
Format
deleteProperty( "TZOFFSETTO" )
Example
$daylight->deleteProperty( "TZOFFSETTO" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "TZOFFSETTO" )
output = tzoffsetto1
Format 2
getProperty( "TZOFFSETTO", FALSE , TRUE )
output = array( "value" => tzoffsetto1 , "params" => xparams2 )
Example
$tzoffsetto = $timezonestandard->getProperty( "TZOFFSETTO" );
Insert property value.
Format
setProperty( "tzoffsetto", tzoffsetto [, xparams ] )
tzoffsetto1 = (int) (+/-)HHmm[ss], UTC offset xparams2 = array( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); $vtimezone = & $vcalendar->newComponent( "vtimezone" ); $vtimezone->setProperty( "Tzid", "US-Eastern" ); $vtimezone->setProperty( "Last-Modified", "19870101" ); $standard = & $vtimezone->newComponent( "standard" ); .. . $daylight = & $vtimezone->newComponent( "daylight" ); $daylight->setProperty( "tzoffsetto", "1345" ); .. .
The TZURL provides a means for a VTIMEZONE component to point to a network location that can be used to retrieve an up-to-date version of itself. The property is OPTIONAL and MUST NOT occur more than once.
The value type is URI.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createTzurl()
Example
$component->createTzurl();
Remove TZURL from component.
Format
deleteProperty( "TZURL" )
Example
$vtimezone->deleteProperty( "TZURL" );
If set, returns property value, otherwise FALSE.
.Format 1
getProperty( "TZURL" )
output = tzurl1
Format 2
getProperty( "TZURL", FALSE , TRUE )
output = array( "value" => tzurl1 , "params" => xparams2 )
Example
$tzurl = $timezonestandard->getProperty( "TZURL" );
Insert property value.
Format
setProperty( "tzurl", tzurl [, xparams ] )
tzurl1 = (string) Value type URI xparams2 = array( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$tz = "http://zones.stds_r_us.net/tz/US-Eastern" ); $config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); $vtimezone = & $vcalendar->newComponent( "vtimezone" ); $vtimezone->setProperty( "Tzid", "US-Eastern" ); $vtimezone->setProperty( "Last-Modified", "19870101T000000" ); $vtimezone->setProperty( "tzurl", $tz ); .. . .. .
The persistent, globally Unique IDentifier for the calendar component.
The property is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO, VJOURNAL and VFREEBUSY components.
However, UID is AUTOMATICALLY generated in iCalcreator and configuration unique_id, is used when auto-creating component UID.
UID generated format :
date("Ymd\THisT")."-".[microSec][random]."@".unique_id
microSec = microseconds, 4 pos
random = 6 characters aA-zZ, 0-9
Example
"20070803T194810CEST-0123U3PXiX@kigkonsult.se"
UID may be required when importing iCal files into some calendar software (MS etc.), as well as (calendar) properties x-properties "X-WR-CALNAME", "X-WR-CALDESC" and "X-WR-TIMEZONE", METHOD (value PUBLISH etc.) and the (also automatically created) DTSTAMP property.
The value type for UID is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createUid()
Example
$component->createUid();
If UID is remove from a component, UID will automatically be recreated when calendar output functions like createCalendar, returnCalendar or saveCalendar is executed.
Format
deleteProperty( "UID" )
Example
$vevent->deleteProperty( "UID" );
If set, returns property, otherwise FALSE.
Format 1
getProperty( "UID" )
output = uid1
Format 2
getProperty( "UID", FALSE , TRUE )
output = array( "value" => uid1 , "params" => xparams2 )
Example
$uid = $vevent->getProperty( "UID" );
Insert property value, overrides any previously set or auto-created UID.
Do NOT use an integer UID or only a component name in UID (ex. "vevent"), this may cause malfunction in setComponent with index or UID argument.
Format
setProperty( "uid", uid [, xparams ] )
uid1 = (string) Value type TEXT xparams2 = array( *[ (string) xparamkey => (string) xparamvalue ] )
Example
$vevent->setProperty("uid","20070803T194810CEST-0123U3PXiX@kigkonsult.se");
This property defines a Uniform Resource Locator (URL) associated with the iCalendar object. The property is OPTIONAL and MUST NOT occur more than once in VEVENT, VTODO, VJOURNAL and VFREEBUSY components.
The value type is URI.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createUrl()
Example
$component->createUrl();
Remove URL from component.
Format
deleteProperty( "URL" )
Example
$vevent->deleteProperty( "URL" );
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "URL" )
output = url1
Format 2
getProperty( "URL", FALSE , TRUE )
output = array "value" => url1 , "params" => xparams2 )
Example
$url = $vevent->getProperty( "URL" );
Insert property value.
Format
setProperty( "url", url [, xparams ] )
url1 = (string) Value type URI xparams2 = (array) ( *[ (string) xparamkey => (string) xparamvalue ] (
Example
$vtodo->setProperty( "url", "http://www.icaldomain.net" );
A component, non-standard property with a TEXT value and a name with an "X-" prefix. In a component, an x-property, with an unique name, can occur only once but the number of x-properties are unlimited.
The value type is TEXT.
If set, returns rfc2445 formatted string, otherwise FALSE.
Format
createXprop()
Example
$component->createxProp();
Remove X-PROPERTY from component.
Format
deleteProperty( "<X-PROPERTY>" )
Example 1
Deleting x-property named "X-PROPERTY".
$vevent->deleteProperty( "X-PROPERTY" );
Example 2
Deleting all x-properties.
while( $vevent->deleteProperty()) continue;
If set, returns property value, otherwise FALSE.
Format 1
getProperty( "<X-PROPERTY>" )
output = array( propertyName1 , propertyData2 )
Format 2
getProperty()
output = array( propertyName1 , propertyData2 )
Format 3
getProperty( FALSE, propOrderNo/FALSE, TRUE )
propOrderNo = (int) specific property value
output = array( propertyName1 , array ( "value" => propertyData2 ) , "params" => params 3))
Format 4
getProperty( FALSE, propOrderNo )
propOrderNo = (int) specific property value
Get propOrderNo X-property
Example 1
$config = array( "unique_id" => "kigkonsult.se", "filename", "file.ics" ); ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); if( FALSE !== ( $d = $vcalendar->getProperty( "X-WR-TIMEZONE" ))) echo $d[1]; .. .
// $xprop = array( propertyName1, propertyData2 )
Example 2
$config = array( "unique_id" => "kigkonsult.se", "filename", "file.ics" ); ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); while( $xprop = $vcalendar->getProperty( )) { .. .
// $xprop = array( propertyName1, propertyData2 )
Example 3
$config = array( "unique_id" => "kigkonsult.se", "filename", "file.ics" ); ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); while( $xprop = $vcalendar->getProperty( "X-ABC-MMSUBJ" )) { .. .
// $xprop = array( "X-ABC-MMSUBJ", propertyData2 )
Example 4
$config = array( "unique_id" => "kigkonsult.se", "filename", "file.ics" ); ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); while( $xprop = $vcalendar->getProperty( FALSE, FALSE, TRUE )) { .. .
// $xprop = array( propertyName1 // , array( "value" => propertyData2 ) // , "params" => params 3 )
Insert property name and value. If an x-prop with the same name already exists, it will be replaced.
Format
setProperty( propertyName, propertyData [, params ] )
propertyName1 = (string) Any property name with a "X-" prefix propertyData2 = (string) Value type TEXT params3 = (array) ( ["LANGUAGE" => (string) "<lang>"] [, xparams] ) xparams = *[ (string) xparamkey => (string) xparamvalue ]
Example
$component->setProperty("X-ABC-MMSUBJ","http://load.noise.org/mysubj.wav");
Format
getConfig( "language" )
Example
$lang = $vevent->getConfig( "language" );
Format
setConfig( "language", lang )
lang = (string) language
Example
$vevent->setConfig( "language", "en" );
Format
deleteComponent( orderNumber )
orderNumber = (int) component order Number
Remove component with order number (1st=1, 2nd=2.. .).
deleteComponent( componentType [, componentSuborderNumber])
componentType = (string) component type componentSuborderNumber = (int) component suborder number
Remove component with component type (ex. "vevent") and order 1 alt. suborder number.
deleteComponent( UID )
Remove component with UID. N.B UID is NOT set for ALARM / timezone components.
Example 1
Delete first subcomponent.
$config = array( "unique_id" => "kigkonsult.se", "filename", "file.ics" ); ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $comp1 = $vcalendar->getComponent(); $comp1->deleteComponent( 1 ); .. .
Example 2
Delete all subcomponents.
$config = array( "unique_id" => "kigkonsult.se", "filename", "file.ics" ); ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $comp1 = $vcalendar->getComponent(); while( $comp1->deleteComponent( "valarm" ) continue; .. .
Format 1
getComponent()
Get next component until end-of-components.
Format 2
getComponent( int orderNumber )
orderNumber = (int) component order number
Get component with order number (1st=1, 2nd=2.. .).
Format 3
getComponent( string componentType [, int componentSuborderNumber])
componentType = (string) component type componentSuborderNumber = (int) component suborder number
Get (next) component with component type (until end-of-components) alt. component with component type and suborder number (1st=1, 2nd=2..).
Format 4
getComponent( UID )
Get component with UID. N.B UID is NOT set for ALARM / timezone components.
Example
$config = array( "unique_id" => "kigkonsult.se", "filename", "file.ics" ); ); $vcalendar = new vcalendar( $config ); $vcalendar->parse(); $comp1 = $vcalendar->getComponent()); while( $subComp = $comp1->getComponent()) { .. .
Format
newComponent( componentType )
componentType = (string) component type
Example 1
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vevent = & $vcalendar->newComponent( "vevent" ); $vevent->setProperty( "dtstart" // add some EVENT properties , 2006, 12, 24, 19, 30, 00 ); $vevent->setProperty(.. . ... $valarm = & $vevent->newComponent( "valarm" ); $valarm->setProperty( "trigger", .. . ...
Example 2
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); ... $vtimezone = & $vcalendar->newComponent( "vtimezone" ); $vtimezone->setProperty(.. . ... $standard = & $vtimezone->newComponent( "standard" ); $standard->setProperty(.. . ... $daylight = & $vtimezone->newComponent( "daylight" ); $daylight->setProperty(.. . ...
Format 1
setComponent( component ) addSubComponent( component ) // alias
Insert last in component chain.
Format 2
setComponent( component, int orderNumber )
orderNumber = (int) component order number
Replace component with order number(1st=1, 2nd=2.. .). If orderNumber is not found, component is inserted last in chain.
Format 3
setComponent( component, componentType [,componentSuborderNumber])
componentType = (string) component type componentSuborderNumber = (int) component suborder number
Replace component with component type and component order number. if orderNumber is not found, component is inserted last in chain.
Example
$config = array( "unique_id" => "kigkonsult.se" ); $vcalendar = new vcalendar( $config ); // initiate new CALENDAR .. . $vevent = new vevent(); $vevent->setProperty( "dtstart" // add some EVENT properties , 2006, 12, 24, 19, 30, 00 ); $vevent->setProperty(.. . .. . $valarm = new valarm(); $valarm->setProperty( "trigger", .. . .. . $vevent->setComponent( $valarm ); $vcalendar->setComponent( $vevent ); .. .
iCalUtilityFunctions class contains static functions used by iCalcreator, also usable outside the iCalcreator class. Please examine the class to explore other functions.
The function, applied on a iCalcrator instance and using a PHP valid timezone (as argument) creates vtimezone, standard and daylight components, based on PHP DateTimeZone class and the time zone transition dates. (PHP 5 >= 5.2.0)
Recommendation is to call the function after editing components (and without period from/to arguments, below), it will automatically create timezone components to fit.
Note, only when timezone NOT is UTC. For dates with UTC DATE-TIME, read this!
FALSE is returned if not using a PHP valid timezone.
Format
createTimezone( calendar, timezone [, xprops, [, from [, to ]]] )
calendar = (object) iCalcreator instance timezone = (string) an PHP (DateTimeZone) valid timezone xprops = (array) ( *[ x-propName => value ] ), timezone non-standard properties from = (int) timestamp, period start date to = (int) timestamp, period end date if the "from" and "to" arguments are missing, the calendar getProperty method (with DTSTART as argument) is used to get lowest and highest event dates (modified - one month / + one year) if still missing, two timezone transitions are created, using current date (modified - one month / + one year)
Example
$tz = "Europe/Stockholm"; $config = array( "unique_id" => "kigkonsult.se" ); $c = new vcalendar( $config ); $c->setProperty( "X-WR-TIMEZONE", $tz ); .. . $xprops = array( "X-LIC-LOCATION" => $tz ); iCalUtilityFunctions::createTimezone( $c, $tz, $xprops ); .. .
Output (when using createCalendar or returnCalendar functions):
BEGIN:VTIMEZONE
TZID:Europe/Stockholm
X-LIC-LOCATION:Europe/Stockholm
BEGIN:STANDARD
DTSTART:20111030T003000
TZOFFSETFROM:+0200
TZOFFSETTO:+0100
TZNAME:CET
END:STANDARD
BEGIN:DAYLIGHT
DTSTART:20110327T002000
TZOFFSETFROM:+0100
TZOFFSETTO:+0200
TZNAME:CEST
END:DAYLIGHT
END:VTIMEZONE
Conversion (very simple) of a MS timezone to a PHP5 valid (Date-)timezone,
matching (MS) UTC offset and time zone descriptors, based on PHP DateTimeZone class.
(PHP 5 >= 5.2.0)
If TRUE is returned, the MS timezone argument (below) is converted to a PHP5 time zone, otherwise unaltered.
Format
ms2phpTZ( timezone )
timezone = (string) MS timezone (input), PHP5 timezone (output)
Example
$search = '"(UTC-06:00) Central Time (US & Canada)"'; echo "MS tz:'$search'<br>\n"; if( FALSE !== iCalUtilityFunctions::ms2phpTZ( $search )) echo "PHP tz:'$search'<br>\n";
Transforms a datetime from a time zone to another. (Requires PHP >= 5.2.0 and PHP DateTimeZone acceptable time zones).
FALSE is returned if not using a "strtotime" acceptable datetime string or unacceptable PHP time zones. If TRUE, the dateTime argument (below) is converted to the new time zone, otherwise unaltered.
Format
transformDateTime( dateTime, timezoneFrom [, timezoneTo [, format ]] )
dateTime = (array) ( "year" => (int) year // input
, "month" => (int) month
, "day" => (int) day
[, "hour" => (int) hour
, "min" => (int) min
, "sec" => (int) sec ] )
dateTime = (array) ( (int) year // input
, (int) month
, (int) day
[, (int) hour
, (int) min
, (int) sec ] )
dateTime = (array) ( "timestamp" => (int) timestamp ) // input
dateTime = (string) datetime string* // input
dateTime = (string) datetime string // on successful output
timezoneFrom = (string) a PHP (DateTimeZone) valid time zone
timezoneTo = (string) a PHP (DateTimeZone) valid time zone, default "UTC"
format = (string) output format (any date formatting, default "Ymd\THis")
datetime string* recommended formats
"20110625", "2011-06-25", "2011/06/26"
"20110625051015", "20110625 051015"
"20110625T051015", "20110625t051015"
"2011-06-25 05:10:15", "2011-06-25T05:10:15", "2011-06-25t05:10:15"
"2011/06/25 05:10:15", "2011/06/25T05:10:15", "2011/06/25t05:10:15"
other string formats, acceptable by strtotime function, may (would) work
(notice date restriction)
Example
Convert from time zone "Europe/Stockholm" to "UTC"
.. .
$d = date( "Y-m-d H:i:s" );
$tzFr = "Europe/Stockholm";
if( FALSE !== iCalUtilityFunctions::transformDateTime( $d, $tzFr ))
$event->setProperty( "dtstart", $d."Z" );
else
$event->setProperty( "dtstart", $d, array( "TZID" => $tzFr ));
.. .
The helper functions extend the utility of iCalcreator.
The iCal2XML function converts an iCalcreator instance to XML format according to rfc6321, "xCal: The XML Format for iCalendar".
Requires PHP 5 and "libxml" PHP extension (--enable-libxml) and utilizes the SimpleXML extension. Before PHP 5.1.2, "--enable-simplexml" (at compile time) is required to enable this extension, after PHP 5.1.2 enabled by default.
An rfc6321 XML string is returned.
Format
iCal2XML( iCalobj )
iCalobj = (object) iCalcreator instance
The XML2iCal function, with the two entry functions: XMLstr2iCal and XMLfile2iCal, converts XML, according to rfc6321, "xCal: The XML Format for iCalendar" via an PHP SimpleXMLElement element to an iCalcreator instance.
Requires PHP 5 and "libxml" PHP extension (--enable-libxml) and utilizes the SimpleXML extension. Before PHP 5.1.2, "--enable-simplexml" (at compile time) is required to enable this extension, after PHP 5.1.2 enabled by default.
On success, an iCalcreator instance is returned.
On XML parse error, FALSE is returned and error information (if any) are redirected to PHP error log.
Format
XMLstr2iCal( xmlstr [, config] )
xmlstr = (string) rfc6321 XML config = (array) iCalcreator config array (opt)
Format
XMLfile2iCal( xmlfile [, config] )
xmlfile = (string) rfc6321 XML file name or resource config = (array) iCalcreator config array (opt)
Format
XML2iCal( xmlobj [, config] )
xmlobj = (object) SimpleXML element instance config = (array) iCalcreator config array (opt)
Additional functions to use with vtimezone components.
The getTimezonesAsDateArrays function creates time zone transition information, based on vtimezone components contents in a iCalcreator calendar instance.
The getTzOffsetForDate function returns UTC offset information for specific date (timestamp) based on output from getTimezonesAsDateArrays function.
Before calling the functions getTzOffsetForDate and getTimezonesAsDateArrays, set time zone 'GMT' ('date_default_timezone_set')!
The getTzOffsetForDate function returns UTC offset information for specific date (timezone) based on output from getTimezonesAsDateArrays function.
Before calling the function, set time zone 'GMT' ('date_default_timezone_set')!
Returns array, time zone data for specific date (timestamp) with keys for
Format
getTzOffsetForDate( timezonesarray, tzid, timestamp )
timezonesarray = (array) output from getTimezonesAsDateArrays, below tzid = (string) time zone identifier timestamp = (mixed) the date in question (timestamp) or UTC datetime (array) ( "year" => (int) year , "month" => (int) month , "day" => (int) day , "hour" => (int) hour , "min" => (int) min , "sec" => (int) sec )
The function creates time zone transition information, based on vtimezone component contents in a iCalcreator calendar instance, using sub-function expandTimezoneDates.
Before calling the function, set time zone 'GMT' ('date_default_timezone_set')!
Returns an array containing time zone data from vtimezone standard/daylight instances (input to getTzOffsetForDate, above).
Format
getTimezonesAsDateArrays( iCalobj )
iCalobj= (object) iCalcreator calendar instance
iCalcreator v2.12
copyright (c) 2007-2012 Kjell-Inge Gustafsson, kigkonsult
kigkonsult.se iCalcreator
kigkonsult.se contact
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA or download it here.