Location: PHPKode > scripts > tiCalFile > tiCalFile-2.4/README.txt
tiCalFile 2.4

copyright (c) 2010-11 Kjell-Inge Gustafsson, kigkonsult
www.kigkonsult.se/tiCalFile/index.php
hide@address.com


DESCRIPTION
===========

tiCalFile is a PHP utility for creating iCal (RFC2445) event calendar TEST
file(-s), a utilization of the iCalcreator class. The purpose of tiCalFile is
to always have an actual calendar file (using current date and time), usable
when testing calendar software etc.

tiCalFile can be executed from the command line, via a web server/browser,
included in other PHP scripts or even from a HTML page.

A number of properties and parameters are configurable, the number of days
with events, number of events per day, event duration etc. An advanced property
parameter setting may be utilized. Logging can be activated, on various levels,
using PEAR LOG or attached eClog class.

To get a proper understanding of iCal, explore the RFC5545 (obsoletes RFC2445),
download from "http://www.kigkonsult.se/downloads#rfc5545".

The tiCalFile are using iCalcreator class, to be downloaded from
"http://www.kigkonsult.se/downloads/index.php#iCalcreator".


INSTALL
=======

Unpack to any directory within a webserver document root.

Download iCalcreator, "http://www.kigkonsult.se/downloads#iCalcreator", unzip
and place iCalcreator.class.php in the "tiCalFile" directory (FILE LIST below),
otherwise change iCalcreator path in php require_once command in tiCalFile.php,
If already included somewhere else, comment the require command in
"tiCalFile.php"

Unpack eClog-2.0.zip, if used, in the "tiCalFile" directory and check directory
rights.

Include "require_once '<path>/tiCalFile.php'" where appropriate, if used within
software.


CONFIGURATION AND USE
=====================

Update path in the PHP require command for iCalcreator class package in
'tiCalFile.php'.

Examine and adapt the configuration settings in 'tiCalFile.php'. The file(-s) can
be configured to be recreated every hour/day etc. Make sure access rights for
'calendar', PEAR LOG or eClog directories/files (if logging enabled), are correct.

Execute the 'tiCalFile.php' script from a user browser;
"http://<server>/<path>/tiCalFile.php"
and examine the created file(-s) in the 'calendars' folder.

Execute from the command line:
"php -f <path>/tiCalFile.php"

Example how to fire of tiCalFile and check/create file(-s) from a HTMl page:
include
<img src="<path>/tiCalFile-image.php" width="1" height="1" alt="">
at the top of a HTML page, a 1*1 px invisible image.
The "tiCalFile-image.php" script invokes the "tiCalFile.php" script.

Please email opt. bugs, improvments etc to "hide@address.com" asap!


FILE LIST
=========

calendars/                 calendar storage (configurable), read/write access
eClog-2.0.zip              eClog, file log class package
LGPL.txt                   licence
README.txt                 this file
tiCalFile.php              the script
tiCalFile-image.php        HTML 'image' back end


COPYRIGHT & LICENCE
===================

COPYRIGHT

tiCalFile v2.4
copyright (c) 2011 Kjell-Inge Gustafsson, kigkonsult
www.kigkonsult.se/tiCalFile/index.php
hide@address.com

LICENCE

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
Return current item: tiCalFile