Location: PHPKode > scripts > tiCalFile > tiCalFile-3.2/README.html
<html>
<head>
<title>tiCalFile 3.2</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-2013 Kjell-Inge Gustafsson kigkonsult">
<meta name="keywords"    content="ical, calendar, calender, icalender, rfc2445, rfc5545, vcalender, event, todo, journal, freebusy, test, php, log, class, create">
<meta name="description" content="using tiCalFile 3.2">
<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.2</h1>
<p>
tiCalFile v3.2<br />
copyright (c) 2010-2013 Kjell-Inge Gustafsson, kigkonsult<br />
<a href="http://kigkonsult.se/tiCalFile/index.php" title="open in a new window" target="_blank">kigkonsult.se iCalcnv</a><br>
<a href="http://kigkonsult.se/contact/index.php" title="open in a new window" target="_blank">kigkonsult.se contact</a>
</p>

<h2>DESCRIPTION</h2>
<p>
tiCalFile is a PHP class creating iCal (RFC2445) calendar TEST file(-s),
 a utilization of the iCalcreator class. The purpose of tiCalFile is to always
 have TEST calendar file(-s) with components (using current date and time),
 usable when INTERNALLY 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, in <a href="#Default_mode">default</a>
 or <a href="#Config_mode">configure</a> modes.
</p>
<p>
When executing tiCalFile in <a href="#Default_mode">default</a> mode (below),
 an iCal test file are created in sub-directory 'calendars' with a timezone and 50 event components,
 using present start date and nine days forward.
</p>
<p>
Executing tiCalFile in <a href="#Config_mode">configure</a> mode (below) offer very flexible setting capabilities:
</p>
<ul>
<li>calendar directory and file name(-s),
<li>calendar starting date,
<li>the number of days in calendar, number of components per day, duration etc,
<li>using logging or not (PEAR LOG or kigkonsult eClog class)
<li>settings for component, property and parameter (value and) occurrence
</ul>
<p>
Calendar component properties DTSTART, SUMMARY, DESCRIPTION, CATEGORIES and
RESOURCES are created in every component (where applicable), all other
properties appear depending on setting (default 50%) in each
component as well as appearence of alarms (with AUDIO, DISPLAY and EMAIL
actions). Check a component property list
<a href="http://kigkonsult.se/iCalcreator/docs/using.html#CalProps" title="open in a new window" target="_blank">here</a>.
</p>
<p>
Each property value and parameter contents are based on
</p>
<ul>
<li>component start date (configurable),
<li>a property (limited) value set
<li>&quot;lorem ipsum&quot; texts,
<li>a mixture of common names.
<li>fixed &quot;dummy&quot; texts,
</ul>
<dl>Sample test files are validated at
<dd><a title="goto icalvalid.cloudapp.net" href="http://icalvalid.cloudapp.net/" target="_blank">icalvalid.cloudapp.net iCalendar Validator, based on DDay.iCal</a>
<dd><a title="goto severinghaus.org validator" href="http://severinghaus.org/projects/icv/" target="_blank">severinghaus.org iCalendar Validator, based on iCal4j</a>
</dl>
<p>
To get a proper understanding of iCal, explore the RFC5545 (obsoletes RFC2445),
download
<a href="http://kigkonsult.se/downloads/index.php#rfc5545" title="open in a new window" target="_blank">here</a>.
</p>
<p>
The tiCalFile are using <a href="http://kigkonsult.se/iCalcreator/index.php" title="open in a new window" target="_blank">iCalcreator</a> class, download the latest version
<a href="http://kigkonsult.se/downloads/index.php#iCalcreator" title="open in a new window" target="_blank">here</a>.
</p>
<p>
The tiCalFile may use PEAR Log, kigkonsult <a href="http://kigkonsult.se/eClog/index.php" title="open in a new window" target="_blank">eClog</a> class or no logging.
</p>
<p>
A file locking mechanism is implemented to avoid parallel excutions and also
control ical file(-s) recreate time.
</p>

<h2>INSTALL</h2>
<p>
Unpack to any directory within a webserver document root, if not excuting in
command line.
</p>
<p>
Download
<a href="http://kigkonsult.se/downloads/index.php#iCalcreator" title="open in a new window" target="_blank">iCalcreator</a>
(required), unzip and place iCalcreator.class.php in the &quot;tiCalFile&quot;
directory (<a href="#FILE LIST">FILE LIST</a> below), otherwise change iCalcreator path in php require_once
command in &quot;tiCalFile.[cfg/def].php&quot;.
</p>
<p>
When using PEAR LOG (optional), please examine <a href="http://pear.php.net" title="open in a new window" target="_blank">pear.php.net</a>
for install and configuration..
</p>
<p>
Download
<a href="http://kigkonsult.se/downloads/index.php#eClog" title="open in a new window" target="_blank">eClog</a>
(optional) and unpack in the &quot;tiCalFile&quot; directory and check (log) directory rights.
More Install and configuration information is found in the eClog download package.
</p>

<h2>CONFIGURATION AND USE</h2>
<p>
The file creation may consume some time (0.2 - 0.4 sec/file), configuration mode and a longer create
interval than one hour is to recommend.
</p>
<a name="Default_mode"></a>
<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>
The created iCal calendar file contains one timezone and 50 event components, starting present day and nine days forward, 5 events every day.
</p>
<p>
In the &quot;tiCalFile.def.php&quot; script, no logging is enabled.
</p>
<p>
Examine the created file in the &quot;calendars&quot; directory.
</p>

<a name="Config_mode"></a>
<h3>Config mode</h3>
<p>
<u>Adapt</u> the configuration settings, open &quot;tiCalFile.cfg.php&quot; in an editor and update:
</p>
<ul>
<li>path in the PHP require command for iCalcreator class and, optional, eClog/PEAR LOG.
<li>calendars (and lock file) directory storage, check access rights for &quot;calendar&quot; directory/files
<li>if logging is enabled, set and controll access for PEAR LOG or eClog directory/files.
<li>number of created files and content of each iCal file (proportions of event, todo, journal and freebusy components.)
<li>lock file and (re-)creation directives
<li>timezone occurrence
<li>each and every component property occurrence (DTSTART, UID, DTSTART, SUMMARY, DESCRIPTION CATEGORIES and RESOURCES will always occur where applicable)
<li>calendar and component x-property occurrence
<li>general component parameter setting like TZID, LANGUAGE, ALTREP etc.
</ul>
<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 <a href="#Config_mode">config</a> 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 <a href="#Default_mode">default</a> 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 <a href="#Config_mode">config</a> mode.
</p>
<pre>
php -f ./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>
Includes a 1*1 px invisible image in a HTML page.
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 the preferred mode.
</p>

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

<a name="Support"></a>
<h2>Support</h2>
<p>
Use the <a href="http://kigkonsult.se/contact/index.php" title="open in a new window" target="_blank">contact page</a>
for queries, improvement or 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="open in a new window" target="_blank">contact page</a> .
Thanks in advance!
</p>

<h2>COPYRIGHT and LICENCE</h2>
<h3>COPYRIGHT</h3>
<p>
tiCalFile v3.2<br />
copyright (c) 2010-2013 Kjell-Inge Gustafsson, kigkonsult<br />
<a href="http://kigkonsult.se/tiCalFile/index.php" title="open in a new window" target="_blank">kigkonsult.se iCalcnv</a><br>
<a href="http://kigkonsult.se/contact/index.php" title="open in a new window" target="_blank">kigkonsult.se contact</a>
</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