Location: PHPKode > scripts > tiCalFile > tiCalFile-3.0/README.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
<html>
<head>
<title>tiCalFile 3.0</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<meta name="author"      content="Kjell-Inge Gustafsson kigkonsult">
<meta name="copyright"   content="2010-2012 Kjell-Inge Gustafsson kigkonsult">
<meta name="keywords"    content="ical, calendar, calender, xcal, xml, icalender, rfc2445, rfc5545, vcalender, test, php, log, class, create">
<meta name="description" content="using tiCalFile 3.0">
<style type="text/css">
body {    font-family:     "Lucida Grande","Lucida Sans Unicode", "Bitstream Vera Sans", Lucida, Arial, Geneva, Helvetica, sans-serif;
          font-size:       small;
          margin-left:     10px;
          width:           800px; }
table {   border-collapse: collapse;
          width:           100%; }
td {      border-bottom:   gray dotted thin;
          font-size:       10pt;
          vertical-align:  top; }
pre, th { background-color:#E7E7E5;
          text-align:    left;
          font-family:     monospace;
          font-size:       8pt;
          letter-spacing:  0.1em;
          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+ */ }
</style>
</head>
<body>
<a name="top"></a>
<h1>tiCalFile 3.0</h1>

<h2>DESCRIPTION</h2>
<p>
tiCalFile is a PHP class creating iCal (RFC2445) event calendar TEST file(-s), 
a utilization of the iCalcreator class. The purpose of tiCalFile is to always 
have actual calendar file(-s) with event components (using current date and 
time), usable when testing calendar software etc.
</p>
<p>
tiCalFile can be executed from the command line, via a web server/browser,
included in other PHP scripts or even from a HTML page.
</p>
<p>
A number of general parameters are configurable:
</p>
<dl>
<dt><dd>calendar directory and file name(-s),
<dt><dd>calendar starting date,
<dt><dd>the number of days with events, number of events per day, event duration etc,
<dt><dd>using logging or not (PEAR LOG or kigkonsult eClog class)
</dl>
<p>
Event properties DTSTART, SUMMARY, DESCRIPTION,CATEGORIES and RESOURCES are 
created in every event, all other properties appear depending on parameter
setting (default 50%) in each event as well as appearence of alarms (with 
AUDIO, DISPLAY and EMAIL actions). Review a property list at 
&quot;http://kigkonsult.se/iCalcreator/docs/using.html#CalProps&quot;.
</p>
<p>
The property value and parameter contents are based on
</p>
<dl>
<dt><dd>event start date (configurable),
<dt><dd>the property (limited) value set
<dt><dd>&quot;lorem ipsum&quot; texts,
<dt><dd>a mixture of common names.
<dt><dd>fixed &quot;dummy&quot; texts,
</dl>
<p>
To get a proper understanding of iCal, explore the RFC5545 (obsoletes RFC2445),
download from &quot;http://kigkonsult.se/downloads/index.php#rfc5545&quot;.
</p>
<p>
The tiCalFile are using iCalcreator class, downloaded latest version from
&quot;http://kigkonsult.se/downloads/index.php#iCalcreator&quot;.
</p>
<p>
The tiCalFile may use PEAR Log or kigkonsult eClog class, downloaded latest version 
from &quot;http://kigkonsult.se/downloads/index.php#eClog&quot;.
</p>
<p>
A file locking mechanism is implemented to avoid parallel excutions and also
control ical file(-s) update time.
</p>

<h2>INSTALL</h2>
<p>
Unpack to any directory within a webserver document root, if not excuting in 
command line.
</p>
<p>
Download iCalcreator (required), 
&quot;http://kigkonsult.se/downloads#iCalcreator&quot;, 
unzip and place iCalcreator.class.php in the &quot;tiCalFile&quot; directory 
(FILE LIST below), otherwise change iCalcreator path in php require_once 
command in &quot;tiCalFile.[cfg/def].php&quot;.
</p>
<p>
Download eClog (optional), 
unpack in the &quot;tiCalFile&quot; directory and check (log) directory rights.
</p>

<h2>CONFIGURATION AND USE</h2>
<p>
The file creation may consume some time, configuration mode and a longer create
interval than one hour is to recommend.
</p>
<h3>Default mode</h3>
<p>
Examine &quot;tiCalFile.def.php&quot; script. No configuration is done and all 
default values are used. The test file &quot;calendars/testFile.ics&quot; 
(relative to the &quot;tiCalFile&quot; directory) will be created or recreated 
every hour (no file is recreated if the script is reexecuted within an hour). 
Make sure access/write rights for &quot;calendar&quot; directory.
</p>
<p>
In the &quot;tiCalFile.def.php&quot; script, no logging is enabled.
</p>
<p>
Examine the created file(-s) in the &quot;calendars&quot; folder.
</p>

<h3>Config mode</h3>
<p>
Examine &quot;tiCalFile.cfg.php&quot; and update path in the PHP require 
command for iCalcreator class and, optional, eClog/PEAR LOG.
</p>
<p>
<u>Adapt</u> the configuration settings. The test file(-s)
can be configured to be recreated every hour/day etc. Make sure access rights 
for &quot;calendar&quot; directory/files are correct and also, if logging are 
enabled, PEAR LOG or eClog directory/files.
</p>
<p>
Examine the created file(-s) in the &quot;calendars&quot; folder.
</p>
<h3>Invoke tiCalFile</h3>
<h4>Invoke the &quot;tiCalFile.[cfg/def].php&quot; script within another PHP 
script</h4>
<h6>Example</h6>
<p>
tiCalFile in config mode.
</p>
<pre>
&lt;?php
.. .
require_once &quot;tiCalFile.cfg.php&quot;;
.. .
?&gt;
</pre>

<h4>Execute the &quot;tiCalFile.[cfg/def].php&quot; script from a browser.</h4>
<h6>Example</h6>
<p>
tiCalFile in default mode.
</p>
<pre>
http://&lt;server&gt;/&lt;path&gt;/tiCalFile.def.php
</pre>
<h4>Execute the &quot;tiCalFile.[cfg/def].php&quot; script from the command line</h4>
<h6>Example</h6>
<p>
tiCalFile in config mode.
</p>
<pre>
php -f &lt;path&gt;/tiCalFile.cfg.php
</pre>
<h4>Invoke the &quot;tiCalFile.[cfg/def].php&quot; script from a HTML page</h4>
<p>
Fire of tiCalFile and check/create file(-s) from a HTMl page.
</p>
<h6>Example</h6>
<pre>
&lt;img src=&quot;http://&lt;server&gt;/&lt;path&gt;/tiCalFile-image.php&quot; width=&quot;1&quot; height=&quot;1&quot; alt=&quot;&quot;&gt;
</pre>
<p>
Include in a HTML page, a 1*1 px invisible image.
The &quot;tiCalFile-image.php&quot; script invokes the 
&quot;tiCalFile.[cfg/def].php&quot; script. Update the 
&quot;tiCalFile-image.php&quot; script and comment/uncomment to select 
preferred mode. 
</p>

<h2>FILE LIST</h2>
<pre>
calendars/                 calendar directory (configurable), read/write access
LGPL.txt                   licence
README.html                this file
tiCalFile.class.php        the class file
tiCalFile.cfg.php          the config &quot;mode&quot; script
tiCalFile.def.php          the default &quot;mode&quot; script
tiCalFile-image.php        HTML &quot;image&quot; back end
</pre>

<a name="Support"></a>
<h2>Support</h2>
<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 services for software support, design and development of 
customizations and adaptations of <em>PHP</em>/<em>MySQL</em> solutions 
with a special focus on software long term utility and reliability,
supported through our agile acquire/design/transition process model.
</p>

<a name="Donate"></a>
<h2>Donate</h2>
<p>
You can show your appreciation for our free software, and can support future 
development by making a donation to the kigkonsult projects.
</p>
<p>
Make a donation of any size by clicking the donate link at the 
<a href="http://kigkonsult.se/contact/index.php#donate" title="Donate" target="_blank">contact</a> 
page. Thanks in advance!
</p>

<h2>COPYRIGHT and LICENCE</h2>
<h3>COPYRIGHT</h3>
<p>
tiCalFile v3.0<br />
copyright (c) 2010-2012 Kjell-Inge Gustafsson, kigkonsult<br />
kigkonsult.se/tiCalFile/index.php<br />
kigkonsult.se/contact/index.php<br />
</p>
<h3>LICENCE</h3>
<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
</p>
</body>
</html>
Return current item: tiCalFile