You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7970 lines
351 KiB
7970 lines
351 KiB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
|
|
<html>
|
|
<head>
|
|
<title>iCalcreator 2.22 manual</title>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
|
|
<meta name="author" content="Kjell-Inge Gustafsson, kigkonsult, All rights reserved">
|
|
<meta name="copyright" content="2007-2015 Kjell-Inge Gustafsson, kigkonsult">
|
|
<meta name="keywords" content="ical, calendar, calender, xcal, xml, icalender, rfc2445, rfc5545, vcalender, php, create">
|
|
<meta name="description" content="using iCalcreator v2.22">
|
|
<style type="text/css">
|
|
* {
|
|
FONT-FAMILY : "Bitstream Vera Sans", Helvetica, "Lucida Grande","Lucida Sans Unicode", Lucida, Arial, Geneva, sans-serif;
|
|
BACKGROUND-COLOR: white;
|
|
COLOR : black;
|
|
FONT-SIZE : small;
|
|
}
|
|
body {
|
|
MARGIN-LEFT : 10px;
|
|
WIDTH : 750px;
|
|
}
|
|
a.ref {
|
|
BACKGROUND-COLOR: inherit;
|
|
FONT-SIZE : 8pt;
|
|
LETTER-SPACING : 0.1em;
|
|
}
|
|
h1 {
|
|
BACKGROUND-COLOR: silver;
|
|
BORDER : thin solid black;
|
|
FONT-SIZE : x-large;
|
|
FONT-WEIGHT : bold;
|
|
DISPLAY : block;
|
|
}
|
|
h2 {
|
|
FONT-SIZE : large;
|
|
}
|
|
h3 {
|
|
FONT-SIZE : medium;
|
|
}
|
|
h4 {
|
|
FONT-SIZE : small;
|
|
FONT-WEIGHT : bold;
|
|
}
|
|
h5 {
|
|
FONT-SIZE : small;
|
|
FONT-WEIGHT : normal;
|
|
TEXT-DECORATION : underline;
|
|
}
|
|
table {
|
|
border-collapse : collapse;
|
|
width : 100%;
|
|
}
|
|
.bb {
|
|
BORDER-BOTTOM : gray dotted thin;
|
|
}
|
|
.blb {
|
|
BORDER-LEFT : gray dotted thin;
|
|
BORDER-BOTTOM : gray dotted thin;
|
|
TEXT-ALIGN : center;
|
|
}
|
|
.bl {
|
|
BORDER-LEFT : gray dotted thin;
|
|
}
|
|
.center {
|
|
TEXT-ALIGN : center;
|
|
}
|
|
p.comment {
|
|
FONT-FAMILY : monospace;
|
|
FONT-SIZE : 9pt;
|
|
FONT-WEIGHT : 500;
|
|
WHITE-SPACE : pre-wrap; /* css-3 */
|
|
WHITE-SPACE : -moz-pre-wrap; /* Mozilla, since 1999 */
|
|
WHITE-SPACE : -pre-wrap; /* Opera 4-6 */
|
|
WHITE-SPACE : -o-pre-wrap; /* Opera 7 */
|
|
WORD-WRAP : break-word; /* Internet Explorer 5.5+ */
|
|
}
|
|
span.comment {
|
|
BACKGROUND-COLOR: transparent;
|
|
FONT-FAMILY : Areal;
|
|
FONT-SIZE : 8pt;
|
|
LETTER-SPACING : 0.2em;
|
|
}
|
|
p.example {
|
|
BACKGROUND-COLOR: #DCDCDC;
|
|
font-family : monospace;
|
|
FONT-SIZE : 9pt;
|
|
LETTER-SPACING : 0.1em;
|
|
LINE-HEIGHT : 1.5em;
|
|
WHITE-SPACE : pre-wrap; /* css-3 */
|
|
WHITE-SPACE : -moz-pre-wrap; /* Mozilla, since 1999 */
|
|
WHITE-SPACE : -pre-wrap; /* Opera 4-6 */
|
|
WHITE-SPACE : -o-pre-wrap; /* Opera 7 */
|
|
WORD-WRAP : break-word; /* Internet Explorer 5.5+ */
|
|
}
|
|
p.format {
|
|
BORDER : gray dotted thin;
|
|
FONT-FAMILY : Helvetica;
|
|
FONT-SIZE : 9pt;
|
|
LETTER-SPACING : 0.2em;
|
|
LINE-HEIGHT : 2em;
|
|
WHITE-SPACE : pre-wrap; /* css-3 */
|
|
WHITE-SPACE : -moz-pre-wrap; /* Mozilla, since 1999 */
|
|
WHITE-SPACE : -pre-wrap; /* Opera 4-6 */
|
|
WHITE-SPACE : -o-pre-wrap; /* Opera 7 */
|
|
WORD-WRAP : break-word; /* Internet Explorer 5.5+ */
|
|
}
|
|
.header {
|
|
BACKGROUND-COLOR: silver;
|
|
BORDER : thin solid black;
|
|
FONT-SIZE : xx-large;
|
|
}
|
|
p.label {
|
|
FONT-FAMILY : Arial;
|
|
FONT-WEIGHT : bold;
|
|
LETTER-SPACING : 0.1em;
|
|
}
|
|
p.quotes {
|
|
BACKGROUND-COLOR: #F5F5F5;
|
|
FONT-FAMILY : Arial;
|
|
FONT-STYLE : italic;
|
|
LETTER-SPACING : 0.1em;
|
|
}
|
|
sup {
|
|
BACKGROUND-COLOR: transparent;
|
|
FONT-SIZE : x-small;
|
|
FONT-WEIGHT : bold;
|
|
VERTICAL-ALIGN : super;
|
|
}
|
|
.ref {
|
|
BACKGROUND-COLOR: transparent;
|
|
FONT-SIZE : 8pt;
|
|
LETTER-SPACING : 0.1em;
|
|
}
|
|
.top {
|
|
VERTICAL-ALIGN : top;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<a name="top"></a>
|
|
<p class="header">iCalcreator v2.22</p>
|
|
<p>
|
|
iCalcreator v2.22<br>
|
|
Copyright © 2007-2015 Kjell-Inge Gustafsson, kigkonsult, All rights reserved.<br>
|
|
<a href="http://kigkonsult.se/iCalcreator/index.php" title="kigkonsult.se/iCalcreator" target="_blank">kigkonsult.se iCalcreator</a><br>
|
|
<a href="http://kigkonsult.se/contact/index.php" title="kigkonsult.se contact" target="_blank">kigkonsult.se contact</a>
|
|
</p>
|
|
|
|
<h2>Preface</h2>
|
|
<p>
|
|
This document describes usage of iCalcreator, a <em>PHP</em> software implementation of standards <a href="#Standards">rfc5545/rfc5546 (rfc2445/rfc2446)</a> to manage iCal formatted files.
|
|
</p>
|
|
<p>
|
|
This document is provided by kigkonsult for informational purposes
|
|
and is provided on an "as is" basis without any warranties expressed or implied.
|
|
</p>
|
|
<p>
|
|
Information in this document is subject to change without notice and does
|
|
not represent a commitment on the part of kigkonsult.
|
|
The software described in this document is provided under a <a href="#Copyright_and_Licence">license agreement</a>.
|
|
The software may be used only in accordance with the terms of that <a href="#Copyright_and_Licence">license agreement</a>.
|
|
It is against the law to copy or use the software except as specifically allowed in the <a href="#Copyright_and_Licence">license agreement</a>.
|
|
</p>
|
|
<p>
|
|
It is the users responsibility to ensure the suitability of the software before using it.
|
|
In no circumstances will kigkonsult be responsible for
|
|
the use of the software's outcomes or results or any loss
|
|
or damage of data or programs as a result of using the software.
|
|
The use of the software implies acceptance of these terms.
|
|
</p>
|
|
<p>
|
|
This document makes previous versions obsolete.
|
|
</p>
|
|
<a href="#INDEX">[index]</a></a>
|
|
|
|
<a name="INTRO"></a><h1>1 INTRO</h1>
|
|
<p>
|
|
iCalcreator is a <em>PHP</em> class package managing iCal files, supporting (non-)<strong>calendar</strong>
|
|
systems and applications to process and communicate <strong>calendar</strong> information like
|
|
events, agendas, tasks, reports, totos and journaling information.
|
|
</p>
|
|
<p>
|
|
The iCal standards are <a href="#Standards">rfc5545/rfc5546 (rfc2445/rfc2446)</a>.</p>
|
|
<p>
|
|
iCalcreator features create, parse, edit and select <strong>calendar</strong> and <strong>calendar</strong> components.
|
|
</p>
|
|
<p>
|
|
The iCalcreator package, based of a <strong>calendar</strong> / components classes and with support of function classes and helper functions,
|
|
are <strong>calendar</strong> component property oriented.
|
|
For iCalcreator 2.22 version (and later), <em>PHP</em> version >= 5.3 is required.
|
|
</p>
|
|
<p>
|
|
More iCalcreator supplementary, "howto" and coding support information will be found at
|
|
kigkonsult.se iCalcreator implement examples and test <a href="http://kigkonsult.se/test/index.php" title="kigkonsult.se iCalcreator implement howto" target="_blank">pages</a>.
|
|
A strong recommendation is to have this document open in parallell when exploiting the link.
|
|
</p>
|
|
<p>
|
|
iCalcreator may support hiphop if the HDF AllDynamic option is enabled (the helper <a href="#iCal2XML">iCal2XML</a> function is excluded).
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a>
|
|
|
|
<a name="Standards"></a><h2>1.1 Standards</h2>
|
|
|
|
<h4>iCal</h4>
|
|
The <strong>iCalendar</strong> format, <strong>iCal</strong>, as described in
|
|
<dl>
|
|
<dt><a href="http://kigkonsult.se/downloads/dl.php?f=rfc5545" title="Download RFC5545 in text format" target="_blank">rfc5545</a>
|
|
<dd>"Internet Calendaring and Scheduling Core Object Specification (<strong>iCalendar</strong>)"
|
|
<dt><a href="http://kigkonsult.se/downloads/dl.php?f=rfc5546" title="Download RFC5546 in text format" target="_blank">rfc5546</a>
|
|
<dd>"iCalendar Transport-Independent Interoperability Protocol (iTIP)"<br>Scheduling Events, BusyTime, To-dos and Journal Entries
|
|
</dl>
|
|
<p class="quotes">. ..allows for the capture and exchange of information normally stored
|
|
within a calendaring and scheduling application.</p>
|
|
and
|
|
<p class="quotes">. ..is an exchange format between applications or systems.</p>
|
|
<p><a href="http://kigkonsult.se/downloads/dl.php?f=rfc5545" title="Download RFC5545 in text format" target="_blank">rfc5545</a> and
|
|
<a href="http://kigkonsult.se/downloads/dl.php?f=rfc5546" title="Download RFC5546 in text format" target="_blank">rfc5546</a>
|
|
obsoletes, respectively,
|
|
<a href="http://kigkonsult.se/downloads/dl.php?f=rfc2445" title="Download RFC2445 in text format" target="_blank">rfc2445</a> and
|
|
<a href="http://kigkonsult.se/downloads/dl.php?f=rfc2446" title="Download RFC2446 in text format" target="_blank">rfc2446</a>.
|
|
</p>
|
|
<p>
|
|
A short iCal description is found at <a href="http://en.wikipedia.org/wiki/ICalendar#Core_object" title="iCalendar From Wikipedia, the free encyclopedia" target="_blank">Wikipedia</a>. If You are not familiar with iCal, read this first!
|
|
Knowledge of <strong>calendar</strong> protocol rfc5545/rfc5546 is to recommend.
|
|
</p>
|
|
<p>
|
|
Any references to rfc2445, below, corresponds to rfc5545.
|
|
</p>
|
|
|
|
<h4>xCal</h4>
|
|
<p>iCalcreator also supports xCal (iCal xml) rfc6321, "xCal: The XML Format for <strong>iCalendar</strong>", to be downloaded from</p>
|
|
<dl>
|
|
<dt><a href="http://kigkonsult.se/downloads/dl.php?f=rfc6321" title="Download RFC6321 in text format" target="_blank">rfc6321</a>
|
|
<dd>"xCal: The XML Format for <strong>iCalendar</strong>"
|
|
</dl>
|
|
<p>
|
|
A short xCal description is found at <a href="http://en.wikipedia.org/wiki/XCal" title="xCal on Wikipedia, the free encyclopedia" target="_blank">Wikipedia</a>.
|
|
</p>
|
|
<p>
|
|
The older xCal format, as defined in "http://www.ietf.org/internet-drafts/draft-ietf-calsch-many-xcal-01.txt"
|
|
(but no longer found), still works in this version but will not be maintaned and will be removed in future versions.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a>
|
|
|
|
|
|
<a name="This_manual"></a><h2>1.2 This manual</h2>
|
|
<p>This style is used for text.</p>
|
|
<p class="format">This style is used for formats.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
This style is used for <em>PHP</em> coding examples.
|
|
<span class="comment"> // this style is used for coding comments.</span>
|
|
.. .
|
|
</p>
|
|
<p class="comment">This style is used for content details.</p>
|
|
<p class="quotes">This style is used for RFC2445/5545 quotes.</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a>
|
|
|
|
|
|
<a name="Versioning"></a><h2>1.3 Versioning</h2>
|
|
|
|
<p>The release numbering convention used is major.minor(.micro / suffix).</p>
|
|
<dl>
|
|
<dt>Major
|
|
<dd>Indicates a very large change in the core package. Rewrites or major milestones.
|
|
<dt>Minor
|
|
<dd>Significant amount of feature addition/modification.<br>odd number - development/experimental release<br> even number - production release
|
|
<dt>Micro
|
|
<dd>Primarily bug fix and maintenance number.
|
|
<dt>Suffix
|
|
<dd>rc1 for first release candidate etc.
|
|
</dl>
|
|
|
|
<p>The release plan is based on yearly releases with exception of emergency releases.</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a>
|
|
|
|
<a name="Support"></a><h2>1.4 Support</h2>
|
|
<p>
|
|
Use the kigkonsult.se standard support <a href="http://kigkonsult.se/support/index.php" title="kigkonsult.se/support" target="_blank">page</a>
|
|
exploring iCalcreator use and iCal issues.
|
|
</p>
|
|
<p>
|
|
Support and development is now focused on iCalcreator (Pro) 3.x versions, which, in turn, will affect future releases
|
|
of iCalcreator 2.x.
|
|
</p>
|
|
<p>
|
|
Use the contact <a href="http://kigkonsult.se/contact/index.php" title="kigkonsult.se/contact" target="_blank">page</a>
|
|
for queries, improvement/development issues or professional support and development.
|
|
Please note that paid support or consulting service has the highest priority.
|
|
</p>
|
|
<p>
|
|
kigkonsult offer professional services for software support, design and new/re-development, customizations and adaptations
|
|
of <em>PHP</em>/<em>MySQL</em> solutions with focus on software lifecycle management, including long term utility, reliability and maintainability.
|
|
</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a>
|
|
|
|
|
|
<a name="Donate"></a><h2>1.5 Donate</h2>
|
|
<p>
|
|
You can show your appreciation for our free software,
|
|
and can support future development by making a donation to the kigkonsult project iCalcreator.
|
|
</p>
|
|
<p>
|
|
Make a donation of any size by clicking <a href="http://kigkonsult.se/contact/index.php#Donate" title="Donate" target="_blank">here</a>.
|
|
Thanks in advance!
|
|
</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a>
|
|
|
|
<a name="INSTALL"></a><h2>1.6 Install</h2>
|
|
|
|
<p>
|
|
Unpack to any folder<br>
|
|
- add this folder to your include-path<br>
|
|
- or unpack to your application-(include)-folder
|
|
</p>
|
|
<p>Add</p>
|
|
<p class="format">require_once "[path/]iCalcreator-<version>/iCalcreator.php";</p>
|
|
<p>to your <em>PHP</em>-script.
|
|
The iCalcreator invoke has changed since previous version!
|
|
You may also need to set the default timezone.
|
|
</p>
|
|
<p>
|
|
</p>
|
|
<p>
|
|
Creating a new iCalcreator object instance/component instance, review <a href="#iCalcreator_configuration_methods">config</a> settings.
|
|
</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a>
|
|
|
|
|
|
<a name="Additional_Descriptors"></a><h2>1.7 Additional Descriptors</h2>
|
|
<p>The following properties (as described in <a href="http://en.wikipedia.org/wiki/ICalendar#Calendar_extensions" title="http://en.wikipedia.org/wiki/ICalendar#Calendar_extensions" target="_blank">wikipedia:iCal</a>)
|
|
may be required when importing iCal files into some calendaring software (MS etc.):</p>
|
|
<dl>
|
|
<dt>on <strong>calendar</strong> level
|
|
<dd><a href="#METHOD">METHOD</a> property (value PUBLISH etc.)
|
|
<dd><a href="#X-PROPERTY">X-WR-CALNAME</a> x-property
|
|
<dd><a href="#X-PROPERTY">X-WR-CALDESC</a> x-property
|
|
<dd><a href="#X-PROPERTY">X-WR-RELCALID</a> x-property <span class="comment">(Read more info about <a href="http://en.wikipedia.org/wiki/Universally_Unique_Identifier" title="Universally Unique Identifier">UUID</a>.)</span>
|
|
<dd><a href="#X-PROPERTY">X-WR-TIMEZONE</a> x-property
|
|
<dt>on component level
|
|
<dd><a href="#DTSTAMP">DTSTAMP</a> property (in iCalcreator created automatically, if not set)
|
|
<dd><a href="#UID">UID</a> property (in iCalcreator created automatically, if not set)
|
|
<dt>on component level in a <a href="#VTIMEZONE">vtimezone</a> component
|
|
<dd><a href="#X-PROPERTY">X-LIC-LOCATION</a> x-property
|
|
</dl>
|
|
<p class="label">Example</p>
|
|
<p>
|
|
A strong recommendation is also to set config <a href="#Unique_id">unique_id</a>, creating a new vcalendar/component instance,
|
|
to ensure accurate setting of all components <a href="#UID">UID</a> property, especially before <a href="#parse_merge">parse</a>.
|
|
Also setting of config timezone ("TZID" and "X-WR-TIMEZONE" below) is to recommend.
|
|
</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$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" );
|
|
.. .
|
|
</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a>
|
|
|
|
|
|
<a name="Addendum"></a><h2>1.8 Addendum</h2>
|
|
<p>
|
|
For iCalcreator usage, coding samples and tests, visit the public kigkonsult.se
|
|
<a title="iCalcreator coding and test pages" href="http://kigkonsult.se/test/index.php" target="_blank">test</a> resource.
|
|
</p>
|
|
<dl>
|
|
<dt>Examples how to employ iCalcreator in software development
|
|
<dd><a title="dbiCal" href="http://kigkonsult.se/dbiCal/index.php" target="_blank">dbiCal</a>, an iCal file <i>PHP</i> database backend solution.
|
|
<dd><a title="Create iCal event file on-demand from form" href="http://kigkonsult.se/eventCreator/index.php" target="_blank">The iCal file event editor</a>
|
|
<dd><a title="tinycal" href="http://kigkonsult.se/tinycal/index.php" target="_blank">tinycal</a>, <strong>calendar</strong>-in-a-box.
|
|
</dl>
|
|
<p>
|
|
There are free iCal/xCal icons (use as buttons on a web page?) to download
|
|
<a href="http://kigkonsult.se/downloads/i.php?i=all" title="iCal images" target="_blank">here</a>.
|
|
</p>
|
|
<p>
|
|
The <em>PHP</em> 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;
|
|
</p>
|
|
<dl>
|
|
<dd><a href="http://www.php-fig.org/psr/psr-1/" target="_blank">PHP Framework Interop Group Basic Coding Standard</a>
|
|
<!-- dd><a href="http://www.dagbladet.no/development/phpcodingstandard/" target="_blank">http://www.dagbladet.no/development/phpcodingstandard/</a -->
|
|
<!-- dd><a href="http://ez.no/ezpublish/documentation/development/standards/php" target="_blank">http://ez.no/ezpublish/documentation/development/standards/php</a> -->
|
|
<!-- <a href="http://gforge.org/docman/view.php/1/2/coding-standards.html" target="_blank">http://gforge.org/docman/view.php/1/2/coding-standards.html</a> -->
|
|
<dd><a href="http://pear.php.net/manual/en/standards.php" target="_blank"> pear Coding standards</a>
|
|
<dd><a href="http://make.wordpress.org/core/handbook/coding-standards/php/" target="_blank">WordPress PHP Coding Standards</a>
|
|
<dd><a href="http://framework.zend.com/manual/1.10/en/coding-standard.html" target="_blank">Zend Framework Coding Standard</a>
|
|
</dl>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a>
|
|
|
|
|
|
<a name="INDEX"></a><h2>1.9 INDEX</h2>
|
|
|
|
<a href="#INTRO">1 INTRO</a><br>
|
|
<br>
|
|
<a href="#Standards">1.1 Standards</a><br>
|
|
<a href="#This_manual">1.2 This manual</a><br>
|
|
<a href="#Versioning">1.3 Versioning</a><br>
|
|
<a href="#Support">1.4 Support</a><br>
|
|
<a href="#Donate">1.5 Donate</a><br>
|
|
<a href="#INSTALL">1.6 Install</a><br>
|
|
<a href="#Additional_Descriptors">1.7 Additional_Descriptors</a><br>
|
|
<a href="#Addendum">1.8 Addendum</a><br>
|
|
<a href="#INDEX">1.9 INDEX</a><br>
|
|
<br>
|
|
<a href="#Calendar_Component_list">2 Calendar Component list</a><br>
|
|
<br>
|
|
<a href="#VCALENDAR">2.1 VCALENDAR</a><br>
|
|
<a href="#VEVENT">2.2 VEVENT</a><br>
|
|
<a href="#VTODO">2.3 VTODO</a><br>
|
|
<a href="#VJOURNAL">2.4 VJOURNAL</a><br>
|
|
<a href="#VFREEBUSY">2.5 VFREEBUSY</a><br>
|
|
<a href="#VALARM">2.6 VALARM</a><br>
|
|
<a href="#VTIMEZONE">2.7 VTIMEZONE</a><br>
|
|
<a href="#CalProps">2.8 Component Properties</a><br>
|
|
<br>
|
|
<a href="#Function_list">3 Function list</a><br>
|
|
<br>
|
|
<a href="#iCalcreator_object_methods">3.1 iCalcreator object methods</a><br>
|
|
<br>
|
|
<a href="#Calendar_object_constructors">3.1.1 Constructors</a><br>
|
|
<a href="#vcalendar_constr">3.1.1.1 vcalendar</a><br>
|
|
<a href="#vevent_constr">3.1.1.2 vevent</a><br>
|
|
<a href="#vtodo_constr">3.1.1.3 vtodo</a><br>
|
|
<a href="#vjournal_constr">3.1.1.4 vjournal</a><br>
|
|
<a href="#vfreebusy_constr">3.1.1.5 vfreebusy</a><br>
|
|
<a href="#valarm_constr">3.1.1.6 valarm</a><br>
|
|
<a href="#vtimezone_constr">3.1.1.7 vtimezone</a><br>
|
|
<a href="#standard_constr">3.1.1.8 standard</a><br>
|
|
<a href="#daylight_constr">3.1.1.9 daylight</a><br>
|
|
<br>
|
|
<a href="#iCalcreator_object_property_methods">3.1.2 iCalcreator object property methods</a><br>
|
|
<a href="#deleteProperty">3.1.2.1 deleteProperty</a><br>
|
|
<a href="#getProperty">3.1.2.2 getProperty</a><br>
|
|
<a href="#setProperty">3.1.2.3 setProperty</a><br>
|
|
<a href="#CALSCALE">3.1.2.4 CALSCALE</a><br>
|
|
<a href="#METHOD">3.1.2.5 METHOD</a><br>
|
|
<a href="#VERSION">3.1.2.6 VERSION</a><br>
|
|
<a href="#X-PROPERTY">3.1.2.7 X-PROPERTY</a><br>
|
|
<br>
|
|
<a href="#iCalcreator_component_object_methods">3.1.3 iCalcreator component object methods</a><br>
|
|
<a href="#deleteComponent">3.1.3.1 deleteComponent</a><br>
|
|
<a href="#getComponent">3.1.3.2 getComponent</a><br>
|
|
<a href="#newComponent">3.1.3.3 newComponent</a><br>
|
|
<a href="#replaceComponent">3.1.3.4 replaceComponent</a><br>
|
|
<a href="#selectComponents">3.1.3.5 selectComponents</a><br>
|
|
<a href="#setComponent">3.1.3.6 setComponent</a><br>
|
|
<br>
|
|
<a href="#iCalcreator_calendar_methods">3.1.4 iCalcreator calendar methods</a><br>
|
|
<a href="#parse_merge">3.1.4.1 parse and merge</a><br>
|
|
<a href="#createCalendar">3.1.4.2 createCalendar</a><br>
|
|
<a href="#returnCalendar">3.1.4.3 returnCalendar</a><br>
|
|
<a href="#saveCalendar">3.1.4.4 saveCalendar</a><br>
|
|
<a href="#sort">3.1.4.5 sort</a><br>
|
|
<a href="#useCachedCalendar">3.1.4.6 useCachedCalendar</a><br>
|
|
<a href="#iCalcreatorVersion">3.1.4.7 iCalcreatorVersion</a><br>
|
|
<br>
|
|
<a href="#iCalcreator_configuration_methods">3.1.5 iCalcreator configuration methods</a><br>
|
|
<a href="#configKeys">3.1.5.1 configuration keys</a><br>
|
|
<a href="#getConfig">3.1.5.2 getConfig</a><br>
|
|
<a href="#initConfig">3.1.5.3 calendar/component initialization</a><br>
|
|
<a href="#setConfig">3.1.5.4 setConfig</a><br>
|
|
<a href="#allowEmpty">3.1.5.5 Allow empty components</a><br>
|
|
<a href="#Compsinfo">3.1.5.6 Component information</a><br>
|
|
<a href="#Delimiter">3.1.5.7 Delimiter</a><br>
|
|
<a href="#Directory">3.1.5.8 Directory</a><br>
|
|
<a href="#Dirfile">3.1.5.9 Dirfile</a><br>
|
|
<a href="#Fileinfo">3.1.5.10 Fileinfo</a><br>
|
|
<a href="#Filename">3.1.5.11 Filename</a><br>
|
|
<a href="#Filesize">3.1.5.12 Filesize</a><br>
|
|
<a href="#Format">3.1.5.13 Format</a><br>
|
|
<a href="#Language">3.1.5.14 Language</a><br>
|
|
<a href="#NewlineChar">3.1.5.15 NewlineChar</a><br>
|
|
<a href="#setPropertyNames">3.1.5.16 setPropertyNames</a><br>
|
|
<a href="#dTZID">3.1.5.17 TZID</a><br>
|
|
<a href="#Unique_id">3.1.5.18 Unique_id</a><br>
|
|
<a href="#configURL">3.1.5.19 URL</a><br>
|
|
<br>
|
|
<a href="#Calendar_component_object_property_function_list">3.2 Calendar component property method list</a><br>
|
|
<br>
|
|
<a href="#deleteProperty_PROP">3.2.1 deleteProperty</a><br>
|
|
<a href="#getProperty_PROP">3.2.2 getProperty</a><br>
|
|
<a href="#parse">3.2.3 parse</a><br>
|
|
<a href="#setProperty_PROP">3.2.4 setProperty</a><br>
|
|
<dl>
|
|
<dt>Ascending property order
|
|
<dd><a href="#ACTION">3.2.5 ACTION</a>
|
|
<dd><a href="#ATTACH">3.2.6 ATTACH</a>
|
|
<dd><a href="#ATTENDEE">3.2.7 ATTENDEE</a>
|
|
<dd><a href="#CATEGORIES">3.2.8 CATEGORIES</a>
|
|
<dd><a href="#CLASS">3.2.9 CLASS</a>
|
|
<dd><a href="#COMMENT">3.2.10 COMMENT</a>
|
|
<dd><a href="#COMPLETED">3.2.11 COMPLETED</a>
|
|
<dd><a href="#CONTACT">3.2.12 CONTACT</a>
|
|
<dd><a href="#CREATED">3.2.13 CREATED</a>
|
|
<dd><a href="#DESCRIPTION">3.2.14 DESCRIPTION</a>
|
|
<dd><a href="#DTEND">3.2.15 DTEND</a>
|
|
<dd><a href="#DTSTAMP">3.2.16 DTSTAMP</a>
|
|
<dd><a href="#DTSTART">3.2.17 DTSTART</a>
|
|
<dd><a href="#DUE">3.2.18 DUE</a>
|
|
<dd><a href="#DURATION">3.2.19 DURATION</a>
|
|
<dd><a href="#EXDATE">3.2.20 EXDATE</a>
|
|
<dd><a href="#EXRULE">3.2.21 EXRULE</a>
|
|
<dd><a href="#FREEBUSY_PROP">3.2.22 FREEBUSY</a>
|
|
<dd><a href="#GEO">3.2.23 GEO</a>
|
|
<dd><a href="#LAST-MODIFIED">3.2.24 LAST-MODIFIED</a>
|
|
<dd><a href="#LOCATION">3.2.25 LOCATION</a>
|
|
<dd><a href="#ORGANIZER">3.2.26 ORGANIZER</a>
|
|
<dd><a href="#PERCENT-COMPLETE">3.2.27 PERCENT-COMPLETE</a>
|
|
<dd><a href="#PRIORITY">3.2.28 PRIORITY</a>
|
|
<dd><a href="#RDATE">3.2.29 RDATE</a>
|
|
<dd><a href="#RECURRENCE-ID">3.2.30 RECURRENCE-ID</a>
|
|
<dd><a href="#RELATED-TO">3.2.31 RELATED-TO</a>
|
|
<dd><a href="#REPEAT">3.2.32 REPEAT</a>
|
|
<dd><a href="#REQUEST-STATUS">3.2.33 REQUEST-STATUS</a>
|
|
<dd><a href="#RESOURCES">3.2.34 RESOURCES</a>
|
|
<dd><a href="#RRULE">3.2.35 RRULE</a>
|
|
<dd><a href="#SEQUENCE">3.2.36 SEQUENCE</a>
|
|
<dd><a href="#STATUS">3.2.37 STATUS</a>
|
|
<dd><a href="#SUMMARY">3.2.38 SUMMARY</a>
|
|
<dd><a href="#TRANSP">3.2.39 TRANSP</a>
|
|
<dd><a href="#TRIGGER">3.2.40 TRIGGER</a>
|
|
<dd><a href="#TZID">3.2.41 TZID</a>
|
|
<dd><a href="#TZNAME">3.2.42 TZNAME</a>
|
|
<dd><a href="#TZOFFSETFROM">3.2.43 TZOFFSETFROM</a>
|
|
<dd><a href="#TZOFFSETTO">3.2.44 TZOFFSETTO</a>
|
|
<dd><a href="#TZURL">3.2.45 TZURL</a>
|
|
<dd><a href="#UID">3.2.46 UID</a>
|
|
<dd><a href="#URL">3.2.47 URL</a>
|
|
<dd><a href="#X-PROPERTY_PROP">3.2.48 X-PROPERTY</a>
|
|
<dt>Descriptive Component Properties
|
|
<dd><a href="#ATTACH">3.2.6 ATTACH</a>
|
|
<dd><a href="#CATEGORIES">3.2.8 CATEGORIES</a>
|
|
<dd><a href="#COMMENT">3.2.10 COMMENT</a>
|
|
<dd><a href="#DESCRIPTION">3.2.14 DESCRIPTION</a>
|
|
<dd><a href="#GEO">3.2.23 GEO</a>
|
|
<dd><a href="#LOCATION">3.2.25 LOCATION</a>
|
|
<dd><a href="#PERCENT-COMPLETE">3.2.27 PERCENT-COMPLETE</a>
|
|
<dd><a href="#PRIORITY">3.2.28 PRIORITY</a>
|
|
<dd><a href="#RESOURCES">3.2.34 RESOURCES</a>
|
|
<dd><a href="#STATUS">3.2.37 STATUS</a>
|
|
<dd><a href="#SUMMARY">3.2.38 SUMMARY</a>
|
|
<dt>Date and Time Component Properties
|
|
<dd><a href="#COMPLETED">3.2.11 COMPLETED</a>
|
|
<dd><a href="#DTEND">3.2.15 DTEND</a>
|
|
<dd><a href="#DUE">3.2.18 DUE</a>
|
|
<dd><a href="#DTSTART">3.2.17 DTSTART</a>
|
|
<dd><a href="#DURATION">3.2.19 DURATION</a>
|
|
<dd><a href="#FREEBUSY_PROP">3.2.22 FREEBUSY</a>
|
|
<dd><a href="#TRANSP">3.2.39 TRANSP</a>
|
|
<dt>Time Zone Component Properties
|
|
<dd><a href="#TZID">3.2.41 TZID</a>
|
|
<dd><a href="#TZNAME">3.2.42 TZNAME</a>
|
|
<dd><a href="#TZOFFSETFROM">3.2.43 TZOFFSETFROM</a>
|
|
<dd><a href="#TZOFFSETTO">3.2.44 TZOFFSETTO</a>
|
|
<dd><a href="#TZURL">3.2.45 TZURL</a>
|
|
<dt>Relationship Component Properties
|
|
<dd><a href="#ATTENDEE">3.2.7 ATTENDEE</a>
|
|
<dd><a href="#CONTACT">3.2.12 CONTACT</a>
|
|
<dd><a href="#ORGANIZER">3.2.26 ORGANIZER</a>
|
|
<dd><a href="#RECURRENCE-ID">3.2.30 RECURRENCE-ID</a>
|
|
<dd><a href="#RELATED-TO">3.2.31 RELATED-TO</a>
|
|
<dd><a href="#URL">3.2.47 URL</a>
|
|
<dd><a href="#UID">3.2.46 UID</a>
|
|
<dt>Recurrence Component Properties
|
|
<dd><a href="#EXDATE">3.2.20 EXDATE</a>
|
|
<dd><a href="#RDATE">3.2.29 RDATE</a>
|
|
<dd><a href="#RRULE">3.2.35 RRULE</a>
|
|
<dt>Alarm Component Properties
|
|
<dd><a href="#ACTION">3.2.5 ACTION</a>
|
|
<dd><a href="#REPEAT">3.2.32 REPEAT</a>
|
|
<dd><a href="#TRIGGER">3.2.40 TRIGGER</a>
|
|
<dt>Change Management Component Properties
|
|
<dd><a href="#CREATED">3.2.13 CREATED</a>
|
|
<dd><a href="#DTSTAMP">3.2.16 DTSTAMP</a>
|
|
<dd><a href="#LAST-MODIFIED">3.2.24 LAST-MODIFIED</a>
|
|
<dd><a href="#SEQUENCE">3.2.36 SEQUENCE</a>
|
|
<dt>Miscellaneous Component Properties
|
|
<dd><a href="#X-PROPERTY_PROP">3.2.48 X-PROPERTY</a>
|
|
<dd><a href="#REQUEST-STATUS">3.2.33 REQUEST-STATUS</a>
|
|
</dl>
|
|
<a href="#iCalcreator_component_configuration_methods">3.3 iCalcreator Component configuration methods</a><br>
|
|
<br>
|
|
<a href="#Language_PROP">3.3.1 Language</a><br>
|
|
<br>
|
|
<a href="#iCalcreator_component_object_misc_methods">3.4 iCalcreator component object misc. methods</a><br>
|
|
<br>
|
|
<a href="#deleteComponent_PROP">3.4.1 deleteComponent</a><br>
|
|
<a href="#getComponent_PROP">3.4.2 getComponent</a><br>
|
|
<a href="#newComponent_PROP">3.4.3 newComponent</a><br>
|
|
<a href="#setComponent_PROP">3.4.4 setComponent</a><br>
|
|
<br>
|
|
<a href="#iCalUtilityFunctions">4 iCalUtilityFunctions</a><br>
|
|
<br>
|
|
<a href="#convEolChar">4.1 convEolChar</a><br>
|
|
<a href="#createTimezone">4.2 createTimezone</a><br>
|
|
<a href="#ms2phpTZ">4.3 ms2phpTZ</a><br>
|
|
<a href="#transformDateTime">4.4 transformDateTime</a><br>
|
|
<a href="#mddtuf">4.5 Misc. date/duration/timestamp util. functions</a><br>
|
|
<br>
|
|
<a href="#helperFunctions">5 Helper functions</a><br>
|
|
<br>
|
|
<a href="#XMLhelpers">5.1 iCal and XML helper functions</a><br>
|
|
<br>
|
|
<a href="#iCal2XML">5.1.1 iCal2XML</a><br>
|
|
<a href="#XML2iCal">5.1.2 XML2iCal</a><br>
|
|
<br>
|
|
<a href="#vCardhelpers">5.2 iCal and vCard helper functions</a><br>
|
|
<br>
|
|
<a href="#iCal2vCard">5.2.1 iCal2vCard</a><br>
|
|
<a href="#iCal2vCards">5.2.2 iCal2vCards</a><br>
|
|
<br>
|
|
<br>
|
|
<a href="#TZhelpers">5.3 Time zone helper functions</a><br>
|
|
<br>
|
|
<a href="#getTzOffsetForDate">5.3.1 getTzOffsetForDate</a><br>
|
|
<a href="#getTimezonesAsDateArrays">5.3.2 getTimezonesAsDateArrays</a><br>
|
|
<br>
|
|
<a href="#Copyright_and_Licence">6 COPYRIGHT AND LICENSE</a><br>
|
|
<br>
|
|
<a href="#Copyright">6.1 Copyright</a><br>
|
|
<a href="#Licence">6.2 License</a><br>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a>
|
|
|
|
<a name="Calendar_Component_list"></a><h1>2 Calendar Component list</h1>
|
|
<p>
|
|
Quote from <a href="http://kigkonsult.se/downloads/dl.php?f=rfc2445" title="RFC2445" target="_blank">RFC2445</a> - Internet Calendaring and Scheduling Core Object Specification (<strong>iCalendar</strong>)!
|
|
(Described in iCal output format, content corresponds to xCal format.)
|
|
</p>
|
|
<a name="VCALENDAR"></a><h2>2.1 VCALENDAR</h2>
|
|
<p class="center">icalobject = 1*("BEGIN" ":" "VCALENDAR" CRLF</p>
|
|
<p class="center">icalbody</p>
|
|
<p class="center">"END" ":" "VCALENDAR" CRLF)</p>
|
|
<p>icalbody = calprops component</p>
|
|
<p>calprops = 2*(</p>
|
|
<p class="center">"prodid" and "version" are both REQUIRED, but MUST NOT occur more than once
|
|
<p class="center">prodid / <a href="#VERSION">version</a> /</p>
|
|
<p class="center">"calscale"and "method"are optional, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#CALSCALE">calscale</a> / <a href="#METHOD">method</a> /</p>
|
|
<p class="center"><a href="#X-PROPERTY">x-prop</a></p>
|
|
<p>)</p>
|
|
<p class="center">component = 1*(<a href="#VEVENT">eventc</a> / <a href="#VTODO">todoc</a> / <a href="#VJOURNAL">journalc</a> / <a href="#VFREEBUSY">freebusyc</a> / <a href="#VTIMEZONE">timezonec</a> / iana-comp* / x-comp*)</p>
|
|
<p class="center">iana-comp = "BEGIN" ":" iana-token CRLF</p>
|
|
<p class="center">1*contentline</p>
|
|
<p class="center">"END" ":" iana-token CRLF</p>
|
|
<p class="center">x-comp = "BEGIN" ":" x-name CRLF</p>
|
|
<p class="center">1*contentline</p>
|
|
<p class="center">"END" ":" x-name CRLF</p>
|
|
<p>*) <span class="comment">not supported by iCalcreator</span></p>
|
|
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_Component_list">[up]</a>
|
|
|
|
<a name="VEVENT"></a><h2>2.2 VEVENT</h2>
|
|
<p class="center">"BEGIN" ":" "VEVENT" CRLF</p>
|
|
<p class="center">eventprop *alarmc</p>
|
|
<p class="center">"END" ":" "VEVENT" CRLF</p>
|
|
<p>eventprop = *(</p>
|
|
<p class="center">the following are optional,but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#CLASS">class</a> / <a href="#CREATED">created</a> / <a href="#DESCRIPTION">description</a> / <a href="#DTSTART">dtstart</a> /</p>
|
|
<p class="center"><a href="#GEO">geo</a> / <a href="#LAST-MODIFIED">last-mod</a> / <a href="#LOCATION">location</a> / <a href="#ORGANIZER">organizer</a> / <a href="#PRIORITY">priority</a> / </p>
|
|
<p class="center"><a href="#DTSTAMP">dtstamp</a> / <a href="#SEQUENCE">seq</a> / <a href="#STATUS">status</a> / <a href="#SUMMARY">summary</a> / </p>
|
|
<p class="center"><a href="#TRANSP">transp</a> / <a href="#UID">uid</a> / <a href="#URL">url</a> / <a href="#RECURRENCE-ID">recurid</a> /</p>
|
|
<p class="center">either "<a href="#DTEND">dtend</a>" or "<a href="#DURATION">duration</a>" may appear in a "eventprop", </p>
|
|
<p class="center">but "<a href="#DTEND">dtend</a>" and "<a href="#DURATION">duration</a>" MUST NOT occur in the same "eventprop"</p>
|
|
<p class="center"><a href="#DTEND">dtend</a> / <a href="#DURATION">duration</a> /</p>
|
|
<p class="center">the following are optional, and MAY occur more than once</p>
|
|
<p class="center"><a href="#ATTACH">attach</a> / <a href="#ATTENDEE">attendee</a> / <a href="#CATEGORIES">categories</a> / <a href="#COMMENT">comment</a> / </p>
|
|
<p class="center"><a href="#CONTACT">contact</a> / <a href="#EXDATE">exdate</a> / <a href="#EXRULE">exrule</a> / <a href="#REQUEST-STATUS">rstatus</a> / </p>
|
|
<p class="center"><a href="#RELATED-TO">related</a> / <a href="#RESOURCES">resources</a> / <a href="#RDATE">rdate</a> / <a href="#RRULE">rrule</a> / <a href="#X-PROPERTY_PROP">x-prop</a></p>
|
|
<p>)</p>
|
|
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_Component_list">[up]</a>
|
|
|
|
<a name="VTODO"></a><h2>2.3 VTODO</h2>
|
|
<p class="center">"BEGIN" ":" "VTODO" CRLF</p>
|
|
<p class="center">todoprop *alarmc</p>
|
|
<p class="center">"END" ":" "VTODO" CRLF</p>
|
|
<p>todoprop = *(</p>
|
|
<p class="center">the following are optional, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#CLASS">class</a> / <a href="#COMPLETED">completed</a> / <a href="#CREATED">created</a> / <a href="#DESCRIPTION">description</a> / <a href="#DTSTAMP">dtstamp</a> / <a href="#DTSTART">dtstart</a> / </p>
|
|
<p class="center"><a href="#GEO">geo</a> / <a href="#LAST-MODIFIED">last-mod</a> / <a href="#LOCATION">location</a> / <a href="#ORGANIZER">organizer</a> / <a href="#PERCENT-COMPLETE">percent</a> / <a href="#PRIORITY">priority</a> / </p>
|
|
<p class="center"><a href="#RECURRENCE-ID">recurid</a> / <a href="#SEQUENCE">seq</a> / <a href="#STATUS">status</a> / <a href="#SUMMARY">summary</a> /<a href="#UID">uid</a> / <a href="#URL">url</a> /</p>
|
|
<p class="center">either "<a href="#DUE">due</a>" or "<a href="#DURATION">duration</a>" may appear in a "todoprop",</p>
|
|
<p class="center"> but "<a href="#DUE">due</a>" and "<a href="#DURATION">duration</a>" MUST NOT occur in the same "todoprop"</p>
|
|
<p class="center"><a href="#DUE">due</a> / <a href="#DURATION">duration</a> /</p>
|
|
<p class="center">the following are optional,and MAY occur more than once</p>
|
|
<p class="center"><a href="#ATTACH">attach</a> / <a href="#ATTENDEE">attendee</a> / <a href="#CATEGORIES">categories</a> / <a href="#COMMENT">comment</a> / </p>
|
|
<p class="center"><a href="#CONTACT">contact</a> / <a href="#EXDATE">exdate</a> / <a href="#EXRULE">exrule</a> / <a href="#REQUEST-STATUS">rstatus</a> / </p>
|
|
<p class="center"><a href="#RELATED-TO">related</a> / <a href="#RESOURCES">resources</a> / <a href="#RDATE">rdate</a> / <a href="#RRULE">rrule</a> / <a href="#X-PROPERTY_PROP">x-prop</a></p>
|
|
<p>)</p>
|
|
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_Component_list">[up]</a>
|
|
|
|
<a name="VJOURNAL"></a><h2>2.4 VJOURNAL</h2>
|
|
<p class="center">journalc = "BEGIN" ":" "VJOURNAL" CRLF</p>
|
|
<p class="center">jourprop</p>
|
|
<p class="center">"END" ":" "VJOURNAL" CRLF</p>
|
|
<p>jourprop = *(</p>
|
|
<p class="center">the following are optional, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#CLASS">class</a> / <a href="#CREATED">created</a> / <a href="#DESCRIPTION">description</a> / <a href="#DTSTART">dtstart</a> / </p>
|
|
<p class="center"><a href="#DTSTAMP">dtstamp</a> / <a href="#LAST-MODIFIED">last-mod</a> / <a href="#ORGANIZER">organizer</a> / <a href="#RECURRENCE-ID">recurid</a> / </p>
|
|
<p class="center"><a href="#SEQUENCE">seq</a> / <a href="#STATUS">status</a> / <a href="#SUMMARY">summary</a> /<a href="#UID">uid</a> / <a href="#URL">url</a> /</p>
|
|
<p class="center">the following are optional,and MAY occur more than once</p>
|
|
<p class="center"><a href="#ATTACH">attach</a> / <a href="#ATTENDEE">attendee</a> / <a href="#CATEGORIES">categories</a> / <a href="#COMMENT">comment</a> /</p>
|
|
<p class="center"><a href="#CONTACT">contact</a> / <a href="#EXDATE">exdate</a> / <a href="#EXRULE">exrule</a> / <a href="#RELATED-TO">related</a> / </p>
|
|
<p class="center"><a href="#RDATE">rdate</a> / <a href="#RRULE">rrule</a> / <a href="#REQUEST-STATUS">rstatus</a> / <a href="#X-PROPERTY_PROP">x-prop</a></p>
|
|
<p>)</p>
|
|
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_Component_list">[up]</a>
|
|
|
|
<a name="VFREEBUSY"></a><h2>2.5 VFREEBUSY</h2>
|
|
<p class="center">"BEGIN" ":" "VFREEBUSY" CRLF</p>
|
|
<p class="center">fbprop</p>
|
|
<p class="center">"END" ":" "VFREEBUSY" CRLF</p>
|
|
<p>fbprop = *(</p>
|
|
<p class="center">the following are optional, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#CONTACT">contact</a> / <a href="#DTSTART">dtstart</a> / <a href="#DTEND">dtend</a> / <a href="#DURATION">duration</a> / </p>
|
|
<p class="center"><a href="#DTSTAMP">dtstamp</a> / <a href="#ORGANIZER">organizer</a> / <a href="#UID">uid</a> / <a href="#URL">url</a> / </p>
|
|
<p class="center">the following are optional,and MAY occur more than once</p>
|
|
<p class="center"><a href="#ATTENDEE">attendee</a> / <a href="#COMMENT">comment</a> / <a href="#FREEBUSY_PROP">freebusy</a> / <a href="#REQUEST-STATUS">rstatus</a> / <a href="#X-PROPERTY_PROP">x-prop</a></p>
|
|
<p>)</p>
|
|
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_Component_list">[up]</a>
|
|
|
|
<a name="VALARM"></a><h2>2.6 VALARM</h2>
|
|
<p class="center">"BEGIN" ":" "VALARM" CRLF</p>
|
|
<p class="center">(audioprop / dispprop / emailprop / procprop)</p>
|
|
<p class="center">"END" ":" "VALARM" CRLF</p>
|
|
<p>audioprop = 2*(</p>
|
|
<p class="center">"<a href="#ACTION">action</a>" and "<a href="#TRIGGER">trigger</a>" are both REQUIRED, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#ACTION">action</a> / <a href="#TRIGGER">trigger</a> /</p>
|
|
<p class="center">"<a href="#DURATION">duration</a>" and "<a href="#REPEAT">repeat</a>" are both optional,and MUST NOT occur more than once each,</p>
|
|
<p class="center">but if one occurs, so MUST the other</p>
|
|
<p class="center"><a href="#DURATION">duration</a> / <a href="#REPEAT">repeat</a> /</p>
|
|
<p class="center">the following is optional, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#ATTACH">attach</a> / </p>
|
|
<p class="center">the following is optional, and MAY occur more than once</p>
|
|
<p class="center"><a href="#X-PROPERTY_PROP">x-prop</a></p>
|
|
<p>)</p>
|
|
|
|
<p>dispprop = 3*(</p>
|
|
<p class="center">the following are all REQUIRED, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#ACTION">action</a> / <a href="#DESCRIPTION">description</a> / <a href="#TRIGGER">trigger</a> /</p>
|
|
<p class="center">"<a href="#DURATION">duration</a>" and "<a href="#REPEAT">repeat</a>" are both optional,and MUST NOT occur more than once each,</p>
|
|
<p class="center">but if one occurs, so MUST the other</p>
|
|
<p class="center"><a href="#DURATION">duration</a> / <a href="#REPEAT">repeat</a> /</p>
|
|
<p class="center">the following is optional, and MAY occur more than once</p>
|
|
<p class="center"><a href="#X-PROPERTY_PROP">x-prop</a></p>
|
|
<p>)</p>
|
|
|
|
<p>emailprop = 5*(</p>
|
|
<p class="center">the following are all REQUIRED, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#ACTION">action</a> / <a href="#DESCRIPTION">description</a> / <a href="#TRIGGER">trigger</a> / <a href="#SUMMARY">summary</a></p>
|
|
<p class="center">the following is REQUIRED, and MAY occur more than once</p>
|
|
<p class="center"><a href="#ATTENDEE">attendee</a> / </p>
|
|
<p class="center">"<a href="#DURATION">duration</a>" and "<a href="#REPEAT">repeat</a>" are both optional, and MUST NOT occur more than once each,</p>
|
|
<p class="center">but if one occurs, so MUST the other</p>
|
|
<p class="center"><a href="#DURATION">duration</a> / <a href="#REPEAT">repeat</a> /</p>
|
|
<p class="center">the following are optional, and MAY occur more than once</p>
|
|
<p class="center"><a href="#ATTACH">attach</a> / <a href="#X-PROPERTY_PROP">x-prop</a></p>
|
|
<p>)</p>
|
|
|
|
<p>procprop = 3*(</p>
|
|
<p class="center">the following are all REQUIRED, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#ACTION">action</a> / <a href="#ATTACH">attach</a> / <a href="#TRIGGER">trigger</a> /</p>
|
|
<p class="center">"<a href="#DURATION">duration</a>" and "<a href="#REPEAT">repeat</a>" are both optional, and MUST NOT occur more than once each,</p>
|
|
<p class="center">but if one occurs, so MUST the other</p>
|
|
<p class="center"><a href="#DURATION">duration</a> /
|
|
<a href="#REPEAT">repeat</a> /</p>
|
|
<p class="center">"<a href="#DESCRIPTION">description</a>" is optional, and MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#DESCRIPTION">description</a> / </p>
|
|
<p class="center">the following is optional, and MAY occur more than once</p>
|
|
<p class="center"><a href="#X-PROPERTY_PROP">x-prop</a></p>
|
|
<p>)</p>
|
|
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_Component_list">[up]</a>
|
|
|
|
<a name="VTIMEZONE"></a><h2>2.7 VTIMEZONE</h2>
|
|
<p class="center">"BEGIN" ":" "VTIMEZONE" CRLF</p>
|
|
<p>2*(</p>
|
|
<p class="center">"<a href="#TZID">tzid</a>" is required, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#TZID">tzid</a> / </p>
|
|
<p class="center">"<a href="#LAST-MODIFIED">last-mod</a>" and "<a href="#TZURL">tzurl</a>" are optional, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#LAST-MODIFIED">last-mod</a> / <a href="#TZURL">tzurl</a> /</p>
|
|
<p class="center">one of "standardc" or "daylightc" MUST occur and each MAY occur more than once.</p>
|
|
<p class="center">standardc / daylightc /</p>
|
|
<p class="center">the following is optional, and MAY occur more than once</p>
|
|
<p class="center"><a href="#X-PROPERTY_PROP">x-prop</a></p>
|
|
<p>)</p>
|
|
<p class="center">"END" ":" "VTIMEZONE" CRLF</p>
|
|
<p class="center">standardc = "BEGIN" ":" "STANDARD" CRLF</p>
|
|
<p class="center">tzprop</p>
|
|
<p class="center">"END" ":" "STANDARD" CRLF</p>
|
|
<p class="center">daylightc = "BEGIN" ":" "DAYLIGHT" CRLF</p>
|
|
<p class="center">tzprop</p>
|
|
<p class="center">"END" ":" "DAYLIGHT" CRLF</p>
|
|
|
|
<p>tzprop = 3*(</p>
|
|
<p class="center">the following are each REQUIRED, but MUST NOT occur more than once</p>
|
|
<p class="center"><a href="#DTSTART">dtstart</a> / <a href="#TZOFFSETTO">tzoffsetto</a> / <a href="#TZOFFSETFROM">tzoffsetfrom</a> /</p>
|
|
<p class="center">the following are optional, and MAY occur more than once</p>
|
|
<p class="center"><a href="#COMMENT">comment</a> /<a href="#RDATE">rdate</a> / <a href="#RRULE">rrule</a> / <a href="#TZNAME">tzname</a> / <a href="#X-PROPERTY_PROP">x-prop</a></p>
|
|
<p>)</p>
|
|
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_Component_list">[up]</a>
|
|
|
|
<a name="CalProps"></a><h2>2.8 Component Properties</h2>
|
|
<p>
|
|
A comprehensive table showing relation between <strong>calendar</strong> components and properties.
|
|
<a href="#VTIMEZONE">vtimezone</a> properties are not included.
|
|
</p>
|
|
<table>
|
|
<tr>
|
|
<td>0-1</td>
|
|
<td colspan="8">OPTIONAL property, MUST NOT occur more than once.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>0-m</td>
|
|
<td colspan="8">OPTIONAL property, MAY occur more than once.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>0 / 1=1</td>
|
|
<td colspan="8">A pair of OPTIONAL properties, MUST NOT occur more than once each.<br>If one occurs, so MUST the other</td>
|
|
</tr>
|
|
<tr>
|
|
<td>0*1</td>
|
|
<td colspan="8">A pair of OPTIONAL properties, MUST NOT occur more than once each.<br>If one occurs, so MUST NOT the other</td>
|
|
</tr>
|
|
<tr>
|
|
<td>1-m</td>
|
|
<td colspan="8">REQUIRED property, MAY occur more than once.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>1</td>
|
|
<td colspan="8">REQUIRED property, MUST NOT occur more than once.</td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="9"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td class="bl bb center top" rowspan="2"><a class="ref" href="#VEVENT">v<br>e<br>v<br>e<br>n<br>t</a></td>
|
|
<td class="bl bb center top" rowspan="2"><a class="ref" href="#VTODO">v<br>t<br>o<br>d<br>o</a></td>
|
|
<td class="bl bb center top" rowspan="2"><a class="ref" href="#VJOURNAL">v<br>j<br>o<br>u<br>r<br>n<br>a<br>l</a></td>
|
|
<td class="bl bb center top" rowspan="2"><a class="ref" href="#VFREEBUSY">v<br>f<br>r<br>e<br>e<br>b<br>u<br>s<br>y</a></td>
|
|
<td class="bl top center" colspan="4"><a class="ref" href="#VALARM">v a l a r m</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"> </td>
|
|
<td class="bl bb center ref"><br><br><br><br>a<br>u<br>d<br>i<br>o</td>
|
|
<td class="bl bb center ref"><br><br>d<br>i<br>s<br>p<br>l<br>a<br>y</td>
|
|
<td class="bl bb center ref"><br><br><br><br>e<br>m<br>a<br>i<br>l</td>
|
|
<td class="bl bb center ref">p<br>r<br>o<br>c<br>e<br>d<br>u<br>r<br>e</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#ACTION">action</a></td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">1</td>
|
|
<td class="blb">1</td>
|
|
<td class="blb">1</td>
|
|
<td class="blb">1</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#ATTACH">attach</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">1</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#ATTENDEE">attendee</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">1-m</td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#CATEGORIES">categories</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#CLASS">class</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#COMMENT">comment</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#COMPLETED">completed</a></td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#CONTACT">contact</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#CREATED">created</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#DESCRIPTION">description</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">1</td>
|
|
<td class="blb">1</td>
|
|
<td class="blb">0-1</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#DTEND">dtend</a></td>
|
|
<td class="blb">0*1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#DTSTAMP">dtstamp</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#DTSTART">dtstart</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#DUE">due</a></td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">0*1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#DURATION">duration</a></td>
|
|
<td class="blb">0*1</td>
|
|
<td class="blb">0*1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0 / 1=1</td>
|
|
<td class="blb">0 / 1=1</td>
|
|
<td class="blb">0 / 1=1</td>
|
|
<td class="blb">0 / 1=1</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#EXDATE">exdate</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#EXRULE">exrule</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#FREEBUSY_PROP">freebusy</a></td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#GEO">geo</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#LAST-MODIFIED">last-mod</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"></td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#LOCATION">location</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#ORGANIZER">organizer</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#PERCENT-COMPLETE">percent</a></td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#PRIORITY">priority</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#RDATE">rdate</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#RECURRENCE-ID">recurid</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#RELATED-TO">related</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#REPEAT">repeat</a></td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">0 / 1=1</td>
|
|
<td class="blb">0 / 1=1</td>
|
|
<td class="blb">0 / 1=1</td>
|
|
<td class="blb">0 / 1=1</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#RESOURCES">resources</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#RRULE">rrule</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#REQUEST-STATUS">rstatus</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#SEQUENCE">sequence</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#STATUS">status</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#SUMMARY">summary</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">1</td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#TRANSP">transp</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#TRIGGER">trigger</a></td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb">1</td>
|
|
<td class="blb">1</td>
|
|
<td class="blb">1</td>
|
|
<td class="blb">1</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#UID">uid</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#URL">url</a></td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb">0-1</td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
<td class="blb"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bb"><a class="ref" href="#X-PROPERTY_PROP">x-prop</a></td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
<td class="blb">0-m</td>
|
|
</tr>
|
|
</table>
|
|
<p>
|
|
If not set, the <a href="#DTSTAMP">DTSTAMP</a> and <a href="#UID">UID</a> properties
|
|
are automatically created by iCalcreator<br>
|
|
for <a href="#VEVENT">vevent</a>,<a href="#VTODO">vtodo</a>, <a href="#VJOURNAL">vjournal</a> and <a href="#VFREEBUSY">vfreebusy</a> components<br>
|
|
when using iCalcreator object methods <a href="#saveCalendar">saveCalendar</a> or <a href="#returnCalendar">returnCalendar</a><br>
|
|
or when fetching <a href="#DTSTAMP">DTSTAMP</a>/<a href="#UID">UID</a> property value with the component function <a href="#getProperty_PROP">getProperty</a>.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_Component_list">[up]</a>
|
|
|
|
<a name="Function_list"></a><h1>3 Function list</h1>
|
|
|
|
<a name="iCalcreator_object_methods"></a><h2>3.1 iCalcreator object methods</h2>
|
|
|
|
<a name="Calendar_object_constructors"></a><h3>3.1.1 Constructors</h3>
|
|
<a name="vcalendar_constr"></a><h4>3.1.1.1 vcalendar</h4>
|
|
<p>Create a new <a href="#VCALENDAR">VCALENDAR</a> object.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::vcalendar( [ config ] )</p>
|
|
<p class="comment">
|
|
config = array, review <a href="#iCalcreator_configuration_methods">configuration</a> options.
|
|
</p>
|
|
<p class="label">Basic example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
</p>
|
|
<p>
|
|
The <strong>calendar</strong> property PRODID and each component property <a href="#UID">UID</a> are AUTOMATICALLY generated in iCalcreator,
|
|
if not set manually, and based on the configuration <a href="#Unique_id">unique_id</a>.
|
|
</p>
|
|
<p class="label">Extended example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$tz = "Europe/Stockholm"
|
|
$config = array( "unique_id" => "kigkonsult.se"
|
|
"TZID" => $tz );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->setProperty( "X-WR-TIMEZONE", $tz );
|
|
.. .
|
|
.. . // <span class="comment">insert components or parse an iCal file (and edit components)</span>
|
|
.. .
|
|
$xprops = array( "X-LIC-LOCATION" => $tz );
|
|
iCalUtilityFunctions::createTimezone( $vcalendar, $tz, $xprops );
|
|
.. .
|
|
</p>
|
|
<p>
|
|
The <a href="#dTZID">TZID</a> config key and value (timezone) is supplied when setting <a href="#DTSTART">DTSTART</a>,
|
|
<a href="#DTEND">DTEND</a>, <a href="#DUE">DUE</a> or <a href="#RECURRENCE-ID">RECURRENCE-ID</a>,
|
|
if not set manually, a TZID <b>auto completion</b>.
|
|
</p>
|
|
<p>
|
|
Some <strong>calendar</strong> software may also require calendar property <a href="#Additional_Descriptors">X-WR-TIMEZONE</a>
|
|
and vtimezone component with property <a href="#Additional_Descriptors">X-LIC-LOCATION</a>,
|
|
review <a href="#createTimezone">createTimezone</a>, a function in iCalUtilityFunctions class.
|
|
</p>
|
|
<p>
|
|
Do <b>NOT</b> set <a href="#Directory">directory</a>/<a href="#Filename">filename</a> in vcalendar constructor, due to inability to detect error (FALSE) config return.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Function_list">[up]</a>
|
|
|
|
|
|
<a name="vevent_constr"></a><h4>3.1.1.2 vevent</h4>
|
|
<p class="label">Format 1</p>
|
|
<p>Create a new <a href="#VEVENT">VEVENT</a> object using an iCalcreator object component factory-method, returning a reference to the new component.</p>
|
|
<p class="format">vcalendar::newComponent( "vevent" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vevent = & $vcalendar->newComponent( "vevent" );
|
|
$vevent->setProperty(...
|
|
...
|
|
</p>
|
|
<p class="label">Format 2</p>
|
|
<p>Create a new <a href="#VEVENT">VEVENT</a> object.</p>
|
|
<p class="format">vevent::vevent( [ config ] )</p>
|
|
<p class="comment">
|
|
config = array, review <a href="#iCalcreator_configuration_methods">configuration</a> options.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$config = $vcalendar->getConfig();
|
|
$vevent = new vevent( $config );
|
|
$vevent->setProperty(...
|
|
...
|
|
$vcalendar->setComponent( $vevent );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Function_list">[up]</a>
|
|
|
|
|
|
<a name="vtodo_constr"></a><h4>3.1.1.3 vtodo</h4>
|
|
<p class="label">Format 1</p>
|
|
<p>Create a new <a href="#VTODO">VTODO</a> object using an iCalcreator object component factory-method, returning a reference to the new component.</p>
|
|
<p class="format">vcalendar::newComponent( "vtodo" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vtodo = & $vcalendar->newComponent( "vtodo" );
|
|
$vtodo->setProperty(...
|
|
...
|
|
</p>
|
|
<p class="label">Format 2</p>
|
|
<p>Create a new <a href="#VTODO">VTODO</a> object.</p>
|
|
<p class="format">vtodo::vtodo( [ config ] )</p>
|
|
<p class="comment">
|
|
config = array, review <a href="#iCalcreator_configuration_methods">configuration</a> options.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vtodo = new vtodo( $vcalendar->getConfig());
|
|
$vtodo->setProperty(...
|
|
...
|
|
$vcalendar->setComponent( $vtodo );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Function_list">[up]</a>
|
|
|
|
|
|
<a name="vjournal_constr"></a><h4>3.1.1.4 vjournal</h4>
|
|
<p class="label">Format 1</p>
|
|
<p>Create a new <a href="#VJOUNAL">VJOURNAL</a> object using an iCalcreator object factory-method, returning a reference to the new component.</p>
|
|
<p class="format">vcalendar::newComponent( "vjournal" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vjournal = & $vcalendar->newComponent( "vjournal" );
|
|
$vjournal->setProperty(...
|
|
...
|
|
</p>
|
|
<p class="label">Format 2</p>
|
|
<p>Create a new <a href="#VJOURNAL">VJOURNAL</a> object.</p>
|
|
<p class="format">vjournal::vjournal( [ config ] )</p>
|
|
<p class="comment">
|
|
config = array, review <a href="#iCalcreator_configuration_methods">configuration</a> options.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vjournal = new vjournal( $vcalendar->getConfig());
|
|
$vjournal->setProperty(...
|
|
...
|
|
$vcalendar->setComponent( $vjournal );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Function_list">[up]</a>
|
|
|
|
|
|
<a name="vfreebusy_constr"></a><h4>3.1.1.5 vfreebusy</h4>
|
|
<p class="label">Format 1</p>
|
|
<p>Create a new <a href="#VFREEBUSY">VFREEBUSY</a> object using an iCalcreator object factory-method, returning a reference to the new component.</p>
|
|
<p class="format">vcalendar::newComponent( "vfreebusy" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vfreebusy = & $vcalendar->newComponent( "vfreebusy" );
|
|
$vfreebusy->setProperty(...
|
|
...
|
|
</p>
|
|
<p class="label">Format 2</p>
|
|
<p>Create a new <a href="#VFREEBUSY">VFREEBUSY</a> object.</p>
|
|
<p class="format">vfreebusy::vfreebusy( [ config ] )</p>
|
|
<p class="comment">
|
|
config = array, review <a href="#iCalcreator_configuration_methods">configuration</a> options.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vfreebusy = new vfreebusy( $vcalendar->getConfig());
|
|
$vfreebusy->setProperty(...
|
|
...
|
|
$vcalendar->setComponent( $vfreebusy );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Function_list">[up]</a>
|
|
|
|
|
|
<a name="valarm_constr"></a><h4>3.1.1.6 valarm</h4>
|
|
<p class="label">Format 1</p>
|
|
<p>Create a new <a href="#VALARM">VALARM</a> object using an iCalcreator object component factory-method, returning a reference to the new (sub-)component.</p>
|
|
<p class="format">calendarComponent::newComponent( "valarm" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vevent = & $vcalendar->newComponent( "vevent" );
|
|
$vevent->setProperty(...
|
|
...
|
|
$valarm = & $vevent->newComponent( "valarm" );
|
|
$valarm->setProperty(...
|
|
...
|
|
</p>
|
|
<p class="label">Format 2</p>
|
|
<p>Create a new <a href="#VALARM">VALARM</a> object.</p>
|
|
<p class="format">valarm::valarm( [ config ] )</p>
|
|
<p class="comment">
|
|
config = array, review <a href="#iCalcreator_configuration_methods">configuration</a> options.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vevent = new vevent();
|
|
$vevent->setProperty(...
|
|
...
|
|
$valarm = new valarm( $vevent->getConfig());
|
|
$valarm->setProperty(...
|
|
...
|
|
$vevent->setComponent( $valarm );
|
|
...
|
|
$vcalendar->setComponent( $vevent );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Function_list">[up]</a>
|
|
|
|
|
|
<a name="vtimezone_constr"></a><h4>3.1.1.7 vtimezone</h4>
|
|
<p>
|
|
The vtimezone component describe, at a minimum, the base offset from <b>UTC</b> for the time zone.
|
|
For dates with UTC DATE-TIME, read <a href="#DATE_WITH_UTC_TIME">this</a>!
|
|
</p>
|
|
<p class="label">Format 1</p>
|
|
<p>Create a new <a href="#VTIMEZONE">VTIMEZONE</a> object using an iCalcreator object component factory-method, returning a reference to the new component.</p>
|
|
<p class="format">vcalendar::newComponent( "vtimezone" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vtimezone = & $vcalendar->newComponent( "vtimezone" );
|
|
$vtimezone->setProperty(...
|
|
...
|
|
</p>
|
|
<p class="label">Format 2</p>
|
|
<p>Create a new <a href="#VTIMEZONE">VTIMEZONE</a> object.</p>
|
|
<p class="format">vtimezone::vtimezone( [ config ] )</p>
|
|
<p class="comment">
|
|
config = array, review <a href="#iCalcreator_configuration_methods">configuration</a> options.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vtimezone = new vtimezone( $vcalendar->getConfig());
|
|
$vtimezone->setProperty(...
|
|
...
|
|
$vcalendar->setComponent( $vtimezone );
|
|
...
|
|
</p>
|
|
<br>
|
|
<h5>Creation of timezone components</h5>
|
|
<p>
|
|
It is possible to create timezone components, using a function in iCalUtilityFunctions class, <a href="#createTimezone">createTimezone</a>
|
|
and utilizing the <em>PHP</em> DateTimeZone class (<em>PHP</em> 5 >= 5.2.0).
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Function_list">[up]</a>
|
|
|
|
<a name="standard_constr"></a><h4>3.1.1.8 standard</h4>
|
|
<p class="label">Format 1</p>
|
|
<p>Create a new <a href="#VTIMEZONE">VTIMEZONE</a> <b>standard</b> object using an iCalcreator object component factory-method, returning a reference to the new (sub-)component.</p>
|
|
<p class="format">vtimezone::newComponent( "standard" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vtimezone = & $vcalendar->newComponent( "vtimezone" );
|
|
$vtimezone->setProperty(...
|
|
...
|
|
$standard = & $vtimezone->newComponent( "standard" );
|
|
$standard->setProperty(...
|
|
...
|
|
$daylight = & $vtimezone->newComponent( "daylight" );
|
|
$daylight->setProperty(...
|
|
...
|
|
</p>
|
|
<p class="label">Format 2</p>
|
|
<p>Create a new <a href="#VTIMEZONE">VTIMEZONE</a> STANDARD object.</p>
|
|
<p class="format">vtimezone::vtimezone( "standard" [, config ] )</p>
|
|
<p class="comment">
|
|
config = array, review <a href="#iCalcreator_configuration_methods">configuration</a> options.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vtimezone = new vtimezone( $vcalendar->getConfig());
|
|
$vtimezone->setProperty(...
|
|
...
|
|
$standard = new vtimezone( "standard", $vtimezone->getConfig());
|
|
$standard->setProperty(...
|
|
...
|
|
$vtimezone->setComponent( $standard );
|
|
...
|
|
$daylight = new vtimezone( "daylight", $vtimezone->getConfig());
|
|
$daylight->setProperty(...
|
|
...
|
|
$vtimezone->setComponent( $daylight );
|
|
...
|
|
$vcalendar->setComponent( $vtimezone );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Function_list">[up]</a>
|
|
|
|
|
|
<a name="daylight_constr"></a><h4>3.1.1.9 daylight</h4>
|
|
<p class="label">Format 1</p>
|
|
<p>Create a new <a name="VTIMEZONE">VTIMEZONE</a> <b>daylight</b> object using a component factory-method, returning a reference to the new (sub-)component.</p>
|
|
<p class="format">vtimezone::newComponent( "standard" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vtimezone = & $vcalendar->newComponent( "vtimezone" );
|
|
...
|
|
$standard = & $vtimezone->newComponent( "standard" );
|
|
...
|
|
$daylight = & $vtimezone->newComponent( "daylight" );
|
|
...
|
|
</p>
|
|
<p class="label">Format 2</p>
|
|
<p>Create a new <a href="#VTIMEZONE">VTIMEZONE</a> DAYLIGHT object.</p>
|
|
<p class="format">vtimezone::vtimezone( "daylight" [, config ] )</p>
|
|
<p class="comment">
|
|
config = array, review <a href="#iCalcreator_configuration_methods">configuration</a> options.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vtimezone = new vtimezone( $vcalendar->getConfig());
|
|
...
|
|
$standard = new vtimezone( "standard", $vtimezone->getConfig());
|
|
...
|
|
$vtimezone->setComponent( $standard );
|
|
$daylight = new vtimezone( "daylight", $vtimezone->getConfig() );
|
|
...
|
|
$vtimezone->setComponent( $daylight );
|
|
$vcalendar->setComponent( $vtimezone );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Function_list">[up]</a>
|
|
|
|
|
|
<a name="iCalcreator_object_property_methods"></a><h3>3.1.2 iCalcreator object property methods</h3>
|
|
|
|
<a name="deleteProperty"></a><h4>3.1.2.1 deleteProperty</h4>
|
|
<p>Generic iCalcreator object deleteProperty method, simplifying removal of <strong>calendar</strong> properties.</p>
|
|
<p>FALSE is returned if no property exists or when end-of-properties at consecutive function calls.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::deleteProperty( [ PropName [, order=1 ] )</p>
|
|
<p class="comment">propName = (string) case independent, [RFC5545] component property names,
|
|
unknown/missing propName will be regarded as <a href="#X-PROPERTY">X-property</a>.
|
|
order = (int) if missing 1st/next occurrence,
|
|
used with multiple (property) occurrences
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
if( !$vcalendar->deleteProperty( "method" ))
|
|
echo "METHOD property not found";
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_object_property_methods">[up]</a>
|
|
|
|
|
|
<a name="getProperty"></a><h4>3.1.2.2 getProperty</h4>
|
|
<p class="label">Format 1</p>
|
|
<p>Generic iCalcreator getProperty method, simplifying fetch of <strong>calendar</strong> properties.</p>
|
|
<p>FALSE is returned if no property exists or when end-of-properties at consecutive function calls.</p>
|
|
<p class="format">vcalendar::getProperty( [ PropName [, order=1 [, complete=FALSE ]]] )</p>
|
|
<p class="comment">propName = (string) case independent, [RFC5545] component property names,
|
|
unknown/missing propName will be regarded as <a href="#X-PROPERTY">X-property</a>.
|
|
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>)
|
|
</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$calscale = $vcalendar->getProperty( "calscale" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
while( $xprop = $vcalendar->getProperty( )) { // <span class="comment">get x-properties</span>
|
|
.. .
|
|
</p>
|
|
<a name="getProperty2"></a>
|
|
<a name="geoLocation"></a>
|
|
<p class="label">Format 2</p>
|
|
<p>
|
|
Ability to fetch specific <i>component</i> property (unique) value(-s) and number of occurrence(-s).
|
|
The search includes <b>ALL</b> components within the iCalcreator object instance.
|
|
</p>
|
|
<p>
|
|
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 (like "CATAGORIES:course1,courseB" or
|
|
"RESOURCES:pc,camera"), they are split into unique values.
|
|
</p>
|
|
<dl>
|
|
<dt>Supported Descriptive Component Properties
|
|
<dd><a href="#CATEGORIES">CATEGORIES</a>
|
|
<dd><a href="#LOCATION">LOCATION</a>
|
|
<dd>GEOLOCATION <sup>*1</sup>
|
|
<dd><a href="#PRIORITY">PRIORITY</a>
|
|
<dd><a href="#RESOURCES">RESOURCES</a>
|
|
<dd><a href="#STATUS">STATUS</a>
|
|
<dd><a href="#SUMMARY">SUMMARY</a>
|
|
<dt>Supported Date and Time Component Property
|
|
<dd><a href="#DTSTART">DTSTART</a> <sup>*2</sup>
|
|
<dt>Supported Relationship Component Properties
|
|
<dd><a href="#ATTENDEE">ATTENDEE</a> <sup>*3</sup>
|
|
<dd><a href="#CONTACT">CONTACT</a>
|
|
<dd><a href="#ORGANIZER">ORGANIZER</a> <sup>*3</sup>
|
|
<dd><a href="#RECURRENCE-ID">RECURRENCE-ID</a> <sup>*4</sup> (alt. "R-UID")
|
|
<dd><a href="#RELATED-TO">RELATED-TO</a>
|
|
<dd><a href="#URL">URL</a>
|
|
<dd><a href="#UID">UID</a>
|
|
</dl>
|
|
<dl>
|
|
<dt><sup>*1</sup>
|
|
<dd>Using the non-standard directive "GEOLOCATION", iCalcreator returns output supporting<br>
|
|
ISO6709 "Standard representation of geographic point location by coordinates",<br>
|
|
by combining the <a href="#LOCATION">LOCATION</a> and <a href="#GEO">GEO</a> property values
|
|
(only if <a href="#GEO">GEO</a> is set).
|
|
<dt><sup>*2</sup>
|
|
<dd>Using <a href="#DTSTART">DTSTART</a> as argument returns dates in format "YYYYMMDD" (please note, dates within a <a href="#RDATE">RDATE</a>/<a href="#RRULE">RRULE</a>
|
|
recurrence set are NOT included, only the origin start date (<a href="#DTSTART">DTSTART</a>)).
|
|
<dt><sup>*3</sup>
|
|
<dd>The <a href="#ATTENDEE">ATTENDEE</a> and <a href="#ORGANIZER">ORGANIZER</a> output values are prefixed
|
|
by "protocol" like "MAILTO:chair@kigkonsult.se".
|
|
<dt><sup>*4</sup>
|
|
<dd>Using "RECURRENCE-ID-UID" returns <a href="#UID">UID</a> values for component(-s) where <a href="#RECURRENCE-ID">RECURRENCE-ID</a> is set.
|
|
</dl>
|
|
<p>
|
|
To select components based on property values, use <a href="#selectComponents2">selectComponents</a> (Format 2).
|
|
</p>
|
|
<p>
|
|
To get components based on property values, use <a href="#getComponent5">getComponent</a> (Format 5).
|
|
</p>
|
|
<p class="format">vcalendar::getProperty( PropName )</p>
|
|
<p class="comment">propName = (string) case independent, property name</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Fetch all attendees in the iCalcreator object instance.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$attendees = $vcalendar->getProperty( "ATTENDEE" );
|
|
foreach( $attendees as $attendee => $occurrCount ) {
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Fetch all DTSTARTs in the iCalcreator object instance.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$startDates = $vcalendar->getProperty( "DTSTART" );
|
|
foreach( $startDates as $startDate => $occurrCount ) {
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_object_property_methods">[up]</a>
|
|
|
|
|
|
<a name="setProperty"></a><h4>3.1.2.3 setProperty</h4>
|
|
<p>Generic the iCalcreator object setProperty method,simplifying insert of <strong>calendar</strong> properties.</p>
|
|
<p>A successful update returns TRUE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::setProperty( PropName, Proparg_1 *[, Proparg_n] )</p>
|
|
<p class="comment">propName = (string) case independent, strict [RFC5545] <strong>calendar</strong> property names,
|
|
unknown propName will be regarded as (a non-standard) <a href="#X-PROPERTY">X-property</a>.
|
|
Proparg = (mixed) property argument
|
|
Last property argument is a (optional) property dependent parameters
|
|
array( *[(string) key => (string) value ] ).
|
|
A non-standard (, experimental) parameter key MUST be prefixed by "X-".
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"filename" => "file.ics",
|
|
"TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config ); // <span class="comment">initiate new CALENDAR</span>
|
|
$vcalendar->setProperty( "calscale", "GREGORIAN" );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_object_property_methods">[up]</a>
|
|
|
|
|
|
<a name="CALSCALE"></a><h4>3.1.2.4 CALSCALE</h4>
|
|
<p>
|
|
This property defines the <strong>calendar</strong> scale used for the <strong>calendar</strong> information specified in the <strong>iCalendar</strong> object.
|
|
</p>
|
|
<p>
|
|
The default value is "GREGORIAN", implied when missing.
|
|
</p>
|
|
<h5>Create CALSCALE</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::createCalscale()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $vcalendar->createCalscale();
|
|
...
|
|
</p>
|
|
<h5>Delete CALSCALE</h5>
|
|
<p>Remove CALSCALE from calendar.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::deleteProperty( "calscale" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vcalendar->deleteProperty( "CALSCALE" );
|
|
...
|
|
</p>
|
|
<h5>Get Calscale</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::getProperty( "calscale" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$calscale = $vcalendar->getProperty( "calscale" );
|
|
.. .
|
|
</p>
|
|
<h5>Set CALSCALE</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::setProperty( "calscale", value )</p>
|
|
<p class="comment">value = (string) calscale value</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config ); // <span class="comment">initiate new CALENDAR</span>
|
|
$vcalendar->setProperty( "calscale", "GREGORIAN" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_object_property_methods">[up]</a>
|
|
|
|
|
|
<a name="METHOD"></a><h4>3.1.2.5 METHOD</h4>
|
|
<p>
|
|
This property defines the <strong>iCalendar</strong> object method associated with the <strong>calendar</strong> object.
|
|
</p>
|
|
<p>
|
|
METHOD property (value PUBLISH etc.) may be required when importing iCal files
|
|
into some calendaring software (MS etc.), as well as <a href="#X-PROPERTY">x-properties</a>
|
|
"X-WR-CALNAME", "X-WR-CALDESC" and "X-WR-TIMEZONE"
|
|
and the (automatically created) <a href="#DTSTAMP">DTSTAMP</a> and <a href="#UID">UID</a> properties.
|
|
</p>
|
|
<h5>Create METHOD</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::createMethod()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $vcalendar->createMethod();
|
|
...
|
|
</p>
|
|
<h5>Delete METHOD</h5>
|
|
<p>Remove METHOD from calendar.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::deleteProperty( "METHOD" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vcalendar->deleteProperty( "METHOD" );
|
|
...
|
|
</p>
|
|
<h5>Get METHOD</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::getProperty( "method" );</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$method = $vcalendar->getProperty( "method" );
|
|
.. .
|
|
</p>
|
|
<h5>Set METHOD</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::setProperty( "method", value )</p>
|
|
<p class="comment">value = (string) method value</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config ); // <span class="comment">initiate new CALENDAR</span>
|
|
$vcalendar->setProperty( "method", "PUBLISH" );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_object_property_methods">[up]</a>
|
|
|
|
|
|
<a name="VERSION"></a><h4>3.1.2.6 VERSION</h4>
|
|
<p>
|
|
This property specifies the identifier corresponding to the version number of the <strong>iCalendar</strong> specification.
|
|
This property is always placed first in the <strong>calendar</strong> file.
|
|
</p>
|
|
<h5>Create Version</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::createVersion()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $vcalendar->createVersion();
|
|
...
|
|
</p>
|
|
<h5>Get Version</h5>
|
|
<p>Fetch property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::getProperty( "version" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$version = $vcalendar->getProperty( "version" )
|
|
.. .
|
|
</p>
|
|
<h5>Set Version</h5>
|
|
<p>Insert property value.
|
|
Only version 2.0 valid, version is <b>AUTO</b> generated at <strong>calendar</strong> creation.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::setProperty( "version", version )</p>
|
|
<p class="comment">version = (string) iCal version</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config ); // <span class="comment">initiate new CALENDAR</span>
|
|
$vcalendar->setProperty( "version", "2.0" );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_object_property_methods">[up]</a>
|
|
|
|
<a name="X-PROPERTY"></a><h4>3.1.2.7 X-PROPERTY</h4>
|
|
<p>
|
|
A <strong>calendar</strong>, non-standard property with a TEXT value and a name with an "X-" prefix. In a <strong>calendar</strong>,
|
|
an x-property, with an unique name, can occur only once but the number of x-properties are unlimited.
|
|
</p>
|
|
<p>
|
|
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 <a href="#METHOD">METHOD</a> property (value PUBLISH etc.)
|
|
and the (automatically created) <a href="#DTSTAMP">DTSTAMP</a> and <a href="#UID">UID</a> properties.
|
|
</p>
|
|
<p>The value type is TEXT.</p>
|
|
<h5>Create X-property</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::createXprop()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $vcalendar->createXprop();
|
|
...
|
|
</p>
|
|
<h5>Delete X-PROPERTY</h5>
|
|
<p>Remove X-PROPERTY from <strong>calendar</strong>.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::deleteProperty( "<X-PROPERTY>" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete the x-property named "X-PROPERTY".</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vcalendar->deleteProperty( "X-PROPERTY" );
|
|
...
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete all x-properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vcalendar->deleteProperty())
|
|
continue;
|
|
...
|
|
</p>
|
|
<h5>Get X-PROPERTY</h5>
|
|
<p>If set, returns property (name and) value, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::getProperty()</p>
|
|
<p class="format">vcalendar::getProperty( "<X-PROPERTY>" )</p>
|
|
<p class="comment">output = array( propertyName<sup>1</sup>, propertyData<sup>2</sup> )</p>
|
|
<p class="format">vcalendar::getProperty( FALSE, propOrderNo/FALSE, TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( propertyName<sup>1</sup>
|
|
, array( "value" => propertyData<sup>2</sup> )
|
|
, "params" => params<sup>3</sup>))
|
|
</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Read all x-prop values in a loop.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
while( $xprop = $vcalendar->getProperty( )) { // <span class="comment">$xprop = array( propertyName<sup>1</sup>, propertyData<sup>2</sup> )</span>
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>If exists, read X-WR-TIMEZONE x-prop</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
if( $xprop = $vcalendar->getProperty( "X-WR-TIMEZONE" )) {
|
|
.. . // <span class="comment">$xprop = array( "X-WR-TIMEZONE", propertyData<sup>2</sup> )</span>
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
while( $xprop = $vcalendar->getProperty( FALSE, FALSE, TRUE )) {
|
|
/* <span class="comment">$xprop = array( propertyName<sup>1</sup>
|
|
, array( "value " => propertyData<sup>2</sup>
|
|
, "params "=> params<sup>3</sup> ))</span>
|
|
*/
|
|
.. .
|
|
</p>
|
|
<h5>Set X-PROPERTY</h5>
|
|
Insert property name and value. If an x-prop with the same name already exists, it will be replaced.
|
|
PropertyNames are always stored upperCase, ex. x-wr-calname => X-WR-CALNAME.
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::setProperty( propertyName, propertyData [, params ] )</p>
|
|
<p class="comment">propertyName<sup>1</sup> = (string) Any property name with a "X-" prefix
|
|
propertyData<sup>2</sup> = (string) Value type TEXT
|
|
params<sup>3</sup> = (array) ( ["LANGUAGE" => (string) "lang<sup>*</sup>"] *[, xparams] )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config ); // initiate new CALENDAR
|
|
// <span class="comment">set some X-properties.. .</span>
|
|
$vcalendar->setProperty( "x-wr-calname", "Calendar Sample" )
|
|
$vcalendar->setProperty( "X-WR-CALDESC", "Calendar Description" );
|
|
$vcalendar->setProperty( "X-WR-TIMEZONE", "Europe/Stockholm" );
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_object_property_methods">[up]</a>
|
|
|
|
<a name="iCalcreator_component_object_methods"></a><h3>3.1.3 iCalcreator component object methods</h3>
|
|
|
|
<a name="deleteComponent"></a><h4>3.1.3.1 deleteComponent</h4>
|
|
<p>
|
|
Remove component from the iCalcreator object instance.
|
|
</p>
|
|
<p>
|
|
FALSE is returned if no component exists or when end-of-components at consecutive function calls.
|
|
</p>
|
|
<p class="label">format 1</p>
|
|
Remove component with order number (1st=1, 2nd=2.. .).
|
|
<p class="format">vcalendar::deleteComponent( orderNumber )</p>
|
|
<p class="comment">orderNumber = (int) order number</p>
|
|
<p class="label">format 2</p>
|
|
<P>Remove component with component type (e.g. "vevent") and order 1 alt. suborder number.</p>
|
|
<p class="format">vcalendar::deleteComponent( componentType [, componentSuborderNumber])</p>
|
|
<p class="comment">componentType = (string) component type
|
|
componentSuborderNumber = (int) order number</p>
|
|
<p class="label">format 3</p>
|
|
<p>Remove component with <a href="#UID">UID</a>. N.B <a href="#UID">UID</a> is NOT set for <a href="#VALARM">ALARM</a> / <a href="#VTIMEZONE">TIMEZONE</a> components.</p>
|
|
<p class="format">vcalendar::deleteComponent( <a href="#UID">UID</a> )</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$vcalendar->deleteComponent( 1 );
|
|
$vcalendar->deleteComponent( "vtodo", 2 );
|
|
$vcalendar->deleteComponent( "20070803T194810CEST-0123U3PXiX@kigkonsult.se");
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Deleting all components, using format 2 without order number.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
.. .
|
|
while( $vcalendar->deleteComponent( "vevent"))
|
|
continue;
|
|
.. .
|
|
$vtodo = $vcalendar->getComponent( "vtodo" );
|
|
while( $vtodo->deleteComponent( "valarm"))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_object_methods">[up]</a>
|
|
|
|
<a name="getComponent"></a><h4>3.1.3.2 getComponent</h4>
|
|
<p>Get (next) component from the iCalcreator object instance.</p>
|
|
<p>
|
|
FALSE is returned if no component exists or when end-of-components at consecutive function calls.
|
|
</p>
|
|
<p class="label">format 1</p>
|
|
<p>Get next component, until end-of-components.</p>
|
|
<p class="format">vcalendar::getComponent()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
while( $comp = $vcalendar->getComponent()) {
|
|
.. .
|
|
}
|
|
.. .
|
|
</p>
|
|
<p class="label">format 2</p>
|
|
<P>Get specific component with order number (1st=1, 2nd=2.. .).</p>
|
|
<p class="format">vcalendar::getComponent( orderNumber )</p>
|
|
<p class="comment">orderNumber = (int) order number</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
if( $comp = $vcalendar->getComponent( 1 )) {
|
|
.. .
|
|
}
|
|
.. .
|
|
</p>
|
|
|
|
<p class="label">format 3</p>
|
|
<p>
|
|
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.. .).
|
|
</p>
|
|
<p class="format">vcalendar::getComponent( componentType [, componentSuborderNumber])</p>
|
|
<p class="comment">componentType = (string) component type
|
|
componentSuborderNumber = (int) order number</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
if( $comp = $vcalendar->getComponent( "vtodo", 2 )) {
|
|
.. .
|
|
}
|
|
.. .
|
|
</p>
|
|
|
|
<p class="label">format 4</p>
|
|
<p>
|
|
Get (first/next) component with <a href="#UID">UID</a> as key.
|
|
(<a href="#UID">UID</a> is NOT set for <a href="#VALARM">ALARM</a> / <a href="#VTIMEZONE">TIMEZONE</a> components.)
|
|
May be used when trying to find (base) component and corresponding <a href="#RECURRENCE-ID">RECURRENCE-ID</a> components.
|
|
</p>
|
|
<p class="format">vcalendar::getComponent( <a href="#UID">UID</a> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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 )) {
|
|
.. .
|
|
}
|
|
.. .
|
|
</p>
|
|
|
|
<a name="getComponent5"></a>
|
|
<p class="label">format 5</p>
|
|
<p>
|
|
Get (first/next) component based on specific property contents:
|
|
</p>
|
|
<dl>
|
|
<dt>Supported Descriptive Component Properties
|
|
<dd><a href="#CATEGORIES">CATEGORIES</a>
|
|
<dd><a href="#LOCATION">LOCATION</a>
|
|
<dd><a href="#PRIORITY">PRIORITY</a>
|
|
<dd><a href="#RESOURCES">RESOURCES</a>
|
|
<dd><a href="#STATUS">STATUS</a>
|
|
<dd><a href="#SUMMARY">SUMMARY</a>
|
|
<dt>Date and Time Component Properties
|
|
<dd><a href="#COMPLETED">COMPLETED</a>
|
|
<dd><a href="#DTEND">DTEND</a>
|
|
<dd><a href="#DUE">DUE</a>
|
|
<dd><a href="#DTSTART">DTSTART</a>
|
|
<dt>SupportedRelationship Component Properties
|
|
<dd><a href="#ATTENDEE">ATTENDEE</a> <sup>*1</sup>
|
|
<dd><a href="#CONTACT">CONTACT</a>
|
|
<dd><a href="#ORGANIZER">ORGANIZER</a> <sup>*1</sup>
|
|
<dd><a href="#RECURRENCE-ID">RECURRENCE-ID</a>
|
|
<dd><a href="#RELATED-TO">RELATED-TO</a>
|
|
<dd><a href="#URL">URL</a>
|
|
<dd><a href="#UID">UID</a>
|
|
<dt>Change Management Component Properties
|
|
<dd><a href="#CREATED">CREATED</a>
|
|
<dd><a href="#DTSTAMP">DTSTAMP</a>
|
|
<dd><a href="#LAST-MODIFIED">LAST-MODIFIED</a>
|
|
</dl>
|
|
<dl>
|
|
<dt><sup>*1</sup>
|
|
<dd><a href="#ATTENDEE">ATTENDEE</a> and
|
|
<a href="#ORGANIZER">ORGANIZER</a> search values must be prefixed by protocol ex. "MAILTO:chair@ical.net".
|
|
</dl>
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
To select components based on property values, use <a href="#selectComponents2">selectComponents</a> (Format 2).
|
|
</p>
|
|
<p>
|
|
To retrieve specific iCalcreator instance property values, searching <b>ALL</b> components,
|
|
use <a href="#getProperty2">getProperty</a> (Format 2).
|
|
</p>
|
|
<p class="format">vcalendar::getComponent( search )</p>
|
|
<p class="comment">
|
|
search = (array) ( *[ propertyName => uniqueValue ]), multiple array elements are combined by "OR"
|
|
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"</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
while( $comp = $vcalendar->getComponent( array( "RESOURCES" => "PC" )) {
|
|
.. .
|
|
}
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_object_methods">[up]</a>
|
|
|
|
<a name="newComponent"></a><h4>3.1.3.3 newComponent</h4>
|
|
<P>
|
|
Create component (<a href="#VEVENT">VEVENT</a> / <a href="#VTODO">VTODO</a> / <a href="#VJOURNAL">VJOURNAL</a> / <a href="#VFREEBUSY">VFREEBUSY</a> / <a href="#VTIMEZONE">VTIMEZONE</a>)
|
|
using a iCalcreator object factory-method, returning a reference to the new component.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::newComponent( componentType )</p>
|
|
<p class="comment">componentType = (string) component type</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vevent = & $vcalendar->newComponent( "vevent" );
|
|
...
|
|
</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_object_methods">[up]</a>
|
|
|
|
<a name="replaceComponent"></a><h4>3.1.3.4 replaceComponent</h4>
|
|
<P>
|
|
Replace calendar component in vcalendar based on component property <a href="#UID">UID</a>
|
|
(<a href="#VEVENT">EVENT</a> / <a href="#VTODO">VTODO</a> / <a href="#VJOURNAL">VJOURNAL</a> / <a href="#VFREEBUSY">VFREEBUSY</a>).
|
|
If not found, inserted last in component chain.
|
|
</p>
|
|
<p>
|
|
In case of multiple components sharing the same UID (ex. a RECURRENCE-ID property altering a recurrence pattern), the first found is replaced
|
|
and it may lead to unpredictable result, to use with care.
|
|
</p>
|
|
<p>
|
|
For a <a href="#VTIMEZONE">VTIMEZONE</a> component, a <a href="#TZID">TZID</a> match is required.
|
|
</p>
|
|
<p>
|
|
A successfull replace returns bool TRUE otherwise FALSE.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::replaceComponent( component )</p>
|
|
<p class="comment">component = (object) component object instance</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
...
|
|
$vcalendar->replaceComponent( $component );
|
|
...
|
|
</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_object_methods">[up]</a>
|
|
|
|
<a name="selectComponents"></a><h4>3.1.3.5 selectComponents</h4>
|
|
<p class="label">Format 1</p>
|
|
<p>
|
|
Selects <a href="#VEVENT">EVENT</a> / <a href="#VTODO">VTODO</a> / <a href="#VJOURNAL">VJOURNAL</a> /
|
|
<a href="#VFREEBUSY">VFREEBUSY</a> components from the iCalcreator object instance on based on <b>dates</b>
|
|
(notice <a href="#date_restriction">date restriction</a>), based on the initial <a href="#DTSTART">DTSTART</a>
|
|
property along with the <a href="#RRULE">RRULE</a>, <a href="#RDATE">RDATE</a>, <a href="#EXDATE">EXDATE</a>
|
|
and <a href="#EXRULE">EXRULE</a> properties in the component.
|
|
</p>
|
|
<p>Requirement:</p>
|
|
<ul>
|
|
<li>The property <a href="#DTSTART">DTSTART</a> is required. If missing in a <a href="#VTODO">VTODO</a> component, <a href="#DTSTART">DUE</a> is used.</li>
|
|
<li>If not using local date, timezone in property <a href="#DTSTART">DTSTART</a> etc. MUST be PHP complient.</li>
|
|
</ul>
|
|
<p>Limitations:</p>
|
|
<ul>
|
|
<li>The values "SECONDLY" / "MINUTELY" / "HOURLY" in the "FREQ" rule part are NOT supported.
|
|
<li>If using components with properties<br>
|
|
<a href="#UID">UID</a> in combination with <a href="#SEQUENCE">SEQUENCE</a> and <a href="#RECURRENCE-ID">RECURRENCE-ID</a><br>
|
|
(i.e. altering an individual instance within the recurrence set),<br>
|
|
the <a href="#RECURRENCE-ID">RECURRENCE-ID</a> parameter "RANGE" ("THISANDPRIOR" / "THISANDFUTURE") is NOT (yet) supported.</li>
|
|
<li>only one reccurrence a day</li>
|
|
<li>a RDATE reccurrence will overwrite any RRULE reccurrence, on an date (Ymd) basis</li>
|
|
<li>no X-CURRENT-DTEND if no DTEND (DUE) is set (below)</li>
|
|
</ul>
|
|
<p>
|
|
Returns an array with components (events.. .) or FALSE is returned if no selected component exists.
|
|
<p>
|
|
<p>Added X-properties in recurrent instances of a <strong>calendar</strong> component:</p>
|
|
<ul>
|
|
<li>"X-CURRENT-DTSTART", TEXT content, <i>"Y-m-d [H:i:s [timezone]]"</i> showing the current start date.</li>
|
|
<li>"X-CURRENT-DTEND" alt. "X-CURRENT-DUE" (opt), TEXT content, <i>"Y-m-d [H:i:s [timezone]]"</i> showing the current end date.</li>
|
|
<li>"X-RECURRENCE", the RRULE/RDATE recurrence pattarn number (none in the recurrence start), also after an RECURRENCE-ID change</li>
|
|
<li>"X-OCCURENCE", contains, where applicable, single multi-day recurrence event day number (formatted as 'day X of Y')</li>
|
|
</ul>
|
|
<p class="format">vcalendar::selectComponents([ startYear, startMonth, startDay
|
|
[, endYear, endMonth, endDay
|
|
[, cType [, flat [, any [, split]]]]]])
|
|
</p>
|
|
<p class="comment">startYear : (int) start year (4*digit), default current year
|
|
(object) start date (datetime)<sup>*</sup>
|
|
startMonth : (int) start month (1-2*digit), default current month
|
|
(object) end date (datetime)<sup>*</sup>
|
|
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) <strong>calendar</strong> 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
|
|
<sup>*</sup>When using datetime objects, other start/end arguments are ignored.
|
|
|
|
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)
|
|
|
|
If flat is set to FALSE, output array is sorted in 'Y-m-d h-i-s' asc. order.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"directory" => "import",
|
|
"filename" => "file.ics" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$events_arr = $vcalendar->selectComponents( 2007, 11, 1, 2007, 11, 30, "vevent" );
|
|
// <span class="comment">select all events occurring 1-30 nov. 2007</span>
|
|
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" );
|
|
<span class="comment">// if member of a recurrence set, returns
|
|
// array(" x-current-dtstart",
|
|
// <(string) date("Y-m-d [H:i:s][timezone/UTC offset]")>)</span>
|
|
$startDate = $event->getProperty( "dtstart" );
|
|
$summary = $event->getProperty( "summary" );
|
|
$description = $event->getProperty( "description" );
|
|
.. .
|
|
.. .
|
|
</p>
|
|
<a name="selectComponents2"></a>
|
|
<p class="label">format 2</p>
|
|
<p>
|
|
Using this format, the iCalcreator object method selects components based on specific property value(-s).
|
|
</p>
|
|
<dl>
|
|
<dt>Supported Descriptive Component Properties
|
|
<dd><a href="#CATEGORIES">CATEGORIES</a>
|
|
<dd><a href="#LOCATION">LOCATION</a>
|
|
<dd><a href="#PRIORITY">PRIORITY</a>
|
|
<dd><a href="#RESOURCES">RESOURCES</a>
|
|
<dd><a href="#STATUS">STATUS</a>
|
|
<dd><a href="#SUMMARY">SUMMARY</a>
|
|
<dt>Supported Relationship Component Properties
|
|
<dd><a href="#ATTENDEE">ATTENDEE</a> <sup>*1</sup>
|
|
<dd><a href="#CONTACT">CONTACT</a>
|
|
<dd><a href="#ORGANIZER">ORGANIZER</a> <sup>*1</sup>
|
|
<dd><a href="#RELATED-TO">RELATED-TO</a>
|
|
<dd><a href="#URL">URL</a>
|
|
<dd><a href="#UID">UID</a>
|
|
</dl>
|
|
<dl>
|
|
<dt><sup>*1</sup>
|
|
<dd><a href="#ATTENDEE">ATTENDEE</a> and
|
|
<a href="#ORGANIZER">ORGANIZER</a> search values must be prefixed by (upper case) protocol like "MAILTO:chair@ical.net".
|
|
</dl>
|
|
<p>
|
|
For the property <a href="#SUMMARY">SUMMARY</a>, 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. Multiple search properties may coexist.
|
|
</p>
|
|
<p>
|
|
To retrieve specific iCalcreator instance property values, searching <b>ALL</b> components,
|
|
use <a href="#getProperty2">getProperty</a> (Format 2).
|
|
</p>
|
|
<p>
|
|
To get components based on property values, use <a href="#getComponent5">getComponent</a> (Format 5).
|
|
</p>
|
|
<p class="format">vcalendar::selectComponents( searchArray )</p>
|
|
<p>Outputs an array of matched (unique) components in <a href="#UID">UID</a> order.</p>
|
|
<p class="comment">searchArray : (array) *( propertyName => propertyValue )
|
|
propertyName : (string) above (any case)
|
|
propertyValue : (string) value / (array) ( *[ (string) value] )
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"directory" => "import",
|
|
"filename" => "file.ics" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$searchArray = array( "PRIORITY" => array( 1, 2, 3, 4 ));
|
|
$highPrioArr = $vcalendar->selectComponents( $searchArray );
|
|
// <span class="comment">select all components with PRIORITY set to high (1-4)</span>
|
|
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();
|
|
}
|
|
exit;
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_object_methods">[up]</a>
|
|
|
|
<a name="setComponent"></a><h4>3.1.3.6 setComponent</h4>
|
|
<p>
|
|
Replace or update component in the iCalcreator object instance.
|
|
Also add a <strong>calendar</strong> component to the iCalcreator object instance
|
|
when <strong>calendar</strong> component is created with the procedural (<b>non</b>-factory) method,
|
|
see example <a href="#vevent_constr">VEVENT</a>, format 2.
|
|
</p>
|
|
<p>A successful update returns TRUE.</p>
|
|
<p class="label">format 1</p>
|
|
<p>Insert last in component chain.</p>
|
|
<p class="format">vcalendar::setComponent( component )
|
|
addComponent( component ) // <span class="comment">alias</span></p>
|
|
<p class="comment">component = (object) iCalcreator component instance</p>
|
|
<p class="comment">addComponent, may be removed in future versions.</p>
|
|
<p class="label">format 2</p>
|
|
<p>
|
|
Insert/replace component with order number (1st=1, 2nd=2.. .).
|
|
If replace and orderNumber is not found, component is inserted last in chain.
|
|
</p>
|
|
<p class="format">vcalendar::setComponent( component, orderNumber )</p>
|
|
<p class="comment">component = (object) iCalcreator component instance
|
|
int = (int) order numder</p>
|
|
<p class="label">format 3</p>
|
|
<p>
|
|
Replace component with component type and 1st alt. component order number.
|
|
If orderNumber is not found, component is inserted last in chain.
|
|
</p>
|
|
<p class="format">vcalendar::setComponent( component, componentType [, componentSuborderNo])</p>
|
|
<p class="comment">component = (object) iCalcreator component instance
|
|
componentType = (string) component type
|
|
componentSuborderNo = (int) component Suborder Number</p>
|
|
<p class="label">format 4</p>
|
|
<p>
|
|
Replace component with <a href="#UID">UID</a>.
|
|
N.B <a href="#UID">UID</a> is NOT set for <a href="#VALARM">ALARM</a> / <a href="#VTIMEZONE">TIMEZONE</a> components.
|
|
If <a href="#UID">UID</a> is not found, component is inserted last in chain.
|
|
</p>
|
|
<p class="format">vcalendar::setComponent( component, <a href="#UID">UID</a> )</p>
|
|
<p class="comment">component = (object) iCalcreator component instance</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "filename" => "file.ics");
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$vevent = vcalendar->getComponent( 1 ); // <span class="comment">fetch first EVENT</span>
|
|
$vevent->setProperty( "dtstart, 2006, 12, 24, 19, 30, 00 );
|
|
// <span class="comment">update <a class="ref" href="#DTSTART">DTSTART</a> property</span>
|
|
$vcalendar->setComponent( $vevent, 1 ); // <span class="comment">replace first component</span>
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_object_methods">[up]</a>
|
|
|
|
<a name="iCalcreator_calendar_methods"></a><h3>3.1.4 iCalcreator calendar methods</h3>
|
|
|
|
<a name="parse_merge"></a><h4>3.1.4.1 parse and merge</h4>
|
|
<p>
|
|
Parse iCal file(-s) or string/array <strong>calendar</strong> content into a single iCalcreator object instance (components, properties and parameters),
|
|
including multiple vcalendars (within a single ICS file) parse, e.g. Oracle Calendar exports.
|
|
</p>
|
|
<p>
|
|
As long as php.ini directive "allow_url_fopen" is enabled, remote files, URLs; protocol "http" ("webcal"), are supported.
|
|
A remote file, URL, <b>must</b> 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.
|
|
</p>
|
|
<p>
|
|
If missing, component property <a href="#UID">UID</a> is created when parsing.
|
|
For that reason <a href="#Unique_id">UNIQUE_ID</a> might need to be set before parsing, Se examples below.
|
|
</p>
|
|
<p>
|
|
Notice <a href="#date_restriction">date restriction</a>!
|
|
</p>
|
|
<p>
|
|
If major parse error occurs (like file access error, invalid <strong>calendar</strong> file or <strong>calendar</strong> file without components), FALSE is returned.
|
|
</p>
|
|
<p>
|
|
Minor errors like non-standard line-endings, initial and trailing empty lines
|
|
as well as files without proper end line(-s) (i.e. missing component end and/or "END:CALENDAR" iCal directives)
|
|
are managed.
|
|
</p>
|
|
<p>
|
|
Non-standard iCal properties (except the <a href="#X-PROPERTY_PROP">X-properties</a>) are ignored.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::parse( [ textToParse ] )</p>
|
|
<p class="comment">textToParse = (string) calendarContent
|
|
ex. result from - file_get_contents( "filename")
|
|
(array) calendarContent
|
|
ex. result from - file( "filename", FILE_IGNORE_NEW_LINES )</p>
|
|
<p class="label">parse example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"filename" => "file.ics" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
.. .
|
|
</p>
|
|
<p class="label">parse example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"url" => "http://www.ical.net/calendars/calendar.ics" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
.. .
|
|
</p>
|
|
<p class="label">parse example 3</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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.22//",
|
|
"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 );
|
|
...
|
|
</p>
|
|
<p class="label">merge example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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->setConfig( "directory", "export" );
|
|
$vcalendar->setConfig( "filename", "icalmerge.ics" );
|
|
$vcalendar->saveCalendar();
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_calendar_methods">[up]</a>
|
|
|
|
<a name="createCalendar"></a><h4>3.1.4.2 createCalendar</h4>
|
|
Generate and return <strong>calendar</strong> in a string, testing.. .?
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::createCalendar()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $vcalendar->createCalendar();
|
|
echo $str;
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_calendar_methods">[up]</a>
|
|
|
|
<a name="returnCalendar"></a><h4>3.1.4.3 returnCalendar</h4>
|
|
<p>
|
|
Redirect the iCalcreator object instance content to user browser. Filename, addressed to browser, is automatically generated if missing or not set;<br>
|
|
<span class="format">$filename = date( "YmdHis" ).".ics" </span>.
|
|
</p>
|
|
<p>
|
|
NOTE, the method no longer stops PHP script (exit), returns TRUE on success!
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::returnCalendar( [ utf8Encode [, gzip [, cdType ]]] )</p>
|
|
<p class="comment">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
|
|
cdType = (bool) TRUE: (default) Content-Disposition: attachment
|
|
FALSE: Content-Disposition: inline</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$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();
|
|
exit;
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"directory" => "import",
|
|
"filename" => "file.ics" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$utf8Encode = TRUE;
|
|
if( isset( $_SERVER["HTTP_ACCEPT_ENCODING"] ) &&
|
|
( FALSE !== strpos( strtolower( $_SERVER["HTTP_ACCEPT_ENCODING"] ), "gzip" )))
|
|
$gzip = TRUE;
|
|
else
|
|
$gzip = FALSE;
|
|
$vcalendar->returnCalendar( $utf8Encode, $gzip );
|
|
exit;
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_calendar_methods">[up]</a>
|
|
|
|
<a name="saveCalendar"></a><h4>3.1.4.4 saveCalendar</h4>
|
|
<p>
|
|
Save the iCalcreator object instance in a file, using preset <a href="#Directory">directory</a> and <a href="#Filename">filename</a>.
|
|
Filename is automatically generated if missing or not set;<br>
|
|
<span class="format">$filename = date( "YmdHis" ).".ics" </span>.
|
|
</p>
|
|
<p>Return bool TRUE on success, on error FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::saveCalendar()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vcalendar->setConfig( array( "directory" => "depot",
|
|
"filename" => "calendar.ics" ));
|
|
if( FALSE === $vcalendar->saveCalendar()) {
|
|
echo "error when saving.. ."
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_calendar_methods">[up]</a>
|
|
|
|
<a name="sort"></a><h4>3.1.4.5 sort</h4>
|
|
<p class="label">Format 1</p>
|
|
<p>
|
|
Sort created/parsed <strong>calendar</strong> components on the following (prioritized) keys:<br>
|
|
1 - X-CURRENT-DTSTART - X-CURRENT-DTEND/X-CURRENT-DUE<br>
|
|
(if created in iCalcreator object method <a href="#selectComponents">selectComponents</a>)<br>
|
|
1 - <a href="#DTSTART">DTSTART</a> - <a href="#DTEND">DTEND</a> alt. <a href="#DURATION">DURATION</a> (<a href="#VEVENT">VEVENT</a> and <a href="#VFREEBUSY">VFREEBUSY</a> components)<br>
|
|
1 - <a href="#DTSTART">DTSTART</a> - <a href="#DUE">DUE</a> alt. <a href="#DURATION">DURATION</a> (<a href="#VTODO">VTODO</a> components)<br>
|
|
1 - <a href="#DTSTART">DTSTART</a> (<a href="#VJOURNAL">VJOURNAL</a> components)<br>
|
|
2 - <a href="#CREATED">CREATED</a> / <a href="#DTSTAMP">DTSTAMP</a><br>
|
|
3 - <a href="#UID">UID</a><br>
|
|
A date value, like "DTSTART;VALUE=DATE:20120717", are sorted before a datetime value.<br>
|
|
<a href="#VTIMEZONE">VTIMEZONE</a> component(-s) is always placed first (ordered by <a href="#TZID">TZID</a>). The
|
|
<a href="#VTIMEZONE">STANDARD</a> / <a href="#VTIMEZONE">DAYLIGHT</a> sub-components are sorted (on asc. key <a href="#DTSTART">DTSTART</a>) when calling
|
|
<a href="#createCalendar">createCalendar</a> (or <a href="#returnCalender">returnCalender</a>).
|
|
<br>
|
|
<a href="#VALARM">ALARM</a> sub-components, if exists, are not sorted.
|
|
|
|
</p>
|
|
<p class="format">vcalendar::sort()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"directory" => "import",
|
|
"filename" => "file.ics" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$vcalendar->sort();
|
|
$vcalendar->returnCalendar();
|
|
exit;
|
|
</p>
|
|
|
|
<a name="sort2"></a>
|
|
<p class="label">Format 2</p>
|
|
<p>
|
|
Sort created/parsed <strong>calendar</strong> components based on specific property values and ascending order.
|
|
If a property is not set in component, an empty sort key is used (i.e. sorted first).
|
|
</p>
|
|
<p class="format">vcalendar::sort( sortArgument )</p>
|
|
<p class="comment">sortArgument: (string) "<a href="#ATTENDEE">ATTENDEE</a>" <sup>*</sup> / "<a href="#CATEGORIES">CATEGORIES</a>" <sup>*</sup> / "<a href="#CONTACT">CONTACT</a>" <sup>*</sup> / "<a href="#DTSTAMP">DTSTAMP</a>" /
|
|
"<a href="#LOCATION">LOCATION"</a>" / "<a href="#ORGANIZER">ORGANIZER</a>" / "<a href="#PRIORITY">PRIORITY</a>" /
|
|
"<a href="#RESOURCES">RESOURCES</a>" <sup>*</sup> / "<a href="#STATUS">STATUS</a>" / "<a href="#SUMMARY">SUMMARY</a>" / "<a href="#URL">URL</a>" / "<a href="#UID">UID</a>" <sup>**</sup>.
|
|
<p class="comment"><sup>*) </sup> For a property where multiple occurrence may exist (<a href="#ATTENDEE">ATTENDEE</a>, <a href="#CATEGORIES">CATEGORIES</a>, <a href="#CONTACT">CONTACT</a>, <a href="#RESOURCES">RESOURCES</a>) lowest (alphabetic) value is used as sort key.</p>
|
|
<p class="comment"><sup>**)</sup> For multiple components with the same <a href="#UID">UID</a>, components with <a href="#RECURRENCE-ID">RECURRENCE-ID</a> / <a href="#SEQUENCE">SEQUENCE</a> set are sorted first (on asc. values) and components without <a href="#RECURRENCE-ID">RECURRENCE-ID</a> last.</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_calendar_methods">[up]</a>
|
|
|
|
<a name="useCachedCalendar"></a><h4>3.1.4.6 useCachedCalendar</h4>
|
|
<p>
|
|
If a recent version of (non-empty and saved) <strong>calendar</strong> file exists, an HTTP redirect is sent otherwise FALSE is returned.
|
|
</p>
|
|
<p>
|
|
NOTE, the method no longer stops PHP script (exit), returns bool TRUE on success, FALSE on error!
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::useCachedCalendar( [ timeout [, cdType ]] )</p>
|
|
<p class="comment">timeout = (int) default 3600 sec
|
|
cdType = (bool) TRUE: (default) Content-Disposition: attachment
|
|
FALSE: Content-Disposition: inline</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vcalendar->setConfig( "directory", "depot" );
|
|
$vcalendar->setConfig( "filename", "calendar.ics" );
|
|
$vcalendar->useCachedCalendar();
|
|
...
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_calendar_methods">[up]</a>
|
|
|
|
|
|
<a name="iCalcreatorVersion"></a><h4>3.1.4.7 iCalcreatorVersion</h4>
|
|
<p>
|
|
This static class method returns the iCalcreator class version number (2.22+).
|
|
</p>
|
|
<p>
|
|
There is also a <em>PHP</em> constant "ICALCREATOR_VERSION" (all versions).
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vcalendar::iCalcreatorVersion()</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_calendar_methods">[up]</a>
|
|
|
|
|
|
|
|
<a name="iCalcreator_configuration_methods"></a><h3>3.1.5 iCalcreator configuration methods</h3>
|
|
|
|
<a name="configKeys"></a><h4>3.1.5.1 configuration keys</h4>
|
|
<p>All configuration keys (allowEmpty, compsInfo etc.) case independent.</p>
|
|
<table>
|
|
<tr>
|
|
<td class="bl bb">key</td>
|
|
<td class="bl bb"><strong>calendar</strong></td>
|
|
<td class="bl bb">component</td>
|
|
<td class="bl bb">remark</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#allowEmpty">allowEmpty</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb ref"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#Compsinfo">Compsinfo</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb ref">getConfig only</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#Delimiter">Delimiter</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb"> </td>
|
|
<td class="bl bb ref"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#Directory">Directory</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb"> </td>
|
|
<td class="bl bb ref"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#Filename">Filename</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb"> </td>
|
|
<td class="bl bb ref"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#Dirfile">Dirfile</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb"> </td>
|
|
<td class="bl bb ref">getConfig only</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#Filesize">Filesize</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb"> </td>
|
|
<td class="bl bb ref">getConfig only</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#Format">Format</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb"> </td>
|
|
<td class="bl bb ref"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#Language">Language</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb ref"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#NewlineChar">NewlineChar</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb ref"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#setPropertyNames">setPropertyNames</a></td>
|
|
<td class="bl bb center"> </td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb ref">getConfig only</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#dTZID">TZID</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb ref"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#Unique_id">Unique_id</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb ref"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="bl bb"><a class="ref" href="#configURL">URL</a></td>
|
|
<td class="bl bb center">*</td>
|
|
<td class="bl bb"> </td>
|
|
<td class="bl bb ref"> </td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="getConfig"></a><h4>3.1.5.2 getConfig</h4>
|
|
<p class="format">vcalendar::getConfig( [ key ] )</p>
|
|
<p class="comment">key = (string) config key</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$filename = $vcalendar->getConfig( "filename" );
|
|
.. .
|
|
</p>
|
|
In this example, notice <a href="#Filename">Filename</a>
|
|
<br>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = $vcalendar->getConfig();
|
|
.. .
|
|
</p>
|
|
<p class="comment">Output= array( string key => mixed value
|
|
*[, string key => mixed value] )</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="initConfig"></a><h4>3.1.5.3 calendar/component initialization</h4>
|
|
<p class="label">Format</p>
|
|
<p>Create a new iCalcreator object instance.</p>
|
|
<p class="format">vcalendar::vcalendar( [ config ] )</p>
|
|
<p class="comment">config = (array) ( *[, key => value] )
|
|
key = (string) config key
|
|
value = (mixed) config value</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se" );
|
|
$vcalendar = new vcalendar( $config );
|
|
.. .
|
|
</p>
|
|
<p>
|
|
Do <b>NOT</b> set <a href="#Directory">directory</a>/<a href="#Filename">filename</a> in vcalendar constructor, due to inability to detect error (FALSE) config return.
|
|
</p>
|
|
<p>Create a new <strong>calendar</strong> component.</p>
|
|
<p class="format">vcalendar::component( [ config ] )</p>
|
|
<p class="comment">config = (array) ( key => value *[, key => value] )
|
|
key = (string) config key
|
|
value = (mixed) config value</p>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se" );
|
|
$vevent = new vevent( $config );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = $vcalendar->getConfig();
|
|
$vevent = new vevent( $config );
|
|
.. .
|
|
</p>
|
|
<p>Only component relevant configuration are set. If using the <a href="#newComponent">newComponent</a> function, configuration is set automatically.</p>
|
|
<br>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="setConfig"></a><h4>3.1.5.4 setConfig</h4>
|
|
<p>A successful "setConfig" returns TRUE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">vcalendar::setConfig( [ config ] )</p>
|
|
<p class="comment">config = (array) ( key => value *[, key => value] )
|
|
key = (string) config key
|
|
value = (mixed) config value</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"directory" => "import",
|
|
"filename" => "file.ics" );
|
|
$vcalendar = new vcalendar();
|
|
$vcalendar->setConfig( $config );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se" );
|
|
$vevent = new vevent();
|
|
$vevent->setConfig( $config );
|
|
.. .
|
|
</p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">vcalendar::setConfig( key, value )</p>
|
|
<p class="comment">key = (string) config key
|
|
value = (mixed) config value</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vcalendar = new vcalendar();
|
|
$vcalendar->setConfig( "directory", "depot" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent = new vevent();
|
|
$vevent->setConfig( "unique_id", "kigkonsult.se" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="allowEmpty"></a><h4>3.1.5.5 Allow empty components</h4>
|
|
<p>
|
|
Allow or reject empty <strong>calendar</strong> properties. Used in <a href="#createCalendar">createCalendar</a>, <a href="#returnCalender">returnCalender</a> or
|
|
create<Property> methods, creating [RFC5545] formats.
|
|
</p>
|
|
<p>
|
|
Default TRUE (allow).
|
|
</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Compsinfo"></a><h4>3.1.5.6 Component information</h4>
|
|
<p>Only to use with iCalcreator object method getConfig.</p>
|
|
<p>
|
|
Get information about the iCalcreator object instance components. Returns array with basic information
|
|
about all components (in array format) within the iCalcreator object instance.
|
|
</p>
|
|
<p class="comment">Output = array ( *compinfo )
|
|
compinfo = array ( "ordno" => int ordno,
|
|
// <span class="commsnt">order number (1st=1, 2nd=2..)</span>
|
|
, "type" => string type
|
|
// <span class="comment">component type (vevent, vtodo.. .</span>
|
|
, "uid" => string uid
|
|
// <span class="comment">component <a href="#UID">UID</a> (not for <a href="#VALARM">ALARM</a> / <a href="#VTIMEZONE">TIMEZONE</a>)</span>
|
|
, "props" =>
|
|
array( *[ propertyName => Property count ])
|
|
// <span class="comment">for every set property</span>
|
|
, "sub" => array( *compinfo ))
|
|
// <span class="comment">if subcomponents exists, an array for each subcomponent</span></p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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 .. . */
|
|
}
|
|
}
|
|
}
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Delimiter"></a><h4>3.1.5.7 Delimiter</h4>
|
|
<p>Directory/filename delimiter.</p>
|
|
<p>
|
|
Default <em>PHP</em> constant DIRECTORY_SEPARATOR. If used, <b>must</b> be set BEFORE filename!
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Directory"></a><h4>3.1.5.8 Directory</h4>
|
|
<p>
|
|
Local directory to store/read iCal files.
|
|
</p>
|
|
<p>
|
|
Default "<b>.</b>".
|
|
</p>
|
|
<p>
|
|
Directory <b>must</b> be set BEFORE <a href="#Filename">filename</a> and <b>must</b> exist and be writeable otherwise FALSE is returned.
|
|
If set using an config array and together with <a name="Filename"><u>Filename</u></a>, Directory are set automatically first.
|
|
When setting directory, the <em>PHP</em> realpath function is applied to speed up parse/saveCalendar methods.
|
|
When setting Directory, any previously set <a href="#configURL">URL</a> is removed.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
...
|
|
$dir = 'test';
|
|
if( FALSE === $vcalendar->setConfig( array( 'directory' => $dir )))
|
|
die( "Invalid directory $dir" );
|
|
...
|
|
</p>
|
|
<p>
|
|
For temporary calendar files, you may set directory/<a href="#Filename">filename</a> using <em>PHP</em> functions sys_get_temp_dir() and tempnam().
|
|
</p>
|
|
<p>
|
|
Do <b>NOT</b> set directory/<a href="#Filename">filename</a> in <a href="#vcalendar_constr">vcalendar</a> constructor, due to inability to detect error (FALSE) config return.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Dirfile"></a><h4>3.1.5.9 Dirfile</h4>
|
|
<p>
|
|
Only available in iCalcreator object method getConfig, returning (string) <a href="#Directory">directory</a>, <a href="#Delimiter">delimiter</a> and <a href="#Filename">filename</a>.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Fileinfo"></a><h4>3.1.5.10 Fileinfo</h4>
|
|
<p>
|
|
Only available in iCalcreator object method getConfig, giving information in array format about <a href="#Directory">directory</a>,
|
|
<a href="#Filename">filename</a> and <a href="#Filesize">filesize</a>.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$fileinfo = $vcalendar->getConfig( "fileinfo" );
|
|
.. .
|
|
</p>
|
|
<p class="comment">output = array( <directory>, <filename>, <filesize> )</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Filename"></a><h4>3.1.5.11 Filename</h4>
|
|
<p>iCal local file name, default created like (if not set):</p>
|
|
<p class="format">$filename = date( "YmdHis" ).".ics";</p>
|
|
<p class="format">$filename = date( "YmdHis" ).".xml"; <span class="comment"> // if <a href="#Format">format</a> set to "xcal"</span></p>
|
|
<p>
|
|
If not set, filename is created when requested, ex. in iCalcreator object methods <a href="#saveCalendar">saveCalendar</a> or getConfig("filename").
|
|
</p>
|
|
<p>
|
|
Local filename <b>must</b> be set AFTER setting directory (and opt. delimiter)!
|
|
Filename (and opt. directory) <b>must</b> be readable/writeable otherwise FALSE is returned.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
...
|
|
$dir = 'test';
|
|
if( FALSE === $vcalendar->setConfig( array( "directory" => $dir )))
|
|
die( "Error when config directory $dir" );
|
|
$file = 'temp.ics';
|
|
if( FALSE === $vcalendar->setConfig( array( "filename" => $file )))
|
|
die( "Error when config filename $file" );
|
|
...
|
|
</p>
|
|
<p>
|
|
For temporary calendar files, you may set <a href="#Directory">directory</a>/filename</a> using <em>PHP</em> functions sys_get_temp_dir() and tempnam().
|
|
</p>
|
|
<p>
|
|
Do <b>NOT</b> set <a href="#Directory">directory</a>/filename</a> in <a href="#vcalendar_constr">vcalendar</a> constructor, due to inability to detect error (FALSE) config return.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Filesize"></a><h4>3.1.5.12 Filesize</h4>
|
|
<p>
|
|
Only when getting configuration (using iCalcreator object method getConfig).<br>
|
|
Returns the size of the file in bytes, to be invoked<br>
|
|
- after "saveCalendar()"<br>
|
|
or<br>
|
|
- after a "setConfig( "directory" / "filename" )" and before/after "parse()".<br>
|
|
Getting the filesize for a remote file (URL) will always return zero.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Format"></a><h4>3.1.5.13 Format</h4>
|
|
<p>Format for the iCalcreator object instance output, "iCal"/"xCal", any case.</p>
|
|
<p>
|
|
"iCal" is default ([RFC5545]), "xCal" force xml formatted output, according to<br>
|
|
"draft-ietf-calsch-many-xcal-01.txt" (now obsolete).
|
|
</p>
|
|
<p>
|
|
For converting to and from XML, according to rfc6321, "xCal: The XML Format for <strong>iCalendar</strong>",use functions<br>
|
|
- <a href="#iCal2XML">iCal2XML</a> converts an iCalcreator object instance to XML<br>
|
|
- <a href="#XML2iCal">XML2iCal</a> converts XML (string/file) to an iCalcreator object instance.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Language"></a><h4>3.1.5.14 Language</h4>
|
|
<p>
|
|
Language for the iCalcreator object instance and component TEXT value properties as defined in [RFC5646].
|
|
</p>
|
|
<p>
|
|
Default empty.
|
|
</p>
|
|
<p>
|
|
If NOT set in TEXT property parameters, language from component instance "setConfig( "language", ..)" method will be used, if set,
|
|
otherwise language from <strong>calendar</strong> method "setConfig( "language", ..)" will be used, if set.
|
|
</p>
|
|
<p>
|
|
The <strong>calendar</strong> property PRODID is always recreated when setting (<strong>calendar</strong>) language
|
|
(, note <a href="#Unique_id">Unique_id</a>, below).
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="NewlineChar"></a><h4>3.1.5.15 NewlineChar</h4>
|
|
<p>
|
|
Character(s) used for carriage return + line feed (CR+LF).
|
|
</p>
|
|
<p>
|
|
Default "\r\n" as defined in [RFC5545].
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="setPropertyNames"></a><h4>3.1.5.16 setPropertyNames</h4>
|
|
<p>
|
|
Returns array of property names for all set properties in component. "X-PROP" will be used when <a href="#X-PROPERTY_PROP">X-properties</a> are set.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="dTZID"></a><h4>3.1.5.17 TZID</h4>
|
|
<p>
|
|
General timezone, will be used if no TZID parameter is supplied when setting <a href="#DTSTART">DTSTART</a>,
|
|
<a href="#DTEND">DTEND</a>, <a href="#DUE">DUE</a> or <a href="#RECURRENCE-ID">RECURRENCE-ID</a>, a TZID <b>auto completion</b>.
|
|
</p>
|
|
<p>
|
|
Default empty.
|
|
</p>
|
|
<p>
|
|
Note, some <strong>calendar</strong> software may also require calendar property <a href="#Additional_Descriptors">X-WR-TIMEZONE</a>
|
|
and vtimezone component property <a href="#Additional_Descriptors">X-LIC-LOCATION</a>
|
|
(to be set manually, examine also the <a href="#createTimezone">createTimezone</a> function).
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Unique_id"></a><h4>3.1.5.18 Unique_id</h4>
|
|
<p>
|
|
"Unique_id" is used in <strong>calendar</strong> property PRODID and component property <a href="#UID">UID</a>,
|
|
both created automatically (, if not setting <a href="#UID">UID</a> manually.
|
|
</p>
|
|
<p class="quotes">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.. .
|
|
</p>
|
|
<p>
|
|
Default <b>AUTOMATICALLY</b> generated by using <em>PHP</em> 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.
|
|
</p>
|
|
<p>
|
|
The <strong>calendar</strong> property PRODID is always recreated when setting unique_id.
|
|
</p>
|
|
<p>
|
|
If missing, the component property <a href="#UID">UID</a> is created at first use of iCalcreator object methods <a href="#createCalendar">createCalendar</a>, <a href="#returnCalendar">returnCalendar</a> or <a href="#saveCalendar">saveCalendar</a>
|
|
</p>
|
|
<p>
|
|
A strong recommendation is <b>always</b> to set unique_id, creating a new iCalcreator object or component instance,
|
|
to ensure accurate creation of all components <a href="#UID">UID</a> property, also before <a href="#parse">parse</a>, in case of missing <a href="#UID">UID</a>.
|
|
</p>
|
|
<br>
|
|
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="configURL"></a><h4>3.1.5.19 URL</h4>
|
|
<p>
|
|
When reading remote files or resources with URL (using the <a href="#parse">parse()</a> method),
|
|
protocol "http" ("webcal") and "https" are supported.
|
|
</p>
|
|
<p>
|
|
When setting URL, the previously set <a href="#Directory">Directory</a> is removed.
|
|
</p>
|
|
<p>
|
|
A remote file is identified by the file suffix ".ics", otherwise the URL is classified as a resource.
|
|
When setting URL to a remote iCal <u>file</u>, only directory need to be (re-)set,
|
|
filename remains unchanged (i.e. 1. set URL, 2. parse, 3. set directory, 4. saveCalendar).
|
|
The URL remote file <u>file</u> part can be retrieved by the vcalendar method getConfig( "filename" ).
|
|
When using a resource, filename is unset (note <a href="#Filename">filename</a>, above).
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p>Parse of remote file, then local save in "depot" folder, using original filename</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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();
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_configuration_methods">[up]</a>
|
|
|
|
<a name="Calendar_component_object_property_function_list"></a><h2>3.2 Calendar component property method list</h2>
|
|
<p>
|
|
All iCalcreator component object property methods for get/set data.<br>
|
|
For property format in detail, see
|
|
<a href="http://kigkonsult.se/downloads/dl.php?f=rfc2445" title="RFC2445" target="_blank">RFC2445</a> - Internet Calendaring and Scheduling Core Object Specification (iCalendar).
|
|
</p>
|
|
<a name="DATE_WITH_UTC_TIME"></a>
|
|
<span class="label">Notice:</span> for properties and DATE-TIME with <b>UTC</b> time.
|
|
<p class="quotes">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:
|
|
</p>
|
|
<p class="quotes">DTSTART:19980119T070000Z</p>
|
|
<p class="quotes">The <a href="#TZID">TZID</a> property parameter MUST <b>NOT</b> be applied to DATE-TIME properties
|
|
whose time values are specified in UTC.
|
|
</p>
|
|
<p>
|
|
<a name="date_restriction"></a>
|
|
<span class="label">Notice:</span> date limitation.<br>
|
|
Due to a limitation in <em>PHP</em> date functions, e.g. <span class="format">mktime</span>,
|
|
<span class="format">strtotime</span>, a date (e.g. while setting <a href="#DTSTART">DTSTART</a> property)
|
|
before "January 1 1970 00:00:00 GMT" may force a <em>PHP</em> date function to generate an error or set date to "January 1 1970".
|
|
</p>
|
|
<a name="deleteProperty_PROP"></a><h3>3.2.1 deleteProperty</h3>
|
|
Generic iCalcreator object instance delete property method,simplifying removal of <strong>calendar</strong> properties.<br>
|
|
FALSE is returned if no property exists or when end-of-properties at consecutive function calls.
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( [ PropName [, order ] )</p>
|
|
<p class="comment">propName = (string) case independent, [RFC5545] component property names,
|
|
unknown/missing propName will be used as <a href="#X-PROPERTY_PROP">X-property</a>.
|
|
order = (int) if missing 1st/next occurrence,
|
|
used with multiply (property) occurrences</p>
|
|
<p class="label">Example</p>
|
|
<p>Remove all COMMENT properties in first event component.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"directory" => "import",
|
|
"filename" => "file.ics" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$event = $vcalendar->getComponent( "vevent" );
|
|
while( $event->deleteProperty( "comment" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
<a name="getProperty_PROP"></a><h3>3.2.2 getProperty</h3>
|
|
<a name="geoLocation_PROP"></a>
|
|
<p>Generic iCalcreator component get property method, simplifying fetch of properties.</p>
|
|
<p>FALSE is returned if no property exists or when end-of-properties at consecutive function calls.</p>
|
|
<p>Using the non-standard directive "GEOLOCATION", iCalcreator returns output supporting<br>
|
|
ISO6709 "Standard representation of geographic point location by coordinates",<br>
|
|
by combining the <a href="#LOCATION">LOCATION</a> and <a href="#GEO">GEO</a> property values
|
|
(only if <a href="#GEO">GEO</a> is set).
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::getProperty( PropName [, order [, complete ]] )</p>
|
|
<p class="comment">propName = (string) case independent, [RFc5545] component property names,
|
|
unknown/missing propName will be used as <a href="#X-PROPERTY_PROP">X-property</a>.
|
|
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>)</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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" ); // <span class="comment">one occurrence</span>
|
|
$description = $vevent->getProperty( "description" ); // <span class="comment">one occurrence</span>
|
|
while( $comment = $vevent->getProperty( "comment" )) { // <span class="comment">MAY occur more than once</span>
|
|
.. .
|
|
}
|
|
}
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
<a name="parse"></a><h3>3.2.3 parse</h3>
|
|
<p>
|
|
Parse iCal component property text from a string or an array.
|
|
Each string/array row must be strict RFC5545 formatted, i.e. begin with a property name.
|
|
</p>
|
|
<p>
|
|
Complete <a href="#VALARM">ALARM</a>s, all properties included, in array format and
|
|
first array row as "BEGIN:VALARM", last as "END:VALARM"
|
|
as well as <a href="#VTIMEZONE">TIMEZONE</a> and standard/daylight subcomponents.
|
|
</p>
|
|
<p>
|
|
If major parse error occurs (like invalid <strong>calendar</strong> structure or no <strong>calendar</strong> components), FALSE is returned.
|
|
</p>
|
|
<p>
|
|
Minor errors like non-standard line-endings, initial and trailing empty lines
|
|
as well as files without proper end line(-s) (i.e. missing component end iCal directives)
|
|
are managed.
|
|
</p>
|
|
<p>
|
|
Except the <a href="#X-PROPERTY_PROP">X-properties</a>, non-standard properties are ignored.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::parse( propertyText )</p>
|
|
<p class="comment">propertyText = (string) [RFC5545] formatted property,
|
|
(array) [RFC5545] formatted properties,
|
|
property name <b>must</b> start string / rows(-s)</p>
|
|
<p class="label">example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$e = & $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( "DESCRIPTION:Project xyz Review Meeting Minutes\\n "
|
|
. "Agenda\\n "
|
|
. "1. Review of project version 1.0 requirements.\\n "
|
|
. "2. Definition of project processes.\\n "
|
|
. "3. Review of project schedule.\\n "
|
|
. "Participants: John Smith, Jane Doe, Jim Dandy\\n "
|
|
. "- It was decided that the requirements need to be signed off by \\n "
|
|
. "product marketing.\\n "
|
|
. "- Project processes were accepted.\\n "
|
|
. "- Project schedule needs to account for scheduled holidays and employee\\n "
|
|
. " vacation time. Check with HR for specific dates.\\n "
|
|
. "- New schedule will be distributed by Friday.\\n "
|
|
. "- 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");
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="setProperty_PROP"></a><h3>3.2.4 setProperty</h3>
|
|
<p>
|
|
Generic iCalcreator component object set property method, simplifying insert of properties. For properties where
|
|
multiple occurrences are allowed, last parameter is an index, implementing replaceProperty functionality.
|
|
</p>
|
|
<p>A successful update returns TRUE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( PropName, Proparg_1 *[, Proparg_n] )</p>
|
|
<p class="comment">propName = (string) case independent, [RFC5545] component property names,
|
|
unknown propName will be regarded as (a non-standard) <a href="#X-PROPERTY_PROP">X-property</a>.
|
|
Proparg_n = (mixed) property content
|
|
Last property argument is a (optional) property dependent parameters
|
|
array( *[(string) key => (string) value ] ).
|
|
A non-standard (, experimental) parameter key MUST be prefixed by "X-".
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="ACTION"></a><h3>3.2.5 ACTION</h3>
|
|
<p>
|
|
This property defines the action to be invoked when an <a href="#VALARM">VALARM</a> is triggered,
|
|
<br> "AUDIO" / "DISPLAY" / "EMAIL" / "PROCEDURE".
|
|
This property is REQUIRED and MUST NOT occur more than once. ("PROCEDURE" is deprecated in [RFC5545].)
|
|
</p>
|
|
<h5>Create ACTION</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createAction()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createAction();
|
|
.. .
|
|
</p>
|
|
<h5>Delete ACTION</h5>
|
|
<p>Remove ACTION from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "Action" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->deleteProperty( "Action" );
|
|
.. .
|
|
</p>
|
|
<h5>Get ACTION</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "Action" )</p>
|
|
<p class="comment">output = actionValue<sup>1</sup>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "Action", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => actionValue<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$action = $valarm->getProperty( "action" );
|
|
.. .
|
|
</p>
|
|
<h5>Set ACTION</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "Action", actionValue [, xparams ] )</p>
|
|
<p class="comment">actionValue<sup>1</sup> = (string) one of "AUDIO" / "DISPLAY" / "EMAIL" / "PROCEDURE"
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->setProperty( "action", "DISPLAY" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="ATTACH"></a><h3>3.2.6 ATTACH</h3>
|
|
<p>
|
|
The property provides the capability to associate a document object with a <strong>calendar</strong> 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 <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a> and <a href="#VALARM">VALARM</a> ("ACTION" "email") components.
|
|
</p>
|
|
<p>
|
|
The default value type for ATTACH is URI. The value type can also be set to BINARY to indicate inline binary encoded content (params<sup>2</sup>).
|
|
</p>
|
|
<p>
|
|
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 <a href="#createCalendar">createCalendar</a> and/or <a href="#returnCalendar">returnCalendar</a>.
|
|
</p>
|
|
<h5>Create ATTACH</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createAttach()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createAttach();
|
|
.. .
|
|
</p>
|
|
<h5>Delete ATTACH</h5>
|
|
<p>Remove ATTACH from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "ATTACH" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->deleteProperty( "ATTACH" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
Delete ATTACH property no 2.
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->deleteProperty( "ATTACH", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
Deleting all ATTACH properties.
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $valarm->deleteProperty( "ATTACH" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get ATTACH</h5>
|
|
<p>If set, returns property value(-s), otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "Attach" )</p>
|
|
<p class="comment">output = attachValue<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "ATTACH", propOrderNo/FALSE , TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value,
|
|
<p class="comment">output = array( "value" => attachValue<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "Attach", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo ATTACH</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$attach = $valarm->getProperty( "attach" );
|
|
.. .
|
|
</p>
|
|
<h5>Set ATTACH</h5>
|
|
<p>Insert property value. Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "attach", attachValue<sup>1</sup> [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">attachValue<sup>1</sup> = (string) URI / inline binary encoded content
|
|
params<sup>2</sup> = (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 = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "attach"
|
|
, "ftp://domain.com/pub/docs/agenda.doc"
|
|
, array( "FMTTYPE" => "application/binary" ));
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="ATTENDEE"></a><h3>3.2.7 ATTENDEE</h3>
|
|
<p>
|
|
The property defines an "Attendee" within a <strong>calendar</strong> component and is OPTIONAL and MUST NOT occur more than once
|
|
in a VALARM ("ACTION" "email"), OPTIONAL and MAY occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a> and <a href="#VFREEBUSY">VFREEBUSY</a> components.
|
|
</p>
|
|
<p>This value type for ATTENDEE is URI, a <strong>calendar</strong> user address.</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) ATTENDEE values.</p>
|
|
<p>You can export <strong>calendar</strong> ATTENDEE values as <a href="#iCal2vCards">vCards</a>.
|
|
<h5>Create ATTENDEE</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createAttendee()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createAttendee();
|
|
.. .
|
|
</p>
|
|
<h5>Delete ATTENDEE</h5>
|
|
<p>Remove ATTENDEE from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "ATTENDEE" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) ATTENDEE property</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->deleteProperty( "ATTENDEE" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete ATTENDEE property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->deleteProperty( "ATTENDEE", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
Deleting all ATTENDEE properties.
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $valarm->deleteProperty( "ATTENDEE" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get ATTENDEE</h5>
|
|
<p>If set, returns property value(-s), otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "Attendee" )</p>
|
|
<p class="comment">output = attendeeValue<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "ATTENDEE", propOrderNo/FALSE , TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => attendeeValue<sup>1</sup>
|
|
, "params" => array( params<sup>2</sup> ))</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "ATTENDEE", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = attendeeValue<sup>1</sup></p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$attendee = $valarm->getProperty( "attendee" );
|
|
.. .
|
|
</p>
|
|
<h5>Set ATTENDEE</h5>
|
|
<p>
|
|
Insert property value. If exist, default parameter values are removed after input (params<sup>2</sup>).
|
|
Property value must be prefixed by protocol (ftp://, http://,mailto:, file://.. . ref. rfc 1738 ),
|
|
if missing, "mailto:" is set (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 (indicating an internet mail address).
|
|
</p>
|
|
<p>
|
|
The CN, ROLE, PARTSTAT, RSVP, CUTYPE, MEMBER, DELEGATED-TO,DELEGATED-FROM, SENT-BY and DIR
|
|
properties are not accepted (i.e. removed) in a "VFREEBUSY" or "VALARM" "ATTENDEE" property content.
|
|
</p>
|
|
<p>Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "attendee", attendeeValue [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">attendeeValue<sup>1</sup> = (string) a <strong>calendar</strong> user address, a URI as defined by
|
|
[RFC 1738] or any other IANA registered form
|
|
for a URI.
|
|
params<sup>2</sup> = (array) ( [CUTYPE] [,MEMBER] [,ROLE] [,PARTSTAT]
|
|
[,RVSP] [,DELEGATED-TO] [,DELEGATED-FROM]
|
|
[,SENT-BY] [,CN] [,DIR] [,LANGUAGE]
|
|
*[,xparams] )
|
|
CUTYPE = "CUTYPE" => "INDIVIDUAL"
|
|
(An individual, <b>Default</b>)
|
|
/ "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 <strong>calendar</strong>
|
|
entity)
|
|
/ "REQ-PARTICIPANT"
|
|
(required participation, <b>Default</b>)
|
|
/ "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, <b>Default</b>)
|
|
/ "ACCEPTED"
|
|
(Event accepted)
|
|
/ "DECLINED"
|
|
(Event declined)
|
|
/ "TENTATIVE"
|
|
(Event tentatively accepted)
|
|
/ "DELEGATED"
|
|
(Event delegated)
|
|
/ "NEEDS-ACTION"
|
|
(To-do needs action, <b>Default</b>)
|
|
/ "ACCEPTED"
|
|
(To-do accepted)
|
|
/ "DECLINED"
|
|
(To-do declined)
|
|
/ "TENTATIVE"
|
|
(To-do tentatively accepted)
|
|
/ "DELEGATED"
|
|
(To-do delegated)
|
|
/ "COMPLETED"
|
|
(To-do completed.
|
|
<a href="#COMPLETED">COMPLETED</a> property
|
|
has date/time completed)
|
|
/ "IN-PROCESS"
|
|
(To-do in process of being completed)
|
|
/ "NEEDS-ACTION"
|
|
(Journal needs action, <b>Default</b>)
|
|
/ "ACCEPTED"
|
|
(Journal accepted)
|
|
/ "DECLINED"
|
|
(Journal declined)
|
|
/ (string) x-name
|
|
(Experimental status)
|
|
/ (string) iana-token
|
|
(Other IANA registered status)
|
|
RSVP = "RSVP" => (string) "TRUE"
|
|
/ "FALSE", <b>Default</b> (reply expectation)
|
|
DELEGATED-TO = "DELEGATED-TO" => array(*[(string) "single <strong>calendar</strong> user
|
|
to specified by the property
|
|
has delegated participation"])
|
|
DELEGATED-FROM = "DELEGATED-FROM" => array( *[ (string) "single <strong>calendar</strong> user that
|
|
have delegated their
|
|
participation to the
|
|
<strong>calendar</strong> user specified
|
|
by the property" ] )
|
|
SENT-BY = "SENT-BY" => (string) single <strong>calendar</strong> user that is
|
|
acting on behalf
|
|
of the <strong>calendar</strong> user
|
|
specified by the property"
|
|
LANGUAGE = "LANGUAGE" => (string) "lang<sup>*</sup>" (applies to the CN parameter value)
|
|
CN = "CN" => (string) "common name to be associated with the <strong>calendar</strong>
|
|
user specified by the property"
|
|
DIR = "DIR" => (string) "reference to a directory entry associated with
|
|
the <strong>calendar</strong> user specified by the property"
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p>
|
|
See rules in detail in <a href="http://kigkonsult.se/downloads/dl.php?f=rfc2445" title="RFC2445" target="_blank">RFC2445</a> - Internet Calendaring and Scheduling Core Object Specification (iCalendar).
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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" <span class="comment">// xparam</span>
|
|
, "x-length" => "15 min" )); <span class="comment">// xparam</span>
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
<a name="CATEGORIES"></a><h3>3.2.8 CATEGORIES</h3>
|
|
<p>
|
|
This property defines the categories for a <strong>calendar</strong> component and is OPTIONAL and MAY occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a> and <a href="#VJOURNAL">VJOURNAL</a> components.
|
|
</p>
|
|
<p>
|
|
The value type for CATEGORIES is TEXT.
|
|
</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) CATEGORIES values.</p>
|
|
|
|
<h5>Create CATEGORIES</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createCategories()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createCategories();
|
|
.. .
|
|
</p>
|
|
<h5>Delete CATEGORIES</h5>
|
|
<p>Remove CATEGORIES from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "CATEGORIES" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) CATEGORIES property</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "CATEGORIES" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete CATEGORIES property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "CATEGORIES", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Deleting all CATEGORIES properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vevent->deleteProperty( "CATEGORIES" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get CATEGORIES</h5>
|
|
<p>If set, returns property value(-s), otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "CATEGORIES" )</p>
|
|
<p class="comment">output = categoryValue<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "CATEGORIES", propOrderNo/FALSE , TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => categories<sup>1</sup>
|
|
, "params" => params<sup>3</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "CATEGORIES", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo CATEGORIES</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$categories = $valarm->getProperty( "categories" );
|
|
.. .
|
|
</p>
|
|
<h5>Set CATEGORIES</h5>
|
|
<p>Insert property value.</p>
|
|
<p>
|
|
In spite of the fact that CATEGORIES may contain a (comma separated) list of values,
|
|
a strong recommendation is to split a CATEGORIES "list" into multiple single CATEGORIES entries.
|
|
</p>
|
|
<p>Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "categories", categories [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">categories<sup>1</sup> = (string) categoryValue / (array) ( *categoryValue )
|
|
categoryValue<sup>2</sup> = (string) textual categories or subtypes of the <strong>calendar</strong> component,
|
|
can be specified as a list of categories
|
|
separated by the COMMA character
|
|
params<sup>3</sup> = (array) ( ["LANGUAGE" => (string) "<lang<sup>*</sup>>"] *[, xparams] )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "categories", "project_x" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="CLASS"></a><h3>3.2.9 CLASS</h3>
|
|
<p>
|
|
This property defines the access classification for a <strong>calendar</strong> component and is OPTIONAL
|
|
and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a> and <a href="#VJOURNAL">VJOURNAL</a> components.
|
|
</p>
|
|
<h5>Create CLASS</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createClass()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createClass();
|
|
.. .
|
|
</p>
|
|
<h5>Delete CLASS</h5>
|
|
<p>Remove CLASS from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "CLASS" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vjournal->deleteProperty( "CLASS" );
|
|
.. .
|
|
</p>
|
|
<h5>Get CLASS</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "CLASS" )</p>
|
|
<p class="comment">output = classValue<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "CLASS", FALSE , TRUE )</p>
|
|
<p class="comment">output = array "value" => classValue<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$class = $valarm->getProperty( "class" );
|
|
.. .
|
|
</p>
|
|
<h5>Set CLASS</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "class", classvalue [, xparams ] )</p>
|
|
<p class="comment">classvalue<sup>1</sup> = "PUBLIC"
|
|
/ "PRIVATE"
|
|
/ "CONFIDENTIAL"
|
|
/ (string) iana-token
|
|
/ (string) x-name
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "class", "CONFIDENTIAL" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
<a name="COMMENT"></a><h3>3.2.10 COMMENT</h3>
|
|
<p>
|
|
This property specifies non-processing information intended to provide a comment to the <strong>calendar</strong> user
|
|
and is OPTIONAL and MAY occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a>, <a href="#VFREEBUSY">VFREEBUSY</a>, <a href="#VTIMEZONE">STANDARD</a> and <a href="#VTIMEZONE">DAYLIGHT</a> components.
|
|
</p>
|
|
<p>The value type for COMMENT is TEXT.</p>
|
|
<h5>Create COMMENT</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createComment()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createComment();
|
|
.. .
|
|
</p>
|
|
<h5>Delete COMMENT</h5>
|
|
<p>Remove COMMENT from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "COMMENT" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) COMMENT property</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "COMMENT" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete COMMENT property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "COMMENT", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Deleting all COMMENT properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vevent->deleteProperty( "COMMENT" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get COMMENT</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "COMMENT" )</p>
|
|
<p class="comment">output = commentValue<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "COMMENT", propOrderNo/FALSE , TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => commentValue<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "COMMENT", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo COMMENT</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$comment = $vevent->getProperty( "comment" );
|
|
.. .
|
|
</p>
|
|
<h5>Set COMMENT</h5>
|
|
<p>Insert property value. Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "comment", commentValue [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">commentValue<sup>1</sup> = (string) Value type Text
|
|
params<sup>2</sup> = (array) (
|
|
[ "ALTREP" => (string) "<an alternate text representation, URI>"]
|
|
[, "LANGUAGE" => (string) "lang<sup>*</sup>"]
|
|
*[, xparams ] )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "comment", "this is a comment" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="COMPLETED"></a><h3>3.2.11 COMPLETED</h3>
|
|
<p>
|
|
This property defines the date and time that a <a href="#VTODO">VTODO</a> was actually completed and is OPTIONAL and MUST NOT occur more than once.
|
|
</p>
|
|
<p>The value type for COMPLETED is <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME.</p>
|
|
<p>For methods and formatting, explore the <a href="#CREATED">CREATED</a> property.</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="CONTACT"></a><h3>3.2.12 CONTACT</h3>
|
|
<p>
|
|
The property is used to represent textual contact information or alternately a reference to textual contact information
|
|
associated with the <strong>calendar</strong> component. The property is OPTIONAL and MUST NOT occur more than once in
|
|
a VFREEBUSY or MAY occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a> and
|
|
<a href="#VJOURNAL">VJOURNAL</a> components.
|
|
</p>
|
|
<p>The value type for CONTACT is TEXT.</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) CONTACT values.</p>
|
|
<p>You can export <strong>calendar</strong> CONTACT values as <a href="#iCal2vCards">vCards</a>.
|
|
<h5>Create CONTACT</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createContact()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createContact();
|
|
.. .
|
|
</p>
|
|
<h5>Delete CONTACT</h5>
|
|
<p>Remove CONTACT from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "CONTACT" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) CONTACT property<p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "CONTACT" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete CONTACT property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "CONTACT", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Deleting all CONTACT properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vevent->deleteProperty( "CONTACT" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get CONTACT</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "CONTACT" )</p>
|
|
<p class="comment">output = contactValue<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "CONTACT", propOrderNo/FALSE , TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => contactValue<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "CONTACT", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo CONTACT</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$contact = $vevent->getProperty( "contact" );
|
|
.. .
|
|
</p>
|
|
<h5>Set CONTACT</h5>
|
|
<p>Insert property value. Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "contact", contactValue [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">contactValue<sup>1</sup> = (string) Value type TEXT
|
|
params<sup>2</sup> = (array) (
|
|
[ "ALTREP" => (string) "<an alternate text representation, URI>"]
|
|
[, "LANGUAGE" => (string) "lang<sup>*</sup>"]
|
|
*[, xparams] )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$c->setProperty( "contact", "tel 012-34 56 789" )
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="CREATED"></a><h3>3.2.13 CREATED</h3>
|
|
<p>
|
|
This property specifies the date and time that the <strong>calendar</strong> information was created by
|
|
the <strong>calendar</strong> user agent in the <strong>calendar</strong> 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 <a href="#VEVENT">VEVENT</a>,
|
|
<a href="#VTODO">VTODO</a> and <a href="#VJOURNAL">VJOURNAL</a> components.
|
|
</p>
|
|
<p>The value type for CREATED is <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME.</p>
|
|
<h5>Create CREATED</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createCreated()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createCreated();
|
|
.. .
|
|
</p>
|
|
<h5>Delete CREATED</h5>
|
|
<p>Remove CREATED from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "CREATED" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "CREATED" );
|
|
.. .
|
|
</p>
|
|
<h5>Get CREATED</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "CREATED" )</p>
|
|
<p class="comment">output = createdDate<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "CREATED", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => createdDate<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$created = $vevent->getProperty( "CREATED" );
|
|
.. .
|
|
</p>
|
|
<h5>Set CREATED</h5>
|
|
<p>
|
|
Insert property value. Input date is always a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME or,
|
|
if "offset" parameter is used, converted to a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME.
|
|
Notice, use function <a href="#transformDateTime">transformDateTime</a> to change a local datetime to UTC datetime.
|
|
</p>
|
|
<p>The current UTC date-time is set if invoked without parameters.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "created", [ createdDate [, xparams ]] )</p>
|
|
<p class="comment">createdDate<sup>1</sup> = (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 ) // <span class="comment">results in a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
createdDate = (string) date/datetime string<sup>*</sup>
|
|
offset = (int) (+/-)HHmm[ss] // <span class="comment">(arr/str) local date + UTC offset will result in a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
xparams<sup>2</sup> = array( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
<br>date/datetime string<sup>*</sup> 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 <em>PHP</em> strtotime function, may (would) work
|
|
<span class="comment">(notice <a href="#date_restriction">date restriction</a>)</span></p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vtodo = & $vcalendar->newComponent( "vtodo" );
|
|
.. .
|
|
$vtodo->setProperty( "created", 2006, 8, 11, 14, 30, 35 ); // <span class="comment">11 august 2006 14.30.35 UTC</span>
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$date = array("year" => 2006, "month" => 10, "day" => 10,
|
|
"hour" => 10, "min" => 0, "sec" => 0, "tz" => "+0200");
|
|
// <span class="comment">local date + UTC offset will result in a <a class="ref" href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
$vtodo->setProperty( "created", $date );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "created" ); // <span class="comment">current UTC date-time is set if invoked without parameters</span>
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="DESCRIPTION"></a><h3>3.2.14 DESCRIPTION</h3>
|
|
<p>
|
|
This property provides a more complete textual description of the <strong>calendar</strong> component,
|
|
than that provided by the <a href="#SUMMARY">SUMMARY</a> property (, analogous to a mail BODY).
|
|
The property is OPTIONAL, MUST NOT occur more than once within <a href="#VEVENT">VEVENT</a>,
|
|
<a href="#VTODO">VTODO</a> or <a href="#VALARM">VALARM</a> (PROCEDURE) but can be specified multiple
|
|
times within a <a href="#VJOURNAL">VJOURNAL</a> <strong>calendar</strong> component. The property is REQUIRED in <a href="#VALARM">VALARM</a> (DISPLAY, EMAIL) component.
|
|
</p>
|
|
<p>The value type for DESCRIPTION is TEXT.</p>
|
|
<h5>Create DESCRIPTION</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createDescription()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createDescription();
|
|
.. .
|
|
</p>
|
|
<h5>Delete DESCRIPTION</h5>
|
|
<p>Remove DESCRIPTION from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "DESCRIPTION" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) DESCRIPTION property.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "DESCRIPTION" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete DESCRIPTION property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vjournal->deleteProperty( "DESCRIPTION", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Deleting all DESCRIPTION properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vjournal->deleteProperty( "DESCRIPTION" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get DESCRIPTION</h5>
|
|
<p>If set, returns property value(-s), otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "DESCRIPTION" )</p>
|
|
<p class="comment">output = descriptionValue<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "DESCRIPTION", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => descriptionValue<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$description = $vevent->getProperty( "description" );
|
|
.. .
|
|
</p>
|
|
<h5>Set DESCRIPTION</h5>
|
|
<p>Insert property value.</p>
|
|
<br>
|
|
Parameters will be ordered as prescribed in [RFC5545].
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "description", descriptionValue [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">descriptionValue<sup>1</sup> = (string) Value type TEXT
|
|
params<sup>2</sup> = (array) (
|
|
[ "ALTREP" => (string) "<an alternate text representation, URI>"]
|
|
[, "LANGUAGE" => (string) "lang<sup>*</sup>"]
|
|
*[, xparams ] )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "description", "This is a description" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="DTEND"></a><h3>3.2.15 DTEND</h3>
|
|
<p>
|
|
This property specifies the date and time that a <strong>calendar</strong> 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.
|
|
</p>
|
|
<p>
|
|
The default value type for DTEND is DATE-TIME, can be set to a DATE value type.
|
|
</p>
|
|
<p class="quotes">
|
|
The value type of the "DTEND" or "DUE" properties MUST match the value type of "DTSTART" property as defined in [RFC5545])
|
|
</p>
|
|
<p>
|
|
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)<br>DTSTART;VALUE=DATE:20071201<br> DTEND;VALUE=DATE:20071202.
|
|
</p>
|
|
<h5>Create DTEND</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createDtend()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createDtend();
|
|
.. .
|
|
</p>
|
|
<h5>Delete DTEND</h5>
|
|
<p>Remove DTEND from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "DTEND" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "DTEND" );
|
|
.. .
|
|
</p>
|
|
<h5>Get DTEND</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "DTEND" )</p>
|
|
<p class="comment">output = dtendDate<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "DTEND", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => dtendDate<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$dtend = $vevent->getProperty( "dtend" );
|
|
.. .
|
|
</p>
|
|
<h5>Set DTEND</h5>
|
|
<p>
|
|
Insert property value. If DATE value type is expected, "VALUE" = "DATE" <b>must</b> be set
|
|
(in params<sup>2</sup>) otherwise DATE-TIME (default) value type is set.
|
|
</p>
|
|
<p>
|
|
If no timezone parameter (tz or tzidparam below) is set (i.e.local time) and config <a href="#dTZID">TZID</a> is set,
|
|
date-time values will be set WITH timezone from config.
|
|
Notice, use function <a href="#transformDateTime">transformDateTime</a> to change a datetime from one time zone to another.
|
|
</p>
|
|
<p>Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "dtend", dtendDate [, params<sup>2</sup> ] )
|
|
<p class="comment">dtendDate<sup>1</sup> = (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])
|
|
// <span class="comment">timestamp without tz will result in a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
// <span class="comment">timestamp with tz=offset will result in a local DATE-TIME</span>
|
|
dtendDate = (string) date/datetime string<sup>*</sup>
|
|
// <span class="comment">Within the "VFREEBUSY" <strong>calendar</strong> component,</span>
|
|
// <span class="comment">the time MUST be specified in the <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
tz = (string) <timezone identifier> / offset
|
|
// <span class="comment">timezone will be used as tzidparam (below), if tzidparam not set</span>
|
|
offset = (int) (+/-)HHmm[ss] // <span class="comment">(arr/str) local date + UTC offset</span>
|
|
// <span class="comment">will result in a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
params<sup>2</sup> = (array) ([ tzidparam/datetimeparam/dateparam ] *[,xparams])
|
|
tzidparam = "TZID" => (string) <timezone identifier>
|
|
// <span class="comment">output as local date-time with timezone identifier</span>
|
|
// <span class="comment">if tzidparam="GMT"/"UTC" then</span>
|
|
// <span class="comment">output date-time is suffixed by 'Z'</span>
|
|
datetimeparam = "VALUE" => "DATE-TIME" // <span class="comment">default, output as date-time</span>
|
|
dateparam = "VALUE" => "DATE" // <span class="comment">output as DATE, ex. all-day event</span>
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
<br>date/datetime string<sup>*</sup> 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 <em>PHP</em> strtotime function, may (would) work
|
|
<span class="comment">(notice <a href="#date_restriction">date restriction</a>)</span></p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "dtend", 2006, 8, 11, 16, 30, 0 ); <span class="comment">// 11 august 2006 16.30.00 local date</span>
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vfreebusy->setProperty( "dtend", 2006, 8, 11, 16, 30, 0, "-040000" );
|
|
<span class="comment">// 11 august 2006 16.30.00 -040000</span>
|
|
<span class="comment">// local date + UTC offset will result in a <a class="ref" href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "dtend"
|
|
, array( "year" =>, 2006, "month" => 8, "day"=> 11 )
|
|
, array( "VALUE" => "DATE" ));
|
|
<span class="comment">// end of an all-day event</span>
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 4</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$calendar->setConfig( 'TZID', 'Europe/Stockholm' );
|
|
.. .
|
|
$vevent->setProperty( "dtend", 2006, 8, 11, 7, 30, 0 );
|
|
<span class="comment">// output: DTEND;TZID=Europe/Stockholm:20060811T073000</span>
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="DTSTAMP"></a><h3>3.2.16 DTSTAMP</h3>
|
|
<p>
|
|
The property indicates the date/time the instance of the <strong>iCalendar</strong> object was created and is OPTIONAL and
|
|
MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a>
|
|
and <a href="#VFREEBUSY">VFREEBUSY</a> components. However, DTSTAMP is <b>AUTOMATICALL§Y GENERATED</b> in iCalcreator when creating a component.
|
|
</p>
|
|
<p>
|
|
DTSTAMP may be required when importing iCal files into some <strong>calendar</strong> software<br>(MS etc.),
|
|
as well as (<strong>calendar</strong>) <a href="#X-PROPERTY">x-properties</a> "X-WR-CALNAME", "X-WR-CALDESC" and<br>"X-WR-TIMEZONE",
|
|
<a href="#METHOD">METHOD</a> property (value PUBLISH etc.) and the (also auto created) <a href="#UID">UID</a> property.
|
|
</p>
|
|
<p>The value type for DTSTAMP is <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME.</p>
|
|
<p>For methods and formatting, explore the <a href="#CREATED">CREATED</a> property.</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) DTSTAMP values.</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="DTSTART"></a><h3>3.2.17 DTSTART</h3>
|
|
<p>
|
|
This property specifies when the <strong>calendar</strong> component begins.
|
|
The property is OPTIONAL and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a>,
|
|
<a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a> and <a href="#VFREEBUSY">VFREEBUSY</a> components.
|
|
The property is REQUIRED, but MUST NOT occur more than once in <a href="#VTIMEZONE">STANDARD</a> and <a href="#VTIMEZONE">DAYLIGHT</a> components.
|
|
</p>
|
|
<p>The default value type for DTSTART is DATE-TIME, can be set to a DATE value type.</p>
|
|
<p>
|
|
For an "all-day event" and using timeless dates, example (2007-12-01)<br>
|
|
DTSTART;VALUE=DATE:20071201<br>
|
|
DTEND;VALUE=DATE:20071202. // <span class="comment">opt., in effect midnight of the day <u>before</u> the date!!</span>
|
|
</p>
|
|
<p>For methods and formatting, explore the <a href="#DTEND">DTEND</a> property.</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="DUE"></a><h3>3.2.18 DUE</h3>
|
|
<p>
|
|
This property defines the date and time when a <a href="#VTODO">VTODO</a> is expected to be completed
|
|
and is OPTIONAL and MUST NOT occur more than once and only if DURATION NOT occurs.
|
|
</p>
|
|
<p>
|
|
The default value type for DUE is DATE-TIME, can be set to a DATE value type.
|
|
</p>
|
|
<p class="quotes">
|
|
The value type of the "DTEND" or "DUE" properties MUST match the value type of "DTSTART" property as defined in [RFC5545])
|
|
</p>
|
|
<p>For methods and formatting, explore the <a href="#DTEND">DTEND</a> property.</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="DURATION"></a><h3>3.2.19 DURATION</h3>
|
|
<p>The property specifies a positive duration of time.</p>
|
|
<dl>
|
|
<dt>In a <a href="#VEVENT">VEVENT</a>
|
|
<dd>it is OPTIONAL and MUST NOT occur more than once and MUST NOT occur in pair with DTEND. If one occurs, so MUST NOT the other.<br>
|
|
<dt>In a <a href="#VTODO">VTODO</a>
|
|
<dd>it is OPTIONAL and MUST NOT occur more than once and MUST NOT occur in pair with DUE. If one occurs, so MUST NOT the other.<br>
|
|
<dt>In a <a href="#VFREEBUSY">VFREEBUSY</a>
|
|
<dd>it is OPTIONAL and MUST NOT occur more than once. ([RFC2445])<br>
|
|
<dd>it can not appear. ([RFC5545])<br>
|
|
<dt>In a <a href="#VALARM">VALARM</a>
|
|
<dd>it is OPTIONAL and MUST NOT occur more than once and MUST occur in pair with TRIGGER. If one occurs, so MUST the other.
|
|
</dl>
|
|
<p>
|
|
If any hour/minute/second duration part is set, all parts are included in output (ex. one hour duration: "PT1H0M0S").
|
|
</p>
|
|
<h5>Create DURATION</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createDuration()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createDuration();
|
|
.. .
|
|
</p>
|
|
<h5>Delete DURATION</h5>
|
|
<p>Remove DURATION from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "DURATION" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->deleteProperty( "DURATION" );
|
|
.. .
|
|
</p>
|
|
<h5>Get DURATION</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "DURATION" )</p>
|
|
<p class="comment">output = duration<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "DURATION", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => duration<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$duration = $vtodo->getProperty( "duration" );
|
|
.. .
|
|
</p>
|
|
<p class="label">option</p>
|
|
<p>
|
|
If a 4th argument is used and set to TRUE, returned output is in a DATE-TIME
|
|
output format (like <a href="#DTEND">DTEND</a> / <a href="#DUE">DUE</a>), based on
|
|
<a href="#DTSTART">DTSTART</a> value with the added DURATION value (incl. opt. timezone).
|
|
</p>
|
|
<h5>Set DURATION</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "duration", duration [, xparams ] )</p>
|
|
<p class="comment">
|
|
duration<sup>1</sup> = (array) ( "week" => (int) week )
|
|
duration<sup>1</sup> = 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"
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example 1</p>
|
|
<p>One day duration.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->setProperty "duration" , array( "day" => 1 ));
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Four hours duration.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->setProperty( "duration", "PT4H" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="EXDATE"></a><h3>3.2.20 EXDATE</h3>
|
|
<p>
|
|
This property defines the list of date/time exceptions for a recurring <strong>calendar</strong> component and is OPTIONAL
|
|
and MAY occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a> components.
|
|
</p>
|
|
<p>The default value type for EXDATE is DATE-TIME, can be set to a DATE value type.</p>
|
|
<h5>Create EXDATE</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createExdate()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createExdate();
|
|
.. .
|
|
</p>
|
|
<h5>Delete EXDATE</h5>
|
|
<p>Remove EXDATE from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "EXDATE" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->deleteProperty( "EXDATE" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<P>Delete EXDATE property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vjournal->deleteProperty( "EXDATE", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Deleting all EXDATE properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vjournal->deleteProperty( "EXDATE" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get EXDATE</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "EXDATE" )<p>
|
|
<p class="comment">output = exdates<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "exdate", propOrderNo/FALSE, TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => exdates<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "EXDATE", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo EXDATE</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$exdate = $vtodo->getProperty( "exdate" );
|
|
.. .
|
|
</p>
|
|
<h5>Set EXDATE</h5>
|
|
<p>Insert property value.</p>
|
|
<p>The value type for EXDATE should match the <a href="#DTSTART">DTSTART</a> value type.</p>
|
|
<p>
|
|
If DATE value type is set in params ("VALUE" = "DATE"), all timezone or offset in dates are ignored.<br>
|
|
If no "VALUE" value type is set or if DATE-TIME value type or TZID value is set in params, DATE-TIME (default) value type is set.
|
|
</p>
|
|
<p>
|
|
If "TZID" is set in params,
|
|
all timezone or offset in dates are ignored (note timestamp, below) and DATE-TIME value type is set.<br>
|
|
If empty params and offset in 1st date, all remaining (non-timestamp) dates are set to UTC.<br>
|
|
If no "TZID" is set in params and timezone in 1st date, all remaining dates are within this timezone and param "TZID" is set.<br>
|
|
If none of the above rules are applicable, DATE-TIME and local date is set default.
|
|
</p>
|
|
<p>
|
|
Notice, use function <a href="#transformDateTime">transformDateTime</a> to convert a datetime from one time zone to another.
|
|
</p>
|
|
<p>EXDATEs are automatically sorted in ascending order (Y-m-d[-H-i-s]).</p>
|
|
<p>
|
|
In spite of the fact that EXDATE may contain a (comma separated) list of values,
|
|
a strong recommendation is to split a EXDATE "list" into multiple single EXDATE entries.
|
|
</p>
|
|
<p>Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "exdate", exdates [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">exdates<sup>1</sup> = (array) ( date *[, date ] )
|
|
date = array( (int) year
|
|
, (int) month
|
|
, (int) day
|
|
[, (int) hour
|
|
, (int) min
|
|
, (int) sec
|
|
[, tz ]] )
|
|
date<sup>1</sup> = (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])
|
|
// <span class="comment">timestamp without tz will result in a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
date = (string) date/datetime string<sup>*</sup>
|
|
tz = (string) <timezone identifier> / offset
|
|
// <span class="comment">timezone will be used as tzidparam (below), if tzidparam not set</span>
|
|
offset = (int) (+/-)HHmm[ss] // <span class="comment">(arr/str) local date + UTC offset will result in a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
params<sup>2</sup> = (array) ([(datetimeparam/dateparam) / tzidparam] *[,xparams])
|
|
datetimeparam = "VALUE" => "DATE-TIME" // <span class="comment">default, output as date-time</span>
|
|
dateparam = "VALUE" => "DATE" // <span class="comment">output as DATE</span>
|
|
tzidparam = "TZID" => (string) <timezone identifier>
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
<br>date/datetime string<sup>*</sup> 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 <em>PHP</em> strtotime function, may (would) work
|
|
<span class="commsnt">(notice <a href="#date_restriction">date restriction</a>)</span></p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "exdate", array( array( 2006, 8, 14, 16, 0, 0 ));
|
|
<span class="comment">// exclude 2006-08-14 16.00.00 (local date) from recurrence pattern</span>
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "exdate"
|
|
, array( array("year" =>,2006,"month" => 8,"day"=> 11))
|
|
, array( "VALUE" => "DATE" ));
|
|
<span class="comment">// exclude 2006-08-11 from recurrence pattern;</span>
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="EXRULE"></a><h3>3.2.21 EXRULE</h3>
|
|
<p>
|
|
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 <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a> components.
|
|
</p>
|
|
<p>EXRULE is deprecated in [RFC5545]!</p>
|
|
<h5>Create EXRULE</h5>
|
|
<p>If set, returns [RFC2445] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createExrule()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createExrule();
|
|
.. .
|
|
</p>
|
|
<h5>Delete EXRULE</h5>
|
|
<p>Remove EXRULE from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "EXRULE" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->deleteProperty( "EXRULE" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete EXRULE property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vjournal->deleteProperty( "EXRULE", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Deleting all EXRULE properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vjournal->deleteProperty( "EXRULE" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get EXRULE</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "EXRULE" )</p>
|
|
<p class="comment">output = recur<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "exrule", propOrderNo/FALSE, TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => recur<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "EXRULE", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo EXRULE</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$exrule = $vtodo->getProperty( "exrule" );
|
|
.. .
|
|
</p>
|
|
<h5>Set EXRULE</h5>
|
|
<p>
|
|
Insert property value.
|
|
Notice, use function <a href="#transformDateTime">transformDateTime</a>to change a local datetime to a UTC datetime.
|
|
</p>
|
|
<p>Parameters, will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "exrule", recur [, xparams [, propOrderNo ]] )</p>
|
|
See rules in detail in <a href="http://kigkonsult.se/downloads/dl.php?f=rfc2445" title="RFC2445" target="_blank">RFC2445</a> - Internet Calendaring and Scheduling Core Object Specification (iCalendar).
|
|
<p class="comment">recur<sup>1</sup> = (array) ( "FREQ" => freq
|
|
// <span class="comment">either UNTIL or COUNT may appear in a "recur",
|
|
but UNTIL and COUNT MUST NOT occur in the same "recur"</span>
|
|
[, "UNTIL" "=>" >enddate ]
|
|
[, "COUNT" "=>" 1*DIGIT ]
|
|
// <span class="comment">the rest of these keywords are optional,
|
|
but MUST NOT occur more than once</span>
|
|
[, "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 // <span class="comment">a DATE value or a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME value</span>
|
|
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 ) // <span class="comment">results in a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
date = (string) date/datetime string<sup>*</sup>
|
|
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 and SATURDAY 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
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
<br>date/datetime string<sup>*</sup> 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 <em>PHP</em> strtotime function, may (would) work
|
|
<span class="comment">(notice <a href="#date_restriction">date restriction</a>)</span></p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "Exrule"
|
|
, array( "FREQ" => "MONTHLY"
|
|
, "UNTIL" => "20060831"
|
|
// <span class="comment">DATE / DATE-TIME in <a class="ref" href="#DATE_WITH_UTC_TIME">UTC</a> format; string/array, see <a class="ref" href="#CREATED">CREATED</a> format</span>
|
|
, "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( "key" => "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( "key" => "xparamValue" ));
|
|
// <span class="comment">(*) single value/array of values</span>
|
|
// <span class="comment">(**) single value array /array of arrays</span>
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="FREEBUSY_PROP"></a><h3>3.2.22 FREEBUSY</h3>
|
|
<p>
|
|
The property defines one or more free or busy time intervals in a <a href="#VFREEBUSY">VFREEBUSY</a>
|
|
<strong>calendar</strong> component.
|
|
<p>
|
|
<p>The value type for FREEBUSY is PERIOD. A PERIOD is a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME/DATE-TIME or a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME/duration.</p>
|
|
<h5>Create FREEBUSY</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createFreebusy()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createfreebusy();
|
|
.. .
|
|
</p>
|
|
<h5>Delete FREEBUSY</h5>
|
|
<p>Remove FREEBUSY from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "FREEBUSY" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) FREEBUSY property</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vfreebusy->deleteProperty( "FREEBUSY" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete FREEBUSY property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vfreebusy->deleteProperty( "FREEBUSY", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Deleting all FREEBUSY properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vfreebusy->deleteProperty( "FREEBUSY" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get FREEBUSY</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "FREEBUSY" )</p>
|
|
<p class="comment">output = array( "fbtype" => freebusytype<sup>1</sup> , periods<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "FREEBUSY", propOrderNo/FALSE , TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => array("fbtype" => freebusytype<sup>1</sup> ,periods<sup>2</sup>)
|
|
, "params" => xparams<sup>3</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "FREEBUSY", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo FREEBUSY</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$freebusy = $vfreebusy->getProperty( "FREEBUSY" );
|
|
.. .
|
|
</p>
|
|
<h5>Set FREEBUSY</h5>
|
|
Insert property value. A FREEBUSY input date is always a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME.
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "freebusy",freebusytype,fbperiods [,xparams [,propOrderNo ]] )</p>
|
|
<p class="comment">freebusytype<sup>1</sup> = one of "FREE"
|
|
/ "BUSY" <b>Default</b>
|
|
/ "BUSY-UNAVAILABLE"
|
|
/ "BUSY-TENTATIVE"
|
|
/ x-name
|
|
fbperiods = (array) ( periods<sup>2</sup> )
|
|
periods<sup>2</sup> = (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 ) // <span class="comment">output format</span>
|
|
startdate/enddate = (array) ( "timestamp" => (int) timestamp ) // <span class="comment">results in a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
startdate/enddate = (string) datetime string<sup>*</sup>
|
|
// <span class="comment">startdate/enddate MUST be an <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
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 ]] ); // <span class="comment">output format</span>
|
|
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"
|
|
xparams<sup>3 </sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
<br>date/datetime string<sup>*</sup> 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 <em>PHP</em> strtotime function, may (would) work
|
|
<span class="comment">(notice <a href="#date_restriction">date restriction</a>)</span></p>
|
|
<p class="label">Example</p>
|
|
See rules in detail in <a href="http://kigkonsult.se/downloads/dl.php?f=rfc2445" title="RFC2445" target="_blank">RFC2445</a> - Internet Calendaring and Scheduling Core Object Specification (iCalendar).
|
|
<p class="example"><?php
|
|
.. .
|
|
$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 ); // <span class="comment">duration for 6 hours</span>
|
|
$fdur8 = "P2D"; // <span class="comment">duration two days</span>
|
|
$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 )));
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="GEO"></a><h3>3.2.23 GEO</h3>
|
|
<p>
|
|
This property specifies information related to the global position for the activity specified by
|
|
<a href="#VEVENT">VEVENT</a> and <a href="#VTODO">VTODO</a> components and is OPTIONAL and MUST NOT occur more than once.
|
|
</p>
|
|
<p>Value type for latitude and longitude is FLOAT.</p>
|
|
<p class="quotes">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.</p>
|
|
<p>The output (float) latitude and longitude values are presented up to six decimals.</p>
|
|
<p>Using the non-standard directive "GEOLOCATION" when calling iCalcreator
|
|
<a href="#geoLocation"><em>calendar</em></a> or <a href="#geoLocation_PROP">component</a>
|
|
getProperty method, iCalcreator returns output supporting<br>
|
|
ISO6709 "Standard representation of geographic point location by coordinates"<br>
|
|
by combining the <a href="#LOCATION">LOCATION</a> and <a href="#GEO">GEO</a> property values
|
|
(only if <a href="#GEO">GEO</a> is set).
|
|
</p>
|
|
<h5>Create GEO</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createGeo()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createGeo();
|
|
.. .
|
|
</p>
|
|
<h5>Delete GEO</h5>
|
|
<p>Remove GEO from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "GEO" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "GEO" );
|
|
.. .
|
|
</p>
|
|
<h5>Get GEO</h5>
|
|
<p>If set, returns GEO property value (latitude/longitude) as prescribed in [RFC5545], otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "GEO" )</p>
|
|
<p class="comment">output = array( "latitude" => <latitude>
|
|
, "longitude" => <longitude>))</p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "GEO", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => array ( "latitude" => <latitude>
|
|
, "longitude" => <longitude>))
|
|
, "params" => xparams<sup>1</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$geo = $vevent->getProperty( "GEO" );
|
|
.. .
|
|
</p>
|
|
<h5>Set GEO</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "geo", latitude, longitude [, xparams ] )</p>
|
|
<p class="comment">latitude = (float) latitude
|
|
longitude = (float) longitude
|
|
xparams<sup>1</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "geo", 11.23456, -23.45678 );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="LAST-MODIFIED"></a><h3>3.2.24 LAST-MODIFIED</h3>
|
|
<p>
|
|
The property specifies the date and time that the information associated with the <strong>calendar</strong>
|
|
component was last revised in the <strong>calendar</strong> store.
|
|
The property is OPTIONAL and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a>,
|
|
<a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a> and <a href="#VTIMEZONE">VTIMEZONE</a> components.
|
|
</p>
|
|
<p>The value type for LAST-MODIFIED is <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME.</p>
|
|
<p>For methods and formatting, explore the <a href="#CREATED">CREATED</a> property.</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="LOCATION"></a><h3>3.2.25 LOCATION</h3>
|
|
<p>
|
|
The property defines the intended venue for the activity defined by a <strong>calendar</strong> component.
|
|
The property is OPTIONAL and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a> and <a href="#VTODO">VTODO</a> components.
|
|
</p>
|
|
<p>The value type for LOCATION is TEXT.</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) LOCATION values.</p>
|
|
<p>Using the non-standard directive "GEOLOCATION" when calling iCalcreator
|
|
<a href="#geoLocation"><em>calendar</em></a> or <a href="#geoLocation_PROP">component</a>
|
|
getProperty method, iCalcreator returns output supporting<br>
|
|
ISO6709 "Standard representation of geographic point location by coordinates",<br>
|
|
by combining the <a href="#LOCATION">LOCATION</a> and <a href="#GEO">GEO</a> property values
|
|
(only if <a href="#GEO">GEO</a> is set).
|
|
</p>
|
|
<h5>Create LOCATION</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createLocation()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createLocation();
|
|
.. .
|
|
</p>
|
|
<h5>Delete LOCATION</h5>
|
|
<p>Remove LOCATION from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "LOCATION" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "LOCATION" );
|
|
.. .
|
|
</p>
|
|
<h5>Get LOCATION</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "LOCATION" )</p>
|
|
<p class="comment">output = location<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "LOCATION", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => location<sup>1</sup>
|
|
, "params" => param<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$location = $vevent->getProperty( "LOCATION" );
|
|
.. .
|
|
</p>
|
|
<h5>Set LOCATION</h5>
|
|
<p>Insert property value.</p>
|
|
<p>Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "location", location [, param] )</p>
|
|
<p class="comment">location<sup>1</sup> = (string) Value type TEXT
|
|
params<sup>2</sup> = (array) ( ["ALTREP" => (string) "<an alternate text representation, URI>"]
|
|
[, "LANGUAGE" => (string) "lang<sup>*</sup>"]
|
|
*[, xparams ]
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "location", "Buckingham Palace" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="ORGANIZER"></a><h3>3.2.26 ORGANIZER</h3>
|
|
<p>
|
|
The property defines the organizer for a <strong>calendar</strong> component and is OPTIONAL
|
|
and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>,
|
|
<a href="#VJOURNAL">VJOURNAL</a> and <a href="#VFREEBUSY">VFREEBUSY</a> components.
|
|
</p>
|
|
<p>This value type for ORGANIZER is URI, a <strong>calendar</strong> user address.</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) ORGANIZER values.</p>
|
|
<p>You can export <strong>calendar</strong> ORGANIZER values as <a href="#iCal2vCards">vCards</a>.
|
|
<h5>Create ORGANIZER</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createOrganizer()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createOrganizer();
|
|
.. .
|
|
</p>
|
|
<h5>Delete ORGANIZER</h5>
|
|
<p>Remove ORGANIZER from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "ORGANIZER" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "ORGANIZER" );
|
|
.. .
|
|
</p>
|
|
<h5>Get ORGANIZER</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "ORGANIZER" )</p>
|
|
<p class="comment">output = organizer<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "ORGANIZER", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => organizer<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$organizer = $vevent->getProperty( "ORGANIZER" );
|
|
.. .
|
|
</p>
|
|
<h5>Set ORGANIZER</h5>
|
|
<p>Insert property value.
|
|
Property value must be prefixed by protocol (ftp://, http://,mailto:, file://.. . ref. rfc 1738), "mailto:" prefixed if missing.
|
|
Also DIR parameter must be prefixed by protocol.
|
|
SENT-BY parameter must use protocol "mailto:", prefixed if missing.
|
|
</p>
|
|
<p>Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "organizer", organizer [, params] )</p>
|
|
<p class="comment">organizer<sup>1</sup> = (string) a <strong>calendar</strong> user address (cal-address), a URI as defined by
|
|
[RFC 1738] or any other IANA registered form for a URI.
|
|
params<sup>2</sup> = (array) ( [ "LANGUAGE" => (string) "lang<sup>*</sup>" (applies to the CN parameter value) ]
|
|
[, "CN" => (string) "common name to be associated with the
|
|
<strong>calendar</strong> user specified by the property"]
|
|
[, "DIR" => (string) "reference to a directory entry associated
|
|
with the <strong>calendar</strong> user specified by the property" ]
|
|
[, "SENT-BY" => (string) (cal-address, above)
|
|
"single <strong>calendar</strong> user that is acting on behalf
|
|
of the <strong>calendar</strong> user specified by the property" ]
|
|
*[, xparams ]
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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" ));
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="PERCENT-COMPLETE"></a><h3>3.2.27 PERCENT-COMPLETE</h3>
|
|
<p>
|
|
This property is used by an assignee or delegatee of a <a href="#VTODO">VTODO</a> to
|
|
convey the percent completion of a <a href="#VTODO">VTODO</a> to the Organizer and is
|
|
OPTIONAL and MUST NOT occur more than once.
|
|
</p>
|
|
<p>
|
|
The property value is a positive integer between zero and one hundred.
|
|
A value of "0" indicates the <a href="#VTODO">VTODO</a> has not yet been started.
|
|
A value of "100" indicates that the <a href="#VTODO">VTODO</a> has been completed.
|
|
Integer values in between indicate the percent partially complete.
|
|
</p>
|
|
<h5>Create PERCENT-COMPLETE</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createPercentComplete()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createPercentComplete();
|
|
.. .
|
|
</p>
|
|
<h5>Delete PERCENT-COMPLETE</h5>
|
|
<p>Remove PERCENT-COMPLETE from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "PERCENT-COMPLETE" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->deleteProperty( "PERCENT-COMPLETE" )
|
|
.. .
|
|
</p>
|
|
<h5>Get PERCENT-COMPLETE</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "PERCENT-COMPLETE" )</p>
|
|
<p class="comment">output = percent<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "PRIORITY", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => percent<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$percent = $vtodo->getProperty( "PERCENT-COMPLETE" );
|
|
.. .
|
|
</p>
|
|
<h5>Set PERCENT-COMPLETE</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "Percent-Complete", percent [, xparams ] )</p>
|
|
<p class="comment">percent<sup>1</sup> = (int) Value type INTEGER
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->setProperty( "percent-complete", 90 );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="PRIORITY"></a><h3>3.2.28 PRIORITY</h3>
|
|
<p>
|
|
The property defines the relative priority for a <strong>calendar</strong> component and is OPTIONAL
|
|
and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a> and <a href="#VTODO">VTODO</a> components.
|
|
</p>
|
|
<p>
|
|
The priority is specified as an integer in the range zero to nine.<br>
|
|
A value of zero (US-ASCII decimal 48) specifies an undefined priority.<br>
|
|
A value of one (US-ASCII decimal 49) is the highest priority.<br>
|
|
A value of two (US-ASCII decimal 50) is the second highest priority.<br>
|
|
Subsequent numbers specify a decreasing ordinal priority.<br>
|
|
A value of nine (US-ASCII decimal 58) is the lowest priority.
|
|
</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) PRIORITY values.</p>
|
|
<h5>Create PRIORITY</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createPriority()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createPriority();
|
|
.. .
|
|
</p>
|
|
<h5>Delete PRIORITY</h5>
|
|
<p>Remove PRIORITY from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "PRIORITY" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "PRIORITY" );
|
|
.. .
|
|
</p>
|
|
<h5>Get PRIORITY</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "PRIORITY" )</p>
|
|
<p class="comment">output = priority<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "PRIORITY", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => priority<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$priority = $vevent->getProperty( "priority" );
|
|
.. .
|
|
</p>
|
|
<h5>Set PRIORITY</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "priority", priority [, xparams ] )</p>
|
|
<p class="comment">priority<sup>1</sup> = (int) Value type INTEGER
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "priority", 3 );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="RDATE"></a><h3>3.2.29 RDATE</h3>
|
|
<p>
|
|
This property defines the list of date/times for a recurrence set and is OPTIONAL and MAY occur
|
|
more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a>,
|
|
<a href="#VTIMEZONE">STANDARD</a> and <a href="#VTIMEZONE">DAYLIGHT</a> components.
|
|
</p>
|
|
<p>
|
|
The default value type for RDATE is DATE-TIME, can be set to DATE or PERIOD (params<sup>2</sup>).
|
|
In <a href="#VTIMEZONE">STANDARD</a> and <a href="#VTIMEZONE">DAYLIGHT</a> components, RDATE MUST be specified as a date-time value type with local time value.
|
|
</p>
|
|
<h5>Create RDATE</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createRdate()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createRdate();
|
|
.. .
|
|
</p>
|
|
<h5>Delete RDATE</h5>
|
|
<p>Remove RDATE from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "RDATE" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) RDATE property.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->deleteProperty( "RDATE" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete RDATE property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vjournal->deleteProperty( "RDATE", 2 );</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Delete all RDATE properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vjournal->deleteProperty( "RDATE" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get RDATE</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "RDATE" )</p>
|
|
<p class="comment">output = dates<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "RDATE", propOrderNo/FALSE , TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => dates<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "RDATE", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo RDATE</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$rdates = $vevent->getProperty( "RDATE" );
|
|
.. .
|
|
</p>
|
|
<h5>Set RDATE</h5>
|
|
<p>Insert property value.</p>
|
|
<p>The value type for RDATE should match the <a href="#DTSTART">DTSTART</a> value type.</p>
|
|
<p>
|
|
If DATE value type is set in params ("VALUE" = "DATE"), all timezone or offset in dates are ignored.<br>
|
|
If no "VALUE" value type is set or if DATE-TIME value type or TZID value is set in params, DATE-TIME (default) value type is set.
|
|
</p>
|
|
<p>
|
|
If "TZID" is set in params,
|
|
all timezone or offset in dates are ignored (note timestamp, below) and DATE-TIME value type is set.<br>
|
|
If empty params and offset in 1st date, all remaining (non-timestamp) dates are set to UTC.<br>
|
|
If no "TZID" is set in params and timezone in 1st date, all remaining dates are within this timezone and param "TZID" is set.<br>
|
|
If none of the above rules are applicable, DATE-TIME and local date is set default.
|
|
</p>
|
|
<p>
|
|
Notice, use function <a href="#transformDateTime">transformDateTime</a> to convert a datetime from one time zone to another.
|
|
</p>
|
|
<p>RDATEs are automatically sorted in ascending order (Y-m-d[-H-i-s]).</p>
|
|
<p>
|
|
In spite of the fact that RDATE may contain a (comma separated) list of values,
|
|
a strong recommendation is to split a RDATE "list" into multiple single RDATE entries.
|
|
</p>
|
|
<p>Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "rdate", dates [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">dates<sup>1</sup> = (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 ]] )
|
|
// <span class="comment">output format</span>
|
|
date = (array) ( "timestamp" => (int) timestamp [, "tz" => tz ] )
|
|
// <span class="comment">timestamp without tz will result in a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
date = (string) date/datetime string<sup>*</sup>
|
|
tz = <timezone identifier> / offset
|
|
// <span class="comment">timezone will be used as tzidparam, if tzidparam not set</span>
|
|
offset = (int) (+/-)HHmm[ss] // <span class="comment">(arr/str) local date + UTC offset will result in a <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
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 ]] );
|
|
// <span class="comment">output format, only used keys</span>
|
|
duration = (array) ( "sec" => (int) sec );
|
|
duration = (string) duration like "P15DT5H0M20S"
|
|
params<sup>2</sup> = ([tzidparam ( / datetimeparam / dateparam / periodparam )] *[, xparams ] )
|
|
tzidparam = "TZID" => (string) <timezone identifier>
|
|
// <span class="comment">output as local DATE-TIME with timezone identifier</span>
|
|
// <span class="comment">if tzidparam="GMT"/"UTC" then</span>
|
|
// <span class="comment">output date-time is suffixed by 'Z'</span>
|
|
datetimeparam = "VALUE" => "DATE-TIME" // <span class="comment">default, output as DATE-TIME</span>
|
|
dateparam = "VALUE" => "DATE" // <span class="comment">output as DATE</span>
|
|
periodparam = "VALUE" => "PERIOD" // <span class="comment">output as PERIOD (datetime)</span>
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
<br>date/datetime string<sup>*</sup> 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 <em>PHP</em> strtotime function, may (would) work
|
|
<span class="comment">(notice <a href="#date_restriction">date restriction</a>)</span></p>
|
|
<p class="label">Example</p>
|
|
See rules in detail in <a href="http://kigkonsult.se/downloads/dl.php?f=rfc2445" title="RFC2445" target="_blank">RFC2445</a> - Internet Calendaring and Scheduling Core Object Specification (iCalendar).<br>
|
|
<p class="example"><?php
|
|
.. .
|
|
// $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 );
|
|
<span class="comment">// duration for 6 hours</span>
|
|
$rdur8 = array( "week" => 8 );
|
|
<span class="comment">// duration for 8 weeks</span>
|
|
|
|
$vevent = & $vcalendar->newComponent( "vevent" );
|
|
$vevent->setProperty( "rdate", array( $rdate1 ));
|
|
<span class="comment">// one recurrence date, date in 7-params format (DATE-TIME)</span>
|
|
|
|
$vevent->setProperty( "rdate", array( $rdate1, $rdate2 ));
|
|
<span class="comment">// two dates, date 7-params format (DATE-TIME)</span>
|
|
|
|
$vevent->setProperty( "rdate", array( array( $rdate1, $rdate2 )
|
|
, array( $rdate3, $rdate4 ))
|
|
, array( "VALUE" => "PERIOD" ));
|
|
<span class="comment">// Both fromdate and enddate must have 7 params (DATE-TIME) !!!</span>
|
|
|
|
$vevent->setProperty( "rdate", array( array( $rdate2, $rdur6 ))
|
|
, array( "VALUE" => "PERIOD" ));
|
|
<span class="comment">// one duration (fromdate-duration)</span>
|
|
|
|
$vevent->setProperty( "rdate", array( array( $rdate1, $date2 )
|
|
, array( $rdate3, $rdur7 ))
|
|
, array( "VALUE" => "PERIOD" ));
|
|
<span class="comment">// period, pairs of fromdate+enddate and fromdate-duration</span>
|
|
|
|
$vevent->setProperty( "rdate", array( $rdate5, $date8 ))
|
|
, array( "VALUE" => "DATE" ));
|
|
<span class="comment">// dates in DATE format</span>
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="RECURRENCE-ID"></a><h3>3.2.30 RECURRENCE-ID</h3>
|
|
<p>
|
|
This property is used in conjunction with the <a href="#UID">UID</a> and <a href="#SEQUENCE">SEQUENCE</a>
|
|
property to identify a specific instance of a recurring <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>
|
|
or <a href="#VJOURNAL">VJOURNAL</a> <strong>calendar</strong> component and is OPTIONAL and MAY NOT occur more than once.
|
|
</p>
|
|
<p>
|
|
The property value is the effective value of the <a href="#DTSTART">DTSTART</a> property of the recurrence instance.
|
|
The default value type is DATE-TIME, can be set to DATE (params<sup>2</sup>).
|
|
</p>
|
|
<p>For methods and formatting, explore the <a href="#DTEND">DTEND</a> property.</p>
|
|
<p>
|
|
The calendar method <a href="#sort2">SORT</a> with argument <a href="#UID">UID</a> also use RECURRENCE-ID / <a href="#SEQUENCE">SEQUENCE</a> as
|
|
sort parameters.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="RELATED-TO"></a><h3>3.2.31 RELATED-TO</h3>
|
|
<p>
|
|
The property is used to represent a relationship or reference between one <strong>calendar</strong> component and another
|
|
and is OPTIONAL and MAY occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a> components.
|
|
</p>
|
|
<p>
|
|
The property value consists of the persistent, globally unique identifier of another <strong>calendar</strong> component.
|
|
This value would be represented in a <strong>calendar</strong> component by the <a href="#UID">UID</a> property.
|
|
</p>
|
|
<p>
|
|
The value type for RELATED-TO is TEXT.
|
|
</p>
|
|
|
|
<h5>Create RELATED-TO</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createRelatedTo()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createRelatedTo();
|
|
.. .
|
|
</p>
|
|
<h5>Delete RELATED-TO</h5>
|
|
<p>Remove RELATED-TO from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "RELATED-TO" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete /single/first) RELATED-TO property</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->deleteProperty( "RELATED-TO" )</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete RELATED-TO property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vjournal->deleteProperty( "RELATED-TO", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Deleting all RELATED-TO properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vjournal->deleteProperty( "RELATED-TO" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get RELATED-TO</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "RELATED-TO" )</p>
|
|
<p class="comment">output = relid<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "RELATED-TO", propOrderNo/FALSE , TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => relid<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "RELATED-TO", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo RELATED-TO</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$relatedId = $vtodo->getProperty( "RELATED-TO" );
|
|
.. .
|
|
</p>
|
|
<h5>Set RELATED-TO</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "Related-To", relid [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">relid<sup>1</sup> = (string) Value type TEXT.
|
|
params<sup>2</sup> = (array) ( [ reltype ] *[, xparams] )
|
|
reltype = "RELTYPE" => ("PARENT" (Default)
|
|
/ "CHILD"
|
|
/ "SIBLING"
|
|
/ (string) iana-token
|
|
/ (string) x-name )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->setProperty( "related-to", "19960401-080045-4000F192713@host.com");
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
<a name="REPEAT"></a><h3>3.2.32 REPEAT</h3>
|
|
<p>
|
|
This property defines the number of time the <a href="#VALARM">ALARM</a> should be repeated, after the initial trigger.
|
|
If the <a href="#VALARM">ALARM</a> triggers more than once, then this property MUST be specified along with the <a href="#DURATION">DURATION</a> property.
|
|
</p>
|
|
<p>The value type for REPEAT is INTEGER.</p>
|
|
<h5>Create REPEAT</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createRepeat()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createRepeat();
|
|
.. .
|
|
</p>
|
|
<h5>Delete REPEAT</h5>
|
|
<p>Remove REPEAT from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "REPEAT" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->deleteProperty( "REPEAT" );
|
|
.. .
|
|
</p>
|
|
<h5>Get REPEAT</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "REPEAT" )</p>
|
|
<p class="comment">output = repeatTimes<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "REPEAT", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => repeatTimes<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$repeat = $vtodo->getProperty( "REPEAT" );
|
|
.. .
|
|
</p>
|
|
<h5>Set REPEAT</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "repeat", repeatTimes [, xparams ] )</p>
|
|
<p class="comment">repeatTimes<sup>1</sup> = (int) Value type INTEGER
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->setProperty( "repeat", 2 );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="REQUEST-STATUS"></a><h3>3.2.33 REQUEST-STATUS</h3>
|
|
<p>
|
|
This property defines the status code returned for a scheduling request and is OPTIONAL and
|
|
MAY occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a> and <a href="#VFREEBUSY">VFREEBUSY</a> components.
|
|
</p>
|
|
<p>The value type for REQUEST-STATUS is TEXT and consists of</p>
|
|
<dl>
|
|
<dt>a short return status component,
|
|
<dd>(in output) a PERIOD character separated 3-tuple of integers, ex 3.11
|
|
<dt>a longer return status description component
|
|
<dt>optionally a statusspecific data component
|
|
</dl>
|
|
<h5>Create REQUEST-STATUS</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createRequestStatus()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createRequestStatus();
|
|
.. .
|
|
</p>
|
|
<h5>Delete REQUEST-STATUS</h5>
|
|
<p>Remove REQUEST-STATUS from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "REQUEST-STATUS" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) REQUEST-STATUS property.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->deleteProperty( "REQUEST-STATUS" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete REQUEST-STATUS property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vjournal->deleteProperty( "REQUEST-STATUS", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Deleting all REQUEST-STATUS properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vjournal->deleteProperty( "REQUEST-STATUS" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get REQUEST-STATUS</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "REQUEST-STATUS" )</p>
|
|
<p class="comment">output = array( "statcode" => statcode<sup>1</sup>
|
|
, "text" => errtext<sup>2</sup>
|
|
[ , "extdata" => extraData<sup>3</sup> ] )</p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "REQUEST-STATUS", propOrderNo/FALSE, TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => array( "statcode" => statcode<sup>1</sup>
|
|
, "text" => errtext<sup>2</sup>
|
|
[ , "extdata" => extraData<sup>3</sup> ] )
|
|
, "params" => params<sup>4</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "REQUEST-STATUS", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo REQUEST-STATUS</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$requestStatus = $vtodo->getProperty( "REQUEST-STATUS" );
|
|
.. .
|
|
</p>
|
|
<h5>Set REQUEST-STATUS</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "Request-Status"
|
|
, statcode, errtext [,extraData/FALSE [,params [,propOrderNo]]])</p>
|
|
<p class="comment">statcode<sup>1</sup> = (int) Hierarchical, numeric return status code
|
|
(1*DIGIT "." 1*DIGIT 1*DIGIT)
|
|
errtext<sup>2</sup> = (string) Textual status description
|
|
extraData<sup>3</sup> = (string) Textual exception data.
|
|
For example, the offending property name and value
|
|
or complete property line.
|
|
params<sup>4</sup> = (array) ( ["LANGUAGE" => (string) "lang<sup>*</sup>"] *[, xparams ] )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vfreebusy->setProperty("request-status"
|
|
, 2.00
|
|
, "Invalid property value"
|
|
, "DTSTART:96-Apr-31");
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="RESOURCES"></a><h3>3.2.34 RESOURCES</h3>
|
|
<p>
|
|
This property defines the equipment or resources anticipated for an activity specified by a <strong>calendar</strong> entity
|
|
and is OPTIONAL and MAY occur more than once in <a href="#VEVENT">VEVENT</a> and <a href="#VTODO">VTODO</a> components.
|
|
</p>
|
|
<p>The value type for RESOURCES is TEXT.</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) RESOURCES values.</p>
|
|
<h5>Create RESOURCES</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createResources()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createResources();
|
|
.. .
|
|
</p>
|
|
<h5>Delete RESOURCES</h5>
|
|
<p>Remove RESOURCES from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "RESOURCES" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) RESOURCES property.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "RESOURCES" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete RESOURCES property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "RESOURCES", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Delete all RESOURCES properties.<p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vevent->deleteProperty( "RESOURCES" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get RESOURCES</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "RESOURCES" )</p>
|
|
<p class="comment">output = resources<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "RESOURCES", propOrderNo/FALSE, TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => resources<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "RESOURCES", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo RESOURCES</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$resources = $vtodo->getProperty( "RESOURCES" );
|
|
.. .
|
|
</p>
|
|
<h5>Set RESOURCES</h5>
|
|
<p>Insert property value.</p>
|
|
<p>
|
|
In spite of the fact that RESOURCES may contain a (comma separated) list of values,
|
|
a strong recommendation is to split a RESOURCES "list" into multiple single RESOURCES entries.
|
|
</p>
|
|
<p>Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "resources", resources [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">resources<sup>1</sup> = (string) resource / (array) ( *resource )
|
|
resource = (string) textual resources or subtypes of the <strong>calendar</strong> component,
|
|
can be specified as a list of resources
|
|
separated by the COMMA character.
|
|
params<sup>2</sup> = (array) (
|
|
[ "ALTREP" => (string) "<an alternate text representation, URI>"]
|
|
[, "LANGUAGE" => (string) "lang<sup>*</sup>"]
|
|
*[, xparams] )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "resources", "COMPUTER PROJECTOR" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="RRULE"></a><h3>3.2.35 RRULE</h3>
|
|
<p>
|
|
This property defines a rule or repeating pattern for recurring <a href="#VEVENT">EVENTs</a>, <a href="#VTODO">TODOs</a>,
|
|
<a href="#VTIMEZONE">STANDARD</a> or <a href="#VTIMEZONE">DAYLIGHT</a> definitions and is OPTIONAL and MAY occur more than once ([RFC2445]),
|
|
SHOULD NOT occur more than once ([RFC5545]).
|
|
</p>
|
|
<h5>Create RRULE</h5>
|
|
<p>If set, returns iCal formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createRrule()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createRrule();
|
|
.. .
|
|
</p>
|
|
<h5>Delete RRULE</h5>
|
|
<p>Remove RRULE from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "RRULE" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) RRULE property.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "RRULE" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete RRULE property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "RRULE", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Delete all RRULE properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vevent->deleteProperty( "RRULE" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get RRULE</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "RRULE" )</p>
|
|
<p class="comment">output = recur<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "RRULE", propOrderNo/FALSE, TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => recur<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( "RRULE", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo RRULE</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$rrules = $vtodo->getProperty( "RRULE" );
|
|
.. .
|
|
</p>
|
|
<h5>Set RRULE</h5>
|
|
<p>Insert property value.</p>
|
|
<p>Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "rrule", recur [, xparams [, propOrderNo ]] )</p>
|
|
<p>
|
|
For rules example see <a href="#EXRULE">Exrule</a> format and in detail in <a href="http://kigkonsult.se/downloads/dl.php?f=rfc2445" title="RFC2445" target="_blank">RFC2445</a> - Internet Calendaring and Scheduling Core Object Specification (iCalendar).
|
|
</p>
|
|
<p class="comment">recur<sup>1</sup> = see <a href="#EXRULE">Exrule</a>
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
<a name="SEQUENCE"></a><h3>3.2.36 SEQUENCE</h3>
|
|
<p>
|
|
This property defines the revision sequence number of the <strong>calendar</strong> component within a sequence of revisions.
|
|
The property is OPTIONAL and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a>,
|
|
<a href="#VTODO">VTODO</a> and <a href="#VJOURNAL">VJOURNAL</a> components.
|
|
</p>
|
|
<p class="quotes">
|
|
It is monotonically incremented by the <a href="#ORGANIZER">ORGANIZER's</a> CUA (Calendar
|
|
User Agent) each time the <a href="#ORGANIZER">ORGANIZER</a> makes a significant revision
|
|
to the <strong>calendar</strong> component.
|
|
<br><br>
|
|
When the <a href="#ORGANIZER">ORGANIZER</a> makes changes to one of the following
|
|
properties, the sequence number MUST be incremented: <a href="#DTSTART">DTSTART</a>,
|
|
<a href="#DTEND">DTEND</a>, <a href="#DUE">DUE</a>, <a href="#RDATE">RDATE</a>, <a href="#RRULE">RRULE</a>,
|
|
<a href="#EXDATE">EXDATE</a>, <a href="#EXRULE">EXRULE</a>, <a href="#STATUS">STATUS</a>. In addition,
|
|
changes made by the <a href="#ORGANIZER">ORGANIZER</a> to other properties can also force
|
|
the sequence number to be incremented. The <a href="#ORGANIZER">ORGANIZER</a> CUA MUST
|
|
increment the sequence number when ever it makes changes to
|
|
properties in the <strong>calendar</strong> component that the <a href="#ORGANIZER">ORGANIZER</a>
|
|
deems will jeopardize the validity of the participation status of the
|
|
<a href="#ATTENDEE">Attendees</a>. For example, changing the location
|
|
of a meeting from one locale to another distant locale could
|
|
effectively impact the participation status of the <a href="#ATTENDEE">Attendees</a>.
|
|
</p>
|
|
<p>The value type of SEQUENCE is INTEGER.</p>
|
|
<p>The calendar method <a href="#sort2">SORT</a> with argument <a href="#UID">UID</a> also use <a href="#RECURRENCE-ID">RECURRENCE-ID</a> / SEQUENCE as
|
|
sort parameters.</p>
|
|
<h5>Create SEQUENCE</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createSequence()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createSequence();
|
|
.. .
|
|
</p>
|
|
<h5>Delete SEQUENCE</h5>
|
|
<p>Remove SEQUENCE from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "SEQUENCE" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->deleteProperty( "SEQUENCE" );
|
|
.. .
|
|
</p>
|
|
<h5>Get SEQUENCE</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "SEQUENCE" )</p>
|
|
<p class="comment">output = sequence<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "SEQUENCE", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => sequence<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$sequence = $vtodo->getProperty( "SEQUENCE" );
|
|
.. .
|
|
</p>
|
|
<h5>Set SEQUENCE</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "sequence" [, sequence [, xparams ]] )</p>
|
|
<p class="comment">sequence<sup>1</sup> = (int) Value type INTEGER
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "sequence", 2 ); <span class="comment">// set sequence number to 2</span>
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "sequence" ); <span class="comment">// force sequence number to be set to 0
|
|
// or, if sequence exists, incremented by 1</span>
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="STATUS"></a><h3>3.2.37 STATUS</h3>
|
|
<p>
|
|
This property defines the overall status or confirmation for the <strong>calendar</strong> component.
|
|
The property is OPTIONAL and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>
|
|
and <a href="#VJOURNAL">VJOURNAL</a> components.
|
|
</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) STATUS values.</p>
|
|
<h5>Create STATUS</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createStatus()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createStatus();
|
|
.. .
|
|
</p>
|
|
<h5>Delete STATUS</h5>
|
|
<p>Remove STATUS from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "STATUS" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->deleteProperty( "STATUS" );
|
|
.. .
|
|
</p>
|
|
<h5>Get STATUS</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "STATUS" )</p>
|
|
<p class="comment">output = status<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "STATUS", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => status<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$status = $vtodo->getProperty( "STATUS" );
|
|
.. .
|
|
</p>
|
|
<h5>Set STATUS</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "status", status [, xparams ] )</p>
|
|
<p class="comment"> // <span class="comment">Status values for a <a href="#vevent">VEVENT</a></span>
|
|
status<sup>1</sup> = "TENTATIVE" // <span class="comment">Indicates event is tentative</span>
|
|
/ "CONFIRMED" // <span class="comment">Indicates event is definite</span>
|
|
/ "CANCELLED" // <span class="comment">Indicates event was cancelled</span>
|
|
// <span class="comment">Status values for <a href="#VTODO">VTODO</a></span>
|
|
status<sup>1</sup> = "NEEDS-ACTION" // <span class="comment">Indicates to-do needs action</span>
|
|
/ "COMPLETED" // <span class="comment">Indicates to-do completed</span>
|
|
/ "IN-PROCESS" // <span class="comment">Indicates to-do in process of</span>
|
|
/ "CANCELLED" // <span class="comment">Indicates to-do was cancelled</span>
|
|
// <span class="commsnt">Status values for <a href="#VJOURNAL">VJOURNAL</a></span>
|
|
status<sup>1</sup> = "DRAFT" // <span class="comment">Indicates journal is draft</span>
|
|
/ "FINAL" // <span class="comment">Indicates journal is final</span>
|
|
/ "CANCELLED" // <span class="comment">Indicates journal is removed</span>
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "Status", "COMPLETED" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="SUMMARY"></a><h3>3.2.38 SUMMARY</h3>
|
|
<p>
|
|
This property defines a short ("one line") summary or subject for the <strong>calendar</strong> component.
|
|
(In "[RFC5545], Recommended Practices", up to 255 characters) (, analogous to a mail SUBJECT).
|
|
The property is OPTIONAL and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>
|
|
and <a href="#VJOURNAL">VJOURNAL</a> components. The property is REQUIRED and MUST occur once in
|
|
<a href="#VALARM">VALARM</a> (EMAIL) <strong>calendar</strong> component.
|
|
</p>
|
|
<p>The value type for SUMMARY is TEXT.</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) SUMMARY values.</p>
|
|
<h5>Create SUMMARY</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createSummary()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createSummary();
|
|
.. .
|
|
</p>
|
|
<h5>Delete SUMMARY</h5>
|
|
<p>Remove SUMMARY from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "SUMMARY" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "SUMMARY" );
|
|
.. .
|
|
</p>
|
|
<h5>Get SUMMARY</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "SUMMARY" )</p>
|
|
<p class="comment">output = summary<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "SUMMARY", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => summary<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$summary = $vtodo->getProperty( "SUMMARY" );
|
|
.. .
|
|
</p>
|
|
<h5>Set SUMMARY</h5>
|
|
<p>Insert property value.</p>
|
|
<p>Parameters will be ordered as prescribed in [RFC5545].</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "summary", summary [, params ] )</p>
|
|
<p CLASS="comment">summary<sup>1</sup> = (string) Value type TEXT,
|
|
a short, one line summary about the activity or journal entry.
|
|
params<sup>2</sup> = array( ["ALTREP" => (string) "<an alternate text representation, URI>"]
|
|
[, "LANGUAGE" => (string) "lang<sup>*</sup>"]
|
|
*[, xparams ] )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "summary", "This is a summary" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="TRANSP"></a><h3>3.2.39 TRANSP</h3>
|
|
<p>
|
|
This property defines whether an <a href="#VEVENT">EVENT</a> is transparent or not to busy time searches and is OPTIONAL and MUST NOT occur more than once.
|
|
</p>
|
|
<h5>Create TRANSP</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createTransp()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createTransp();
|
|
.. .
|
|
</p>
|
|
<h5>Delete TRANSP</h5>
|
|
<p>Remove TRANSP from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "TRANSP" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "TRANSP" );
|
|
.. .
|
|
</p>
|
|
<h5>Get TRANSP</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "TRANSP" )</p>
|
|
<p class="comment">output = transp<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "TRANSP", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => transp<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$transp = $vtodo->getProperty( "TRANSP" );
|
|
.. .
|
|
</p>
|
|
<h5>Set TRANSP</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "transp", transp [, xparams ] )</p>
|
|
<p class="comment">transp<sup>1</sup> = "OPAQUE" / "TRANSPARENT"
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty( "transp", "TRANSPARENT" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="TRIGGER"></a><h3>3.2.40 TRIGGER</h3>
|
|
<p>
|
|
This property specifies when an <a href="#VALARM">ALARM</a> will trigger and is REQUIRED and MUST NOT occur more than once.
|
|
</p>
|
|
<p>
|
|
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 <a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME value.
|
|
</p>
|
|
<h5>Create TRIGGER</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">valarm::createTrigger()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createTrigger();
|
|
.. .
|
|
</p>
|
|
<h5>Delete TRIGGER</h5>
|
|
<p>Remove TRIGGER from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">valarm::deleteProperty( "TRIGGER" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->deleteProperty( "TRIGGER" );
|
|
.. .
|
|
</p>
|
|
<h5>Get TRIGGER</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">valarm::getProperty( "TRIGGER" )</p>
|
|
<p class="comment">output = duration/date</p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">valarm::getProperty( "TRIGGER", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => duration<sup>1</sup>/date<sup>3</sup> )
|
|
, "params" => params<sup>4</sup> )
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$trigger = $vtodo->getProperty( "TRIGGER" );
|
|
.. .
|
|
</p>
|
|
<h5>Set TRIGGER</h5>
|
|
<p>Insert property value.</p>
|
|
<p>Note, use function <a href="#transformDateTime">transformDateTime</a> to change a (local) datetime to UTC time zone.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">valarm::setProperty( "trigger", duration<sup>1</sup> [, params<sup>4</sup> ] )</p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">valarm::setProperty( "trigger", duration<sup>2</sup> [, params<sup>4</sup> ] )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">valqarm::setProperty( "trigger", date<sup>3</sup> [, params<sup>4</sup> ] )</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">valarm::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
|
|
[, params<sup>4</sup> ]]]]] )</p>
|
|
<p class="comment">duration<sup>1</sup> = (array) ( "week" => (int) week
|
|
, "relatedStart" => relatedStart
|
|
, "before" => before )
|
|
duration<sup>1</sup> = (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
|
|
duration<sup>2</sup> = (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"
|
|
date<sup>3</sup> = (array) ( "year" => (int) year // <span class="comment"><a href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
, "month" => (int) month
|
|
, "day" => (int) day
|
|
[, "hour" => (int) hour
|
|
, "min" => (int) min
|
|
, "sec" => (int) sec ])
|
|
date<sup>3</sup> = (array) ( "timestamp" => (int) timestamp ) // <span class="comment"><a class="ref" href="#DATE_WITH_UTC_TIME">UTC</a> DATE-TIME</span>
|
|
date<sup>3</sup> = (string) datetime string<sup>*</sup>
|
|
params<sup>4</sup> = (array) ( [[ reltype [, trigRelparam ]] / datetimeparam ] *[, xparams ] )
|
|
reltyp = "RELATED" => "START" (default) / "END"
|
|
trigRelparam = "VALUE" => "DURATION"
|
|
datetimeparam= "VALUE" => "DATE-TIME" // <span class="comment">mandatory if DATE-TIME</span>
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
<br>datetime string<sup>*</sup> 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 <em>PHP</em> strtotime function, may (would) work
|
|
<span class="comment">(notice <a href="#date_restriction">date restriction</a>)</span></p>
|
|
<p class="label">Example 1</p>
|
|
<p>A duration, 1 hour 2 min 3 sec, before start</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->setProperty( "trigger"
|
|
, FALSE, FALSE, FALSE, FALSE, 1, 2, 3 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>A duration, 1 hour 2 min 3 sec, before start</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->setProperty( "trigger"
|
|
, array ("hour"=>1,"min"=>2,"sec"=>3 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>A duration, 1 hour 2 min 3 sec, before start</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->setProperty( "trigger"
|
|
, "PT1H2M3S" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 4</p>
|
|
<p>A duration, 1 week after end.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->setProperty( "trigger"
|
|
, FALSE, FALSE, FALSE, 1
|
|
, FALSE, FALSE, FALSE, FALSE, FALSE );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 5</p>
|
|
<p>A duration, 1 week after end.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->setProperty( "trigger"
|
|
, array ( "week" => 1
|
|
, "relatedStart" => FALSE
|
|
, "before" => FALSE ));
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 6</p>
|
|
<p>A duration, 1 week after end.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->setProperty( "trigger"
|
|
, "P1W"
|
|
, array( "related" => "END" ));
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 7</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$valarm->setProperty( "trigger"
|
|
, array( "year" => 2007
|
|
, "month" => 6
|
|
, "day" => 5,
|
|
, "hour" => 2
|
|
, "min" => 2
|
|
, "sec" => 3 )
|
|
, array( "VALUE" => "DATE-TIME" ));
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="TZID"></a><h3>3.2.41 TZID</h3>
|
|
<p>
|
|
This property specifies the text value that uniquely identifies the <a href="#VTIMEZONE">VTIMEZONE</a>
|
|
<strong>calendar</strong> component and is REQUIRED, but MUST NOT occur more than once.
|
|
</p>
|
|
<p>The value type for TZID is TEXT.</p>
|
|
<h5>Create TZID</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::createTzid()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createTzid();
|
|
.. .
|
|
</p>
|
|
<h5>Delete TZID</h5>
|
|
<p>Remove TZID from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::deleteProperty( "TZID" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtimezone->deleteProperty( "TZID" );
|
|
.. .
|
|
</p>
|
|
<h5>Get TZID</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">vtimezone::getProperty( "TZID" )</p>
|
|
<p class="comment">output = tzid<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">vtimezone::getProperty( "TZID", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => tzid<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$tzid = $vtimezone->getProperty( "TZID" );
|
|
.. .
|
|
</p>
|
|
<h5>Set TZID</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::setProperty( "tzid", tzid [, xparams ] )</p>
|
|
<p class="comment">tzid<sup>1</sup> = (string) Value type TEXT
|
|
xparams<sup>2</sup> = (array)( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vtimezone = & $vcalendar->newComponent( "vtimezone" );
|
|
$vtimezone->setProperty( "tzid", "US-Eastern" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="TZNAME"></a><h3>3.2.42 TZNAME</h3>
|
|
<p>
|
|
This property specifies the customary designation for a <a href="#VTIMEZONE">STANDARD</a> or <a href="#VTIMEZONE">DAYLIGHT</a> description
|
|
and is OPTIONAL and MAY occur more than once.
|
|
</p>
|
|
<p>The value type for TZNAME is TEXT.</p>
|
|
<h5>Create TZNAME</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::createTzname()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createTzname();
|
|
.. .
|
|
</p>
|
|
<h5>Delete TZNAME</h5>
|
|
<p>Remove TZNAME from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::deleteProperty( "TZNAME" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete (single/first) TZNAME property.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtimezonestd->deleteProperty( "TZNAME" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete TZNAME property no 2.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtimezonestd->deleteProperty( "TZNAME", 2 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 3</p>
|
|
<p>Deleting all TZNAME properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vtimezonestd->deleteProperty( "TZNAME" ))
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get TZNAME</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">vtimezone::getProperty( "TZNAME" )</p>
|
|
<p class="comment">output = tzname<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">vtimezone::getProperty( "TZNAME", propOrderNo/FALSE, TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( "value" => tzname<sup>1</sup>
|
|
, "params" => params<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">vtimezone::getProperty( "TZNAME", propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo TZNAME</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$tzname = $timezonestandard->getProperty( "TZNAME" );
|
|
.. .
|
|
</p>
|
|
<h5>Set TZNAME</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::setProperty( "tzname", tzname [, params [, propOrderNo ]] )</p>
|
|
<p class="comment">tzname<sup>1</sup> = (string) Value type TEXT
|
|
params<sup>2</sup> = (array) ( [ "LANGUAGE" => (string) "lang<sup>*</sup>" ]*[, xparams ] )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
propOrderNo = (int) order number // <span class="comment">1=1st, 2=2nd etc</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="TZOFFSETFROM"></a><h3>3.2.43 TZOFFSETFROM</h3>
|
|
<p>
|
|
This property specifies the offset which is in use prior to this <a href="#VTIMEZONE">TIMEZONE</a> observance.
|
|
The property is REQUIRED, but MUST NOT occur more than once in <a href="#VTIMEZONE">STANDARD</a> and <a href="#VTIMEZONE">DAYLIGHT</a> components.
|
|
</p>
|
|
<p>The value type is UTC-OFFSET, "+" / "-" time-hour (2*DIGIT) time-minute (2*DIGIT) [time-second (2*DIGIT)].</p>
|
|
<h5>Create TZOFFSETFROM</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::createTzoffsetfrom()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createTzoffsetfrom();
|
|
.. .
|
|
</p>
|
|
<h5>Delete TZOFFSETFROM</h5>
|
|
<p>Remove TZOFFSETFROM from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::deleteProperty( "TZOFFSETFROM" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtimezonestd->deleteProperty( "TZOFFSETFROM" );
|
|
.. .
|
|
</p>
|
|
<h5>Get TZOFFSETFROM</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">vtimezone::getProperty( "TZOFFSETFROM" )</p>
|
|
<p class="comment">output = tzoffsetfrom<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">vtimezone::getProperty( "TZOFFSETFROM", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => tzoffsetfrom<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$tzoffsetfrom = $timezonestandard->getProperty( "TZOFFSETFROM" );
|
|
.. .
|
|
</p>
|
|
<h5>Set TZOFFSETFROM</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::setProperty( "tzoffsetfrom", tzoffsetfrom [, xparams ] )</p>
|
|
<p class="comment">tzoffsetfrom<sup>1</sup> = (int) (+/-)HHmm[ss] // <span class="comment">UTC offset</span>
|
|
xparams<sup>2</sup> = (array) ( *[ /string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="TZOFFSETTO"></a><h3>3.2.44 TZOFFSETTO</h3>
|
|
<p>
|
|
This property specifies the offset which is in use in this <a href="#VTIMEZONE">TIMEZONE</a> observance.
|
|
The property is REQUIRED, but MUST NOT occur more than once in <a href="#VTIMEZONE">STANDARD</a> and <a href="#VTIMEZONE">DAYLIGHT</a> components.
|
|
</p>
|
|
<p>The value type is UTC-OFFSET, "+" / "-" time-hour (2*DIGIT) time-minute (2*DIGIT) [time-second (2*DIGIT)].</p>
|
|
<h5>Create TZOFFSETTO</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::createTzoffsetto()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createTzoffsetto();
|
|
.. .
|
|
</p>
|
|
<h5>Delete TZOFFSETTO</h5>
|
|
<p>Remove TZOFFSETTO from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::deleteProperty( "TZOFFSETTO" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$daylight->deleteProperty( "TZOFFSETTO" );
|
|
.. .
|
|
</p>
|
|
<h5>Get TZOFFSETTO</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">vtimezone::getProperty( "TZOFFSETTO" )</p>
|
|
<p class="comment">output = tzoffsetto<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">vtimezone::getProperty( "TZOFFSETTO", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => tzoffsetto<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$tzoffsetto = $timezonestandard->getProperty( "TZOFFSETTO" );
|
|
.. .
|
|
</p>
|
|
<h5>Set TZOFFSETTO</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::setProperty( "tzoffsetto", tzoffsetto [, xparams ] )</p>
|
|
<p class="comment">tzoffsetto<sup>1</sup> = (int) (+/-)HHmm[ss] // <span class="comment">UTC offset</span>
|
|
xparams<sup>2</sup> = array( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="TZURL"></a><h3>3.2.45 TZURL</h3>
|
|
<p>
|
|
The TZURL provides a means for a <a href="#VTIMEZONE">VTIMEZONE</a> 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.
|
|
</p>
|
|
<p> The value type is URI.</p>
|
|
<h5>Create TZURL</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::createTzurl()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createTzurl();
|
|
.. .
|
|
</p>
|
|
<h5>Delete TZURL</h5>
|
|
<p>Remove TZURL from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::deleteProperty( "TZURL" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtimezone->deleteProperty( "TZURL" );
|
|
.. .
|
|
</p>
|
|
<h5>Get TZURL</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>.
|
|
<p class="label">Format 1</p>
|
|
<p class="format">vtimezone::getProperty( "TZURL" )</p>
|
|
<p class="comment">output = tzurl<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">vtimezone::getProperty( "TZURL", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => tzurl<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$tzurl = $timezonestandard->getProperty( "TZURL" );
|
|
.. .
|
|
</p>
|
|
<h5>Set TZURL</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">vtimezone::setProperty( "tzurl", tzurl [, xparams ] )</p>
|
|
<p class="comment">tzurl<sup>1</sup> = (string) Value type URI
|
|
xparams<sup>2</sup> = array( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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 );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="UID"></a><h3>3.2.46 UID</h3>
|
|
<p>
|
|
The persistent, globally <b>U</b>nique <b>ID</b>entifier for the <strong>calendar</strong> component.
|
|
The property is OPTIONAL and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a>, <a href="#VTODO">VTODO</a>,
|
|
<a href="#VJOURNAL">VJOURNAL</a> and <a href="#VFREEBUSY">VFREEBUSY</a> components.<br>
|
|
However, UID is <b>AUTOMATICALLY</b> generated in iCalcreator and configuration <a href="#Unique_id">unique_id</a>
|
|
is used when auto-creating component UID.
|
|
</p>
|
|
<p>UID generated format :</p>
|
|
<p class="format">date("Ymd\THisT")."-".[microSec][random]."@".<a href="#Unique_id">unique_id</a></p>
|
|
<p>
|
|
microSec = microseconds, 4 pos<br>
|
|
random = 6 characters aA-zZ, 0-9
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example">"20070803T194810CEST-0123U3PXiX@kigkonsult.se"</p>
|
|
<p>
|
|
UID may be required when importing iCal files into some <strong>calendar</strong> software (MS etc.),
|
|
as well as (<strong>calendar</strong>) properties <a href="#X-PROPERTY">x-properties</a> "X-WR-CALNAME", "X-WR-CALDESC" and "X-WR-TIMEZONE",
|
|
<a href="#METHOD">METHOD</a> (value PUBLISH etc.) and the (also automatically created) <a href="#DTSTAMP">DTSTAMP</a> property.
|
|
</p>
|
|
<p>The value type for UID is TEXT.</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) UID values.</p>
|
|
<h5>Create UID</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createUid()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createUid();
|
|
.. .
|
|
</p>
|
|
<h5>Delete UID</h5>
|
|
<p>
|
|
If UID is remove from a component, UID will automatically be recreated when iCalcreator object output methods
|
|
like <a href="#createCalendar">createCalendar</a>, <a href="#returnCalendar">returnCalendar</a>
|
|
or <a href="#saveCalendar">saveCalendar</a> is executed.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "UID" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "UID" );
|
|
.. .
|
|
</p>
|
|
<h5>Get UID</h5>
|
|
<p>If set, returns property, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "UID" )</p>
|
|
<p class="comment">output = uid<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "UID", FALSE , TRUE )</p>
|
|
<p class="comment">output = array( "value" => uid<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$uid = $vevent->getProperty( "UID" );
|
|
.. .
|
|
</p>
|
|
<h5>Set UID</h5>
|
|
<p>Insert property value, overrides any previously set or auto-created UID.</p>
|
|
<p>
|
|
Do <b>NOT</b> use an integer UID or only a component name in UID (ex. "vevent"),
|
|
this may cause malfunction in iCalcreator object method <a href="#setComponent">setComponent</a> with index or UID argument.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "uid", uid [, xparams ] )</p>
|
|
<p class="comment">uid<sup>1</sup> = (string) Value type TEXT
|
|
xparams<sup>2</sup> = array( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setProperty("uid","20070803T194810CEST-0123U3PXiX@kigkonsult.se");
|
|
.. .
|
|
</p>
|
|
<p>
|
|
BUT, due to poorly created iCal media files, a digit UID is accepted in the setProperty( UID ) and <a href="#parse_merge">parse()</a> methods.
|
|
Do check for component digit UIDs and remove it (will force a (auto) UID recreation) or (re-)set it manually.
|
|
</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
if( ctype_digit( $vevent->getProperty( "UID" )))
|
|
$vevent->deleteProperty( "UID" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="URL"></a><h3>3.2.47 URL</h3>
|
|
<p>
|
|
This property defines a Uniform Resource Locator (URL) associated with the <strong>iCalendar</strong> object.
|
|
The property is OPTIONAL and MUST NOT occur more than once in <a href="#VEVENT">VEVENT</a>,
|
|
<a href="#VTODO">VTODO</a>, <a href="#VJOURNAL">VJOURNAL</a> and <a href="#VFREEBUSY">VFREEBUSY</a> components.
|
|
</p>
|
|
<p> The value type is URI.</p>
|
|
<p>You can <a href="#sort2">SORT</a> <strong>calendar</strong> (components) on (asc) URL values.</p>
|
|
<h5>Create URL</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createUrl()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createUrl();
|
|
.. .
|
|
</p>
|
|
<h5>Delete URL</h5>
|
|
<p>Remove URL from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "URL" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "URL" );
|
|
.. .
|
|
</p>
|
|
<h5>Get URL</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "URL" )</p>
|
|
<p class="comment">output = url<sup>1</sup></p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty( "URL", FALSE , TRUE )</p>
|
|
<p class="comment">output = array "value" => url<sup>1</sup>
|
|
, "params" => xparams<sup>2</sup> )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$url = $vevent->getProperty( "URL" );
|
|
.. .
|
|
</p>
|
|
<h5>Set URL</h5>
|
|
<p>Insert property value.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( "url", url [, xparams ] )</p>
|
|
<p class="comment">url<sup>1</sup> = (string) Value type URI
|
|
xparams<sup>2</sup> = (array) ( *[ (string) key => (string) value ] ) // <span class="comment">key prefix "X-"</span>
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vtodo->setProperty( "url", "http://www.icaldomain.net" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a name="X-PROPERTY_PROP"></a><h3>3.2.48 X-PROPERTY</h3>
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>The value type is TEXT.</p>
|
|
<h5>Create X-PROPERTY</h5>
|
|
<p>If set, returns [RFC5545] formatted string, otherwise FALSE.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::createXprop()</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$str = $component->createxProp();
|
|
.. .
|
|
</p>
|
|
<h5>Delete X-PROPERTY</h5>
|
|
<p>Remove X-PROPERTY from component.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteProperty( "<X-PROPERTY>" )</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Deleting x-property named "X-PROPERTY".</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->deleteProperty( "X-PROPERTY" );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Deleting all x-properties.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
while( $vevent->deleteProperty())
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<h5>Get X-property</h5>
|
|
<p>If set, returns property value, otherwise FALSE.</p>
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getProperty( "<X-PROPERTY>" )</p>
|
|
<p class="comment">output = array( propertyName<sup>1</sup>
|
|
, propertyData<sup>2</sup> )</p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getProperty()</p>
|
|
<p class="comment">output = array( propertyName<sup>1</sup>
|
|
, propertyData<sup>2</sup> )</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getProperty( FALSE, propOrderNo/FALSE, TRUE )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">output = array( propertyName<sup>1</sup>
|
|
, array ( "value" => propertyData<sup>2</sup> )
|
|
, "params" => params<sup>3</sup>))</p>
|
|
<p class="label">Format 4</p>
|
|
<p class="format">calendarComponent::getProperty( FALSE, propOrderNo )</p>
|
|
<p class="comment">propOrderNo = (int) specific property value</p>
|
|
<p class="comment">Get propOrderNo X-property</p>
|
|
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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]; <span class="comment">// $d = array( "X-WR-TIMEZONE", propertyData<sup>2</sup> )</span>
|
|
.. .
|
|
</p>
|
|
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"filename", "file.ics" ); );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
while( $xprop = $vcalendar->getProperty( )) {<span class="comment">// $xprop = array( propertyName<sup>1</sup>, propertyData<sup>2</sup> )</span>
|
|
.. .
|
|
</p>
|
|
|
|
|
|
<p class="label">Example 3</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"filename", "file.ics" ); );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
while( $xprop = $vcalendar->getProperty( "X-ABC-MMSUBJ" )) {
|
|
.. . <span class="comment">// $xprop = array( "X-ABC-MMSUBJ", propertyData<sup>2</sup> )</span>
|
|
.. .
|
|
</p>
|
|
|
|
<p class="label">Example 4</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"filename", "file.ics" ); );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
while( $xprop = $vcalendar->getProperty( FALSE, FALSE, TRUE )) {
|
|
/*<span class="comment"> $xprop = array( propertyName<sup>1</sup>
|
|
, array( "value" => propertyData<sup>2</sup> )
|
|
, "params" => params<sup>3</sup> )</span>
|
|
*/
|
|
.. .
|
|
</p>
|
|
<h5>Set X-property</h5>
|
|
<p>Insert property name and value. If an x-prop with the same name already exists, it will be replaced.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setProperty( propertyName, propertyData [, params ] )</p>
|
|
<p class="comment">propertyName<sup>1</sup> = (string) Any property name with a "X-" prefix
|
|
propertyData<sup>2</sup> = (string) Value type TEXT
|
|
params<sup>3</sup> = (array) ( ["LANGUAGE" => (string) "lang<sup>*</sup>"] *[, xparams] )
|
|
xparams = (string) key => (string) value // <span class="comment">key prefix "X-"</span>
|
|
lang<sup>*</sup> = as defined in [RFC5646]</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$component->setProperty("X-ABC-MMSUBJ","http://load.noise.org/mysubj.wav");
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Calendar_component_object_property_function_list">[up]</a>
|
|
|
|
|
|
<a NAME="iCalcreator_component_configuration_methods"></a><h2>3.3 iCalcreator Component configuration methods</h2>
|
|
|
|
<a name="Language_PROP"></a><h3>3.3.1 Language</h3>
|
|
Language for specific <strong>calendar</strong> component as defined in [RFC5646].<br>
|
|
Language set at component level can be overridden by specific component property parameter.<br>
|
|
A successful "setConfig" returns TRUE.
|
|
<h5>Get language</h5>
|
|
Language for <strong>calendar</strong> (only if language is set at component level).
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::getConfig( "language" )</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$lang = $vevent->getConfig( "language" );
|
|
.. .
|
|
</p>
|
|
<h5>Set LANGUAGE</h5>
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::setConfig( "language", lang )</p>
|
|
<p class="comment">lang = (string) language</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$vevent->setConfig( "language", "en" );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_configuration_methods">[up]</a>
|
|
|
|
|
|
<a name="iCalcreator_component_object_misc_methods"></a><h2>3.4 iCalcreator component object misc. methods</h2>
|
|
<p>Calendar component subcomponent functions.</p>
|
|
|
|
<a name="deleteComponent_PROP"></a><h4>3.4.1 deleteComponent</h4>
|
|
Remove subcomponent from component.
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::deleteComponent( orderNumber )</p>
|
|
<p class="comment">orderNumber = (int) component order Number</p>
|
|
<p class="comment">Remove component with order number (1st=1, 2nd=2.. .).</p>
|
|
<p class="format">calendarComponent::deleteComponent( componentType [, componentSuborderNumber])</p>
|
|
<p class="comment">componentType = (string) component type
|
|
componentSuborderNumber = (int) component suborder number</p>
|
|
<p class="comment">Remove component with component type (ex. "vevent")
|
|
and order 1 alt. suborder number.</p>
|
|
<p class="format">calendarComponent::deleteComponent( <a href="#UID">UID</a> )</p>
|
|
<p class="comment">Remove component with <a href="#UID">UID</a>.
|
|
N.B <a href="#UID">UID</a> is NOT set for <a href="#VALARM">ALARM</a> / <a href="#VTIMEZONE">timezone</a> components.</p>
|
|
<p class="label">Example 1</p>
|
|
<p>Delete first subcomponent.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"filename" => "file.ics" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$comp1 = $vcalendar->getComponent();
|
|
$comp1->deleteComponent( 1 );
|
|
.. .
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p>Delete all subcomponents.</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"filename" => "file.ics" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$comp1 = $vcalendar->getComponent();
|
|
while( $comp1->deleteComponent( "valarm" )
|
|
continue;
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_configuration_methods">[up]</a>
|
|
|
|
|
|
<a name="getComponent_PROP"></a><h4>3.4.2 getComponent</h4>
|
|
Get subComponent from component.
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::getComponent()</p>
|
|
<p class="comment">Get next component until end-of-components.</p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::getComponent( int orderNumber )</p>
|
|
<p class="comment">orderNumber = (int) component order number</p>
|
|
<p class="comment">Get component with order number (1st=1, 2nd=2.. .).</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::getComponent( string componentType [, int componentSuborderNumber])</p>
|
|
<p class="comment">componentType = (string) component type
|
|
componentSuborderNumber = (int) component suborder number</p>
|
|
<p class="comment">Get (next) component with component type (until end-of-components)
|
|
alt. component with component type and suborder number (1st=1, 2nd=2..).</p>
|
|
<p class="label">Format 4</p>
|
|
<p class="format">calendarComponent::getComponent( <a href="#UID">UID</a> )</p>
|
|
<p class="comment">Get component with <a href="#UID">UID</a>.
|
|
N.B <a href="#UID">UID</a> is NOT set for <a href="#VALARM">ALARM</a> / <a href="#VTIMEZONE">timezone</a> components.</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se",
|
|
"filename" => "file.ics" );
|
|
$vcalendar = new vcalendar( $config );
|
|
$vcalendar->parse();
|
|
$comp1 = $vcalendar->getComponent());
|
|
while( $subComp = $comp1->getComponent()) {
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_configuration_methods">[up]</a>
|
|
|
|
|
|
<a name="newComponent_PROP"></a><h4>3.4.3 newComponent</h4>
|
|
Create subcomponent (<a href="#VALARM">ALARN</a> / <a href="#VTIMEZONE">VTIMEZONE STANDARD</a> / <a href="#VTIMEZONE">VTIMEZONE DAYLIGHT</a>)
|
|
using a component factory-method, returning a reference to the new component.
|
|
<p class="label">Format</p>
|
|
<p class="format">calendarComponent::newComponent( componentType )</p>
|
|
<p class="comment">componentType = (string) component type</p>
|
|
<p class="label">Example 1</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config );
|
|
...
|
|
$vevent = & $vcalendar->newComponent( "vevent" );
|
|
// <span class="comment">add some <a class="ref" href="#VEVENT">EVENT</a> properties</span>
|
|
$vevent->setProperty( "dtstart", 2006, 12, 24, 19, 30, 00 );
|
|
$vevent->setProperty(.. .
|
|
...
|
|
$valarm = & $vevent->newComponent( "valarm" );
|
|
$valarm->setProperty( "trigger", .. .
|
|
...
|
|
</p>
|
|
<p class="label">Example 2</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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(.. .
|
|
...
|
|
</p>
|
|
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_configuration_methods">[up]</a>
|
|
|
|
|
|
<a name="setComponent_PROP"></a><h4>3.4.4 setComponent</h4>
|
|
Add <strong>calendar</strong> component to the iCalcreator object instance or replace/update component in the iCalcreator object instance.
|
|
<p class="label">Format 1</p>
|
|
<p class="format">calendarComponent::setComponent( component )
|
|
addSubComponent( component ) // <span class="comment">alias</span></p>
|
|
<p class="comment">Insert last in component chain.</p>
|
|
<p class="label">Format 2</p>
|
|
<p class="format">calendarComponent::setComponent( component, int orderNumber )</p>
|
|
<p class="comment">orderNumber = (int) component order number</p>
|
|
<p class="comment">Replace component with order number(1st=1, 2nd=2.. .).
|
|
If orderNumber is not found, component is inserted last in chain.</p>
|
|
<p class="label">Format 3</p>
|
|
<p class="format">calendarComponent::setComponent( component, componentType [,componentSuborderNumber])</p>
|
|
<p class="comment">componentType = (string) component type
|
|
componentSuborderNumber = (int) component suborder number</p>
|
|
<p class="comment">Replace component with component type and component order number.
|
|
if orderNumber is not found, component is inserted last in chain. </p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => "Europe/Stockholm" );
|
|
$vcalendar = new vcalendar( $config ); // <span class="comment">initiate new CALENDAR</span>
|
|
.. .
|
|
$vevent = new vevent();
|
|
// <span class="comment">add some <a class="ref" href="#VEVENT">EVENT</a> properties</span>
|
|
$vevent->setProperty( "dtstart", 2006, 12, 24, 19, 30, 00 );
|
|
$vevent->setProperty(.. .
|
|
.. .
|
|
$valarm = new valarm();
|
|
$valarm->setProperty( "trigger", .. .
|
|
.. .
|
|
$vevent->setComponent( $valarm );
|
|
$vcalendar->setComponent( $vevent );
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalcreator_component_configuration_methods">[up]</a>
|
|
|
|
|
|
<a name="iCalUtilityFunctions"></a><h1>4 iCalUtilityFunctions</h1>
|
|
<p>
|
|
iCalUtilityFunctions class contains static functions used by iCalcreator,
|
|
also usable outside the iCalcreator class.
|
|
</p>
|
|
<dl>
|
|
<dt>"External" functions
|
|
<dd><a href="#convEolChar">4.1 convEolChar</a>
|
|
<dd><a href="#createTimezone">4.2 createTimezone</a>
|
|
<dd><a href="#ms2phpTZ">4.3 ms2phpTZ</a>
|
|
<dd><a href="#transformDateTime">4.4 transformDateTime</a>
|
|
<dt>"Internal" functions
|
|
<dd><a href="#mddtuf">4.5 Misc. date/duration/timestamp util. functions</a>
|
|
</dl>
|
|
|
|
|
|
<a name="convEolChar"></a><h4>4.1 convEolChar</h4>
|
|
<p>Removes any line-endings that may include spaces or tabs (\t)
|
|
and convert all line endings (iCal default "\r\n"),
|
|
takes care of "\r\n", "\r" and "\n" and mixed "\r\n"+"\r", "\r\n"+"\n".
|
|
</p>
|
|
<p>Returns string with controlled and corrected line endings.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">iCalUtilityFunctions::convEolChar( str, nl )</p>
|
|
<p class="comment">str = (string) string to adjust
|
|
nl = line ending to convert to
|
|
</p>
|
|
<br>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalUtilityFunctions">[up]</a>
|
|
|
|
|
|
<a name="createTimezone"></a><h4>4.2 createTimezone</h4>
|
|
<p>
|
|
The function, applied on a iCalcrator object instance and using a <em>PHP</em> valid timezone (as argument)
|
|
creates <a href="#VTIMEZONE">vtimezone</a>, <a href="#STANDARD">standard</a> and <a href="#DAYLIGHT">daylight</a> components,
|
|
based on <em>PHP</em> DateTimeZone class and the time zone transition dates.
|
|
(<em>PHP</em> 5 >= 5.2.0)
|
|
</p>
|
|
<p>
|
|
Recommendation is to call the function <b>after</b> editing components (and without (period) from/to arguments, below),
|
|
it will automatically create timezone components, starting seven month before lowest <a href="#DTSTART">DTSTART</a>
|
|
value and end 18 month after the higest.
|
|
</p>
|
|
<p>
|
|
If no time zone transition exists within date arguments or within the "<a href="#DTSTART">DTSTART</a>"s span,
|
|
then the time zone transition with the highest transistion date before "from" date is used as base.
|
|
If still missing, timezone components are created, using current date.
|
|
</p>
|
|
<p>
|
|
Note, only when timezone NOT is UTC.
|
|
For dates with UTC DATE-TIME, read <a href="#DATE_WITH_UTC_TIME">this</a>!
|
|
</p>
|
|
<p>
|
|
FALSE is returned if not using a <em>PHP</em> valid timezone.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">iCalUtilityFunctions::createTimezone( calendar, timezone [, xprops, [, from [, to ]]] )</p>
|
|
<p class="comment">calendar = (object) iCalcreator instance
|
|
timezone = (string) an <em>PHP</em> (DateTimeZone) valid timezone
|
|
xprops = (array) ( *[ x-propName => value ] ), timezone non-standard properties
|
|
from = (int) timestamp, period start date<sup>*</sup>
|
|
to = (int) timestamp, period end date<sup>*</sup>
|
|
|
|
<sup>*</sup> if empty "from" and "to" arguments, the calendar <a href="#getProperty2">getProperty</a> method (with "<a href="#DTSTART">DTSTART</a>" as argument)
|
|
is used to get the lowest (modified, minus 7 month) and highest (modified, plus 15 month) dates.
|
|
</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$tz = "Europe/Stockholm";
|
|
$config = array( "unique_id" => "kigkonsult.se", "TZID" => $tz );
|
|
$c = new vcalendar( $config );
|
|
$c->setProperty( "X-WR-TIMEZONE", $tz );
|
|
.. .
|
|
.. . // <span class="comment">insert components or parse an iCal file</span>
|
|
.. .
|
|
$xprops = array( "X-LIC-LOCATION" => $tz );
|
|
iCalUtilityFunctions::createTimezone( $c, $tz, $xprops );
|
|
.. .
|
|
</p>
|
|
<p>
|
|
Output example (when using iCalcreator object createCalendar or returnCalendar methods):
|
|
</p>
|
|
<p class="example">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
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalUtilityFunctions">[up]</a>
|
|
|
|
|
|
<a name="ms2phpTZ"></a><h4>4.3 ms2phpTZ</h4>
|
|
<p>
|
|
Conversion (very simple) of a MS timezone to a <em>PHP</em>5 valid (Date-)timezone,<br>
|
|
matching (MS) UTC offset and time zone descriptors, based on <em>PHP</em> DateTimeZone class.
|
|
(<em>PHP</em> 5 >= 5.2.0)
|
|
</p>
|
|
<p>If TRUE is returned, the MS timezone argument (below) is converted to a <em>PHP</em>5 time zone, otherwise unaltered.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">iCalUtilityFunctions::ms2phpTZ( timezone )</p>
|
|
<p class="comment">timezone = (string) MS timezone (input), PHP5 timezone (output)</p>
|
|
<p class="label">Example</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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";
|
|
.. .
|
|
</p>
|
|
<br>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalUtilityFunctions">[up]</a>
|
|
|
|
|
|
<a name="transformDateTime"></a><h4>4.4 transformDateTime</h4>
|
|
<p>
|
|
Transforms a datetime from a time zone to another. (Requires <em>PHP</em> >= 5.2.0 and <em>PHP</em> DateTimeZone acceptable time zones).
|
|
</p>
|
|
<p>
|
|
FALSE is returned if not using a "strtotime" acceptable datetime string or unacceptable <em>PHP</em> time zones.
|
|
If TRUE, the dateTime argument (below) is converted to the new time zone, otherwise unaltered.
|
|
</p>
|
|
<p>
|
|
A DATE input (<year><month><day>) will be expanded to a DATETIME (<year><month><day>000000) before transform.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">iCalUtilityFunctions::transformDateTime( dateTime, timezoneFrom [, timezoneTo [, format ]] )</p>
|
|
<p class="comment">
|
|
dateTime = (array) ( "year" => (int) year // <span class="comment">input</span>
|
|
, "month" => (int) month
|
|
, "day" => (int) day
|
|
[, "hour" => (int) hour
|
|
, "min" => (int) min
|
|
, "sec" => (int) sec ] )
|
|
dateTime = (array) ( (int) year // <span class="comment">input</span>
|
|
, (int) month
|
|
, (int) day
|
|
[, (int) hour
|
|
, (int) min
|
|
, (int) sec ] )
|
|
dateTime = (array) ( "timestamp" => (int) timestamp ) // <span class="comment">input</span>
|
|
dateTime = (string) datetime string<sup>*</sup> // <span class="comment">input</span>
|
|
dateTime = (string) datetime string // <span class="comment">on successful output</span>
|
|
timezoneFrom = (string) a <em>PHP</em> (DateTimeZone) valid time zone
|
|
timezoneTo = (string) a <em>PHP</em> (DateTimeZone) valid time zone, default "UTC"
|
|
format = (string) output format (any date formatting, default "Ymd\THis")
|
|
<br>datetime string<sup>*</sup> 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 <em>PHP</em> strtotime function, may (would) work
|
|
<span class="comment">(notice <a href="#date_restriction">date restriction</a>)</span></p>
|
|
<p class="label">Example</p>
|
|
<p>Convert from time zone "Europe/Stockholm" to "UTC"</p>
|
|
<p class="example"><?php
|
|
.. .
|
|
$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 ));
|
|
.. .
|
|
</p>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalUtilityFunctions">[up]</a>
|
|
|
|
|
|
<a name="mddtuf"></a><h4>4.5 Misc. date/duration/timestamp util. functions</h4>
|
|
<p>
|
|
iCalUtilityFunctions static date(-time)/timestamp functions.
|
|
Please examine the class file for more information about arguments and output.
|
|
</p>
|
|
<dl>
|
|
<dt>iCalUtilityFunctions::_chkDateArr( $datetime, $parno=FALSE )
|
|
<dd>Returns internal date-time/date formatted (keyed) array for an input date-time/date array (keyed or unkeyed)
|
|
<dt>iCalUtilityFunctions::_chkdatecfg( $theDate, & $parno, & $params )
|
|
<dd>Check date(-time) and params arrays for an opt. timezone and if it is a DATE-TIME or DATE (updates $parno and (opt) $params)
|
|
<dt>iCalUtilityFunctions::_date2strdate( $datetime, $parno=6 )
|
|
<dd>Returns formatted output (string) for calendar component property data value type date/date-time
|
|
<dt>iCalUtilityFunctions::_duration2arr( $duration )
|
|
<dd>Returns internal duration formatted (keyed) array for input in array format
|
|
<dt>iCalUtilityFunctions::_duration2date( $startdate, $duration )
|
|
<dd>Returns a datetime (keyed) array for a startdate+duration
|
|
<dt>iCalUtilityFunctions::_durationStr2arr( $duration )
|
|
<dd>Returns internal duration formatted (keyed) array for an input string (iCal) formatted duration
|
|
<dt>iCalUtilityFunctions::_duration2str( $duration )
|
|
<dd>Returns a formatted string for a calendar component property data value type duration
|
|
<dt>iCalUtilityFunctions::_isArrayDate( $input )
|
|
<dd>Returns bool TRUE if input contains a (array formatted) date/time
|
|
<dt>iCalUtilityFunctions::_isArrayTimestampDate( $input )
|
|
<dd>Returns bool TRUE if input array contains a timestamp date
|
|
<dt>iCalUtilityFunctions::_isOffset( $input )
|
|
<dd>Returns bool TRUE if input string contains (trailing) UTC/iCal offset
|
|
<dt>iCalUtilityFunctions::offsetSec2His( $seconds )
|
|
<dd>Returns iCal offset [-/+]hhmm[ss] (string) from UTC offset seconds
|
|
<dt>iCalUtilityFunctions::_strDate2arr( & $input )
|
|
<dd>Convert a date from specific string to (keyed) array format, returns TRUE on success
|
|
<dt>iCalUtilityFunctions::_strdate2date( $datetime, $parno=FALSE, $wtz=null )
|
|
<dd>Returns internal date-time/date formatted (keyed) array for input date-time/date in string fromat
|
|
<dt>iCalUtilityFunctions::_timestamp2date( $timestamp, $parno=6, $wtz=null )
|
|
<dd>Returns internal date-time/date formatted (keyed) array, based on a timestamp, default UTC or adjusted for offset/timezone
|
|
<dt>iCalUtilityFunctions::_tz2offset( $tz )
|
|
<dd>Returns seconds (int) from an offset, [+/-]HHmm[ss], used when correcting UTC to localtime or v.v.
|
|
</dl>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#iCalUtilityFunctions">[up]</a>
|
|
|
|
|
|
<a name="helperFunctions"></a><h1>5 Helper functions</h1>
|
|
<p>The helper functions extend the utility of iCalcreator.</p>
|
|
|
|
<a name="XMLhelpers"></a><h3>5.1 iCal and XML helper functions</h3>
|
|
<p>
|
|
The XML helper functions convert iCal into XML and parse XML into iCal.
|
|
XML is defined by [RFC6321], "xCal: The XML Format for <strong>iCalendar</strong>".
|
|
</p>
|
|
<a name="iCal2XML"></a><h4>5.1.1 iCal2XML</h4>
|
|
<p>The iCal2XML function converts an iCalcreator object instance to XML.</p>
|
|
<p>
|
|
Requires <em>PHP</em> 5 and "libxml" <em>PHP</em> extension (--enable-libxml) and utilizes the SimpleXML extension.
|
|
Before <em>PHP</em> 5.1.2, "--enable-simplexml" (at compile time) is required to enable this extension, after <em>PHP</em> 5.1.2 enabled by default.
|
|
</p>
|
|
<p>An rfc6321 XML string is returned.</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">iCal2XML( iCalobj )</p>
|
|
<p class="comment">iCalobj = (object) iCalcreator instance</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#helperFunctions">[up]</a>
|
|
|
|
<a name="XML2iCal"></a><h4>5.1.2 XML2iCal</h4>
|
|
<p>
|
|
The XML2iCal function, with the two entry functions: XMLstr2iCal and XMLfile2iCal, parse an XML string/file to an iCalcreator instance.
|
|
The function is <b>not</b> using the <em>PHP</em> SimpleXML extension.
|
|
</p>
|
|
<p>
|
|
On success, an iCalcreator instance is returned.
|
|
</p>
|
|
<p>
|
|
On XML parse error, FALSE is returned.
|
|
</p>
|
|
<h5>XMLstr2iCal</h5>
|
|
<p>
|
|
The function accepts a well-formed (rfc6321) XML string as argument.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">XMLstr2iCal( xmlstr [, config] )</p>
|
|
<p class="comment">xmlstr = (string) rfc6321 XML
|
|
config = (array) iCalcreator config array (opt)</p>
|
|
<h5>XMLfile2iCal</h5>
|
|
<p>
|
|
The function accepts an XML (rfc6321) local file or a remote URI, as argument.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">XMLfile2iCal( xmlfile [, config] )</p>
|
|
<p class="comment">xmlfile = (string) rfc6321 XML file name or resource
|
|
config = (array) iCalcreator config array (opt)</p>
|
|
<h5>XML2iCal</h5>
|
|
<p>
|
|
This function is doing the hard work in XMLstr2iCal/XMLfile2iCal functions.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">XML2iCal( xmlstr [, config] )</p>
|
|
<p class="comment">xmlstr = (string) rfc6321 XML
|
|
config = (array) iCalcreator config array (opt)</p>
|
|
<br>
|
|
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#helperFunctions">[up]</a>
|
|
|
|
|
|
<a name="vCardhelpers"></a><h3>5.2 vCard helper functions</h3>
|
|
<p>
|
|
The purpose of the vCard helper functions are to produce simplified vCard output.
|
|
</p>
|
|
<a name="iCal2vCard"></a><h4>5.2.1 iCal2vCard</h4>
|
|
<p>
|
|
Convert single <a href="#ATTENDEE">ATTENDEE</a>, <a href="#CONTACT">CONTACT</a> or
|
|
<a href="#ORGANIZER">ORGANIZER</a> URI (in email format) to simplified vCard output or saved in vCard file.
|
|
</p>
|
|
<p>
|
|
If argument directory is set, vCards are saved in (directory/) files, named like <firstName>.<familyName>."ext".
|
|
</p>
|
|
<p>
|
|
Returns vCard string or TRUE if a valid directory is used as argument (and file write ok)
|
|
otherwise FALSE.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">iCal2vCard( email [ ,version [ ,directory [ ,ext ]]] )</p>
|
|
<p class="comment">
|
|
email = (string) ATTENDEE, CONTACT or ORGANIZER URI in email format
|
|
version = (string) vCard version, default "2.1", opt. "3.0"/"4.0"
|
|
directory = (string) if and where to save vCards files (write rights required), default FALSE
|
|
ext = (string) vCard file extension, default "vcf"
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#helperFunctions">[up]</a>
|
|
|
|
<a name="iCal2vCards"></a><h4>5.2.2 iCal2vCards</h4>
|
|
<p>
|
|
Collect and convert all <a href="#ATTENDEE">ATTENDEE</a>s, <a href="#CONTACT">CONTACT</a>s and
|
|
<a href="#ORGANIZER">ORGANIZER</a>s (URI, in email format) to simplified vCard (string) output or
|
|
saved in vCard files, using <a href="#iCal2vCard">iCal2vCard</a> function (above).
|
|
</p>
|
|
<p>
|
|
The file name formatting and return values are described above in <a href="#iCal2vCard">iCal2vCard</a> function.
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">iCal2vCards( vcalendar [ ,version [ ,directory [ ,ext ]]] )</p>
|
|
<p class="comment">
|
|
vcalendar = (object) iCalcreator object instance
|
|
version = (string) vCard version, default "2.1", opt. "3.0"/"4.0"
|
|
directory = (string) if and where to save vCards files (write rights required), default FALSE
|
|
ext = (string) vCard file extension, default "vcf"
|
|
</p>
|
|
<p class="comment">
|
|
Return (bool) TRUE if argument directory is not null, otherwise vCard string.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#helperFunctions">[up]</a>
|
|
|
|
|
|
<a name="TZhelpers"></a><h3>5.3 time zone helper functions</h3>
|
|
<p>
|
|
Additional functions to use with vtimezone components.
|
|
</p>
|
|
<p>
|
|
The <a href="#getTimezonesAsDateArrays">getTimezonesAsDateArrays</a> function
|
|
creates time zone transition information, based on vtimezone components contents in a iCalcreator calendar instance.
|
|
</p>
|
|
<p>
|
|
The <a href="#getTzOffsetForDate">getTzOffsetForDate</a> function returns UTC offset information for specific date (timestamp) based on output from <a href="#getTimezonesAsDateArrays">getTimezonesAsDateArrays</a> function.
|
|
</p>
|
|
<p>
|
|
Before calling the functions <a href="#getTzOffsetForDate">getTzOffsetForDate</a> and <a href="#getTimezonesAsDateArrays">getTimezonesAsDateArrays</a>,
|
|
set time zone 'GMT' ('date_default_timezone_set')!
|
|
</p>
|
|
|
|
<a name="getTzOffsetForDate"></a><h4>5.3.1 getTzOffsetForDate</h4>
|
|
<p>
|
|
The <a href="#getTzOffsetForDate">getTzOffsetForDate</a> function returns UTC offset information for specific date (timezone) based on output from <a href="#getTimezonesAsDateArrays">getTimezonesAsDateArrays</a> function.
|
|
</p>
|
|
<p>
|
|
Before calling the function, set time zone 'GMT' ('date_default_timezone_set')!
|
|
</p>
|
|
<p>
|
|
Returns array, time zone data for specific date (timestamp) with keys for
|
|
</p>
|
|
<ul>
|
|
<li>"offsetHis" (+/-Hi[s])
|
|
<li>"offsetSec"( UTC offset in seconds)
|
|
<li>"tzname" (standard/daylight time zone name)
|
|
</ul>
|
|
<p class="label">Format</p>
|
|
<p class="format">getTzOffsetForDate( timezonesarray, tzid, timestamp )</p>
|
|
<p class="comment">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 )</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#helperFunctions">[up]</a>
|
|
|
|
<a name="getTimezonesAsDateArrays"></a><h4>5.3.2 getTimezonesAsDateArrays</h4>
|
|
<p>
|
|
The function creates time zone transition information,
|
|
based on vtimezone component contents in a iCalcreator calendar instance,
|
|
using sub-function expandTimezoneDates.
|
|
</p>
|
|
<p>
|
|
Before calling the function, set time zone 'GMT' ('date_default_timezone_set')!
|
|
</p>
|
|
<p>
|
|
Returns an array containing time zone data from vtimezone standard/daylight instances (input to <a href="#getTzOffsetForDate">getTzOffsetForDate</a>, above).
|
|
</p>
|
|
<p class="label">Format</p>
|
|
<p class="format">getTimezonesAsDateArrays( iCalobj )</p>
|
|
<p class="comment">iCalobj= (object) iCalcreator calendar instance</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#helperFunctions">[up]</a>
|
|
|
|
|
|
<a name="Copyright_and_Licence"></a><h1>6 COPYRIGHT AND LICENSE</h1>
|
|
|
|
<a name="Copyright"></a><h4>6.1 Copyright</h4>
|
|
<p>
|
|
iCalcreator v2.22<br>
|
|
Copyright © 2007-2015 Kjell-Inge Gustafsson, kigkonsult, All rights reserved.<br>
|
|
<a href="http://kigkonsult.se/iCalcreator/index.php" title="kigkonsult.se/iCalcreator" target="_blank">kigkonsult.se iCalcreator</a><br>
|
|
<a href="http://kigkonsult.se/support/index.php" title="kigkonsult.se support" target="_blank">kigkonsult.se support</a><br>
|
|
<a href="http://kigkonsult.se/contact/index.php" title="kigkonsult.se contact" target="_blank">kigkonsult.se contact</a>
|
|
</p>
|
|
|
|
<a name="Licence"></a><h4>6.2 License</h4>
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
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.
|
|
</p>
|
|
<p>
|
|
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 <a href="http://kigkonsult.se/downloads/dl.php?f=LGPL" target="_blank">here</a>.
|
|
</p>
|
|
<br>
|
|
<a href="#INDEX">[index]</a> <a href="#top">[top]</a> <a href="#Copyright_and_Licence">[up]</a>
|
|
</body>
|
|
</html>
|
|
|