You are here

date-ical-valarm.tpl.php in Date iCal 7

File

theme/date-ical-valarm.tpl.php
View source
<?php

/**
 * @file
 * Default theme implementation to display an iCal alarm.
 *
 * Available variables:
 * - $alarm: An array with the following information about each alarm:
 *   - $alarm['action']: The action to take, either 'DISPLAY' or 'EMAIL'
 *   - $alarm['trigger']: The time period for the trigger, like -P2D.
 *   - $alarm['repeat']: The number of times to repeat the alarm.
 *   - $alarm['duration']: The time period between repeated alarms, like P1D.
 *   - $alarm['description']: The description of the alarm.
 *
 *   An email alarm should have two additional parts:
 *   - $alarm['email']: A comma-separated list of email recipients.
 *   - $alarm['summary']: The subject of the alarm email.
 *
 * If you are editing this file, remember that all output lines generated by it
 * must end with DOS-style \r\n line endings, and not Unix-style \n, in order to
 * be compliant with the iCal spec.
 *
 * @see http://tools.ietf.org/html/rfc5545#section-3.1
 *
 * @ingroup themeable
 */
print "BEGIN:VALARM\r\n";
print "ACTION:" . $alarm['action'] . "\r\n";
if (!empty($alarm['trigger'])) {
  print "TRIGGER:" . $alarm['trigger'] . "\r\n";
}
if (!empty($alarm['repeat'])) {
  print "REPEAT:" . $alarm['repeat'] . "\r\n";
}
if (!empty($alarm['duration'])) {
  print "DURATION:" . $alarm['duration'] . "\r\n";
}
if ($alarm['action'] == 'EMAIL') {
  print "ATTENDEE:MAILTO:" . $alarm['email'] . "\r\n";
  print "SUMMARY:" . $alarm['summary'] . "\r\n";
}
print "DESCRIPTION:" . $alarm['description'] . "\r\n";
print "END:VALARM\r\n";