/iCalendar_v2/class.iCalJournal.inc.php

<?php

/* vim: set expandtab tabstop=4 shiftwidth=4: */

//+----------------------------------------------------------------------+

//| WAMP (XP-SP1/1.3.27/4.0.12/5.0.0b2-dev)                                    |

//+----------------------------------------------------------------------+

//| Copyright (c) 1992-2003 Michael Wimmer                               |

//+----------------------------------------------------------------------+

//| I don't have the time to read through all the licences to find out   |

//| what the exactly say. But it's simple. It's free for non commercial  |

//| projects, but as soon as you make money with it, i want my share :-) |

//| (License : Free for non-commercial use)                              |

//+----------------------------------------------------------------------+

//| Authors: Michael Wimmer <flaimo@gmx.net>                             |

//+----------------------------------------------------------------------+

//

// $Id$



/**

* @package iCalendar Everything to generate simple iCal files

*/

/**

* We need the base class

*/

include_once 'class.iCalBase.inc.php';

/**

* Container for a single Journal

*

* Tested with WAMP (XP-SP2/2.2/5.2/5.1.0)

* Last Change: 2008-04-07

*

* @access public

* @author Michael Wimmer <flaimo@gmail.com>

* @copyright Copyright Š 2002-2008, Michael Wimmer

* @license GNU General Public License v3

* @link http://code.google.com/p/flaimo-php/

* @package iCalendar

* @version 2.002

*/

class iCalJournal extends iCalBase {



	/*-------------------*/

	/* V A R I A B L E S */

	/*-------------------*/



	/**

	* Timestamp of the start date

	*

	* @var int

	*/

	private $startdate_ts;



	/**

	* start date in iCal format

	*

	* @var string

	*/

	private $startdate;



	/**

	* Timestamp of the creation date

	*

	* @var int

	*/

	private $created_ts;



	/**

	* creation date in iCal format

	*

	* @var string

	*/

	private $created;



	/**

	* Automaticaly created: md5 value of the start date + end date

	*

	* @var string

	*/

	private $uid;



	/**

	* '' = never, integer < 4 numbers = number of times, integer >= 4 = timestamp

	*

	* @var mixed

	*/

	private $rec_end;



	/*-----------------------*/

	/* C O N S T R U C T O R */

	/*-----------------------*/



	/**#@+

	* @return void

	*/

	/**

	* Constructor

	*

	* Only job is to set all the variablesnames

	*

	* @param string $summary  Title for the event

	* @param string $description  Description

	* @param int $start  Start time for the event (timestamp)

	* @param int $created  Creation date for the event (timestamp)

	* @param int $last_mod  Last modification date for the event (timestamp)

	* @param int $status  Status of the event (0 = TENTATIVE, 1 = CONFIRMED, 2 = CANCELLED)

	* @param int $class  (0 = PRIVATE | 1 = PUBLIC | 2 = CONFIDENTIAL)

	* @param array $organizer  The organizer &#x2013; use array('Name', 'name@domain.com')

	* @param array $attendees  key = attendee name, value = e-mail, second value = role of the attendee [0 = CHAIR | 1 = REQ | 2 = OPT | 3 =NON] (example: array('Michi' => 'flaimo@gmx.net,1'); )

	* @param array $categories  Array with Strings (example: array('Freetime','Party'))

	* @param int $frequency  frequency: 0 = once, secoundly &#x2013; yearly = 1&#x2013;7

	* @param mixed $rec_end  recurrency end: ('' = forever | integer = number of times | timestring = explicit date)

	* @param int $interval  Interval for frequency (every 2,3,4 weeks&#x2026;)

	* @param string $days  Array with the number of the days the event accures (example: array(0,1,5) = Sunday, Monday, Friday

	* @param string $weekstart  Startday of the Week ( 0 = Sunday &#x2013; 6 = Saturday)

	* @param string $exept_dates  exeption dates: Array with timestamps of dates that should not be includes in the recurring event

	* @param string $url  optional URL for that event

	* @param string $lang  Language of the strings used in the event (iso code)

	* @param string $uid  Optional UID for the Journal

	* @uses setSummary()

	* @uses iCalBase::setDescription()

	* @uses setStartDate()

	* @uses setCreated()

	* @uses iCalBase::setLastMod()

	* @uses iCalBase::setStatus()

	* @uses iCalBase::setClass()

	* @uses iCalBase::setOrganizer()

	* @uses iCalBase::setAttendees()

	* @uses iCalBase::setCategories()

	* @uses iCalBase::setURL()

	* @uses iCalBase::setLanguage()

	* @uses iCalBase::setFrequency()

	* @uses setRecEnd()

	* @uses iCalBase::setInterval()

	* @uses iCalBase::setDays()

	* @uses iCalBase::setWeekStart()

	* @uses iCalBase::setExeptDates()

	* @uses iCalBase::setSequence()

	* @uses setUID()

	*/

	function __construct($summary, $description, $start, $created, $last_mod,

						 $status, $class, $organizer, $attendees, $categories,

						 $frequency, $rec_end, $interval, $days, $weekstart,

						 $exept_dates, $url, $lang, $uid) {



		parent::__construct();

		parent::setSummary($summary);

		parent::setDescription($description);

		$this->setStartDate($start);

		$this->setCreated($created);

		parent::setLastMod($last_mod);

		parent::setStatus($status);

		parent::setClass($class);

		parent::setOrganizer($organizer);

		parent::setAttendees($attendees);

		parent::setCategories($categories);

		parent::setURL($url);

		parent::setLanguage($lang);

		parent::setFrequency($frequency);

		$this->setRecEnd($rec_end);

		parent::setInterval($interval);

		parent::setDays($days);

		parent::setWeekStart($weekstart);

		parent::setExeptDates($exept_dates);

		parent::setSequence(0);

		$this->setUID($uid);

	} // end constructor



	/*-------------------*/

	/* F U N C T I O N S */

	/*-------------------*/



	/**

	* Sets the end for a recurring event (0 = never ending,

	* integer < 4 numbers = number of times, integer >= 4 enddate)

	*

	* @param int $freq

	* @see getRecEnd()

	* @uses iCalJournal::$rec_end

	* @since 1.010 - 2002-10-26

	*/

	private function setRecEnd($freq = '') {

		if (strlen(trim($freq)) < 1) {

			$this->rec_end = 0;

		} elseif (is_int($freq) && strlen(trim($freq)) < 4) {

			$this->rec_end = $freq;

		} else {

			$this->rec_end = (string) parent::formatDate($freq);

		} // end if

	} // end function



	/**

	* Set $startdate_ts variable

	*

	* @param int $timestamp

	* @see getStartDateTS()

	* @uses iCalJournal::$startdate_ts

	* @uses iCalJournal::$enddate_ts

	*/

	private function setStartDateTS($timestamp = 0) {

		if (is_int($timestamp) && $timestamp > 0) {

			$this->startdate_ts = (int) $timestamp;

		} else {

			$this->startdate_ts = (int) ((isset($this->enddate_ts) && is_numeric($this->enddate_ts) && $this->enddate_ts > 0) ? ($this->enddate_ts - 3600) : time());

		} // end if

	} // end function



	/**

	* Set $created_ts variable

	*

	* @param int $timestamp

	* @see getCreatedTS()

	* @uses iCalJournal::$created_ts

	*/

	private function setCreatedTS($timestamp = 0) {

		if (is_int($timestamp) && $timestamp > 0) {

			$this->created_ts = (int) $timestamp;

		} // end if

	} // end function



	/**

	* Set $startdate variable

	*

	* @param int $timestamp

	* @see getStartDate()

	* @uses iCalJournal::$startdate

	* @uses iCalJournal::$startdate_ts

	* @uses setStartDateTS()

	*/

	private function setStartDate($timestamp = 0) {

		$this->setStartDateTS($timestamp);

		$this->startdate = (string) parent::formatDate($this->startdate_ts);

	} // end function



	/**

	* Set $created variable

	*

	* @param int $timestamp

	* @see getCreated()

	* @uses iCalJournal::$created

	* @uses iCalJournal::$created_ts

	* @uses setCreatedTS()

	*/

	private function setCreated($timestamp = 0) {

		$this->setCreatedTS($timestamp);

		$this->created = (string) parent::formatDate($this->created_ts);

	} // end function



	/**

	* Set $uid variable

	*

    * @param int $uid

	* @see getUID()

	* @uses iCalJournal::$uid

	*/

	private function setUID($uid = 0) {

		if (strlen(trim($uid)) > 0) {

            $this->uid = (string) $uid;

        } else {

            $rawid = (string) $this->startdate . 'plus' .  parent::getSummary();

            $this->uid = (string) md5($rawid);

        } // end if

	} // end function

	/**#@-*/



	/**

	* Get $rec_end variable

	*

	* @return mixed $rec_end

	* @see setRecEnd()

	* @since 1.010 - 2002-10-26

	*/

	public function getRecEnd() {

		return $this->rec_end;

	} // end function



	/**

	* Get $startdate_ts variable

	*

	* @return int $startdate_ts

	* @see setStartDateTS()

	*/

	public function getStartDateTS() {

		return (int) $this->startdate_ts;

	} // end function



	/**

	* Get $created_ts variable

	*

	* @return int $created_ts

	* @see setCreatedTS()

	*/

	public function getCreatedTS() {

		return (int) $this->created_ts;

	} // end function



	/**

	* Get $startdate variable

	*

	* @return int $startdate

	* @see setStartDate()

	*/

	public function getStartDate() {

		return (string) $this->startdate;

	} // end function



	/**

	* Get $created variable

	*

	* @return string $created

	* @see setCreated()

	*/

	public function getCreated() {

		return (string) $this->created;

	} // end function



	/**

	* Get $uid variable

	*

	* @return string $uid

	* @see setUID()

	*/

	public function getUID() {

		return (string) $this->uid;

	} // end function

} // end class iCalJournal

?>