icalendar_helper.php — LatePoint – Calendar Booking Plugin for Appointments and Events trunk

latepoint / lib / helpers / icalendar_helper.php

latepoint / lib / helpers Last commit date

icalendar_helper.php

120 lines

1	<?php
2	/**
3	* ICS.php
4	* =======
5	* Use this class to create an .ics file.
6	*
7	* Usage
8	* -----
9	* Basic usage - generate ics file contents (see below for available properties):
10	* $ics = new ICS($props);
11	* $ics_file_contents = $ics->to_string();
12	*
13	* Setting properties after instantiation
14	* $ics = new ICS();
15	* $ics->set('summary', 'My awesome event');
16	*
17	* You can also set multiple properties at the same time by using an array:
18	* $ics->set(array(
19	* 'dtstart' => 'now + 30 minutes',
20	* 'dtend' => 'now + 1 hour'
21	* ));
22	*
23	* Available properties
24	* --------------------
25	* description
26	* String description of the event.
27	* dtend
28	* A date/time stamp designating the end of the event. You can use either a
29	* DateTime object or a PHP datetime format string (e.g. "now + 1 hour").
30	* dtstart
31	* A date/time stamp designating the start of the event. You can use either a
32	* DateTime object or a PHP datetime format string (e.g. "now + 1 hour").
33	* location
34	* String address or description of the location of the event.
35	* summary
36	* String short summary of the event - usually used as the title.
37	* url
38	* A url to attach to the the event. Make sure to add the protocol (http://
39	* or https://).
40	*/
41	class ICS {
42	const DT_FORMAT = 'Ymd\THis';
43	protected $properties = array();
44	private $available_properties = array(
45	'description',
46	'dtend',
47	'dtstart',
48	'location',
49	'summary',
50	'url',
51	);
52	public function __construct( $props ) {
53	$this->set( $props );
54	}
55	public function set( $key, $val = false ) {
56	if ( is_array( $key ) ) {
57	foreach ( $key as $k => $v ) {
58	$this->set( $k, $v );
59	}
60	} else {
61	if ( in_array( $key, $this->available_properties ) ) {
62	$this->properties[ $key ] = $this->sanitize_val( $val, $key );
63	}
64	}
65	}
66	public function to_string() {
67	$rows = $this->build_props();
68	return implode( "\r\n", $rows );
69	}
70	private function build_props() {
71	// Build ICS properties - add header
72	$ics_props = array(
73	'BEGIN:VCALENDAR',
74	'VERSION:2.0',
75	'PRODID:-//hacksw/handcal//NONSGML v1.0//EN',
76	'CALSCALE:GREGORIAN',
77	'BEGIN:VEVENT',
78	);
79	// Build ICS properties - add header
80	$props = array();
81	foreach ( $this->properties as $k => $v ) {
82	$props[ strtoupper( $k . ( $k === 'url' ? ';VALUE=URI' : '' ) ) ] = $v;
83	}
84	// Set some default values
85	$props['DTSTAMP'] = $this->format_timestamp( 'now' );
86	$props['UID'] = uniqid();
87	$props['X-WR-TIMEZONE'] = OsTimeHelper::get_wp_timezone_name();
88	// Append properties
89	foreach ( $props as $k => $v ) {
90	$ics_props[] = "$k:$v";
91	}
92	// Build ICS properties - add footer
93	$ics_props[] = 'END:VEVENT';
94	$ics_props[] = 'END:VCALENDAR';
95	return $ics_props;
96	}
97	private function sanitize_val( $val, $key = false ) {
98	switch ( $key ) {
99	case 'dtend':
100	case 'dtstamp':
101	case 'dtstart':
102	$val = $this->format_timestamp( $val );
103	break;
104	default:
105	$val = $this->escape_string( $val );
106	}
107	return $val;
108	}
109	private function format_timestamp( $timestamp ) {
110	$dt = new OsWpDateTime( $timestamp );
111	return $dt->format( self::DT_FORMAT );
112	}
113	private function escape_string( $str ) {
114	if ( empty( $str ) ) {
115	return '';
116	}
117	return preg_replace( '/([\,;])/', '\\\$1', $str );
118	}
119	}
120