PhpDig.net

What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.




mcal_list_alarms

Name

mcal_list_alarms — List alarms active at a given time

Synopsis

array mcal_list_alarms(MCALconnection, year, month, day, hour, min, sec);
int MCALconnection: An open MCAL connection
int year: The year of the search date
int month: The month of the search date
int day: The day of the search date
int hour: The hour of the search time
int min: The minute of the search time
int sec: The second of the search time

Returns

An array of events with active alarms

Description

mcal_list_alarms() returns an array containg every event which has an alarm active during the given date and time. Alarms are considered active if the specified time is during the event and the event has an alarm set, or if it is alarm minutes before the event or less, where alarm is the alarm set for the event.

Warning

Until very recently (early May, 2001), searching for alarms was broken in libmcal's mstore driver. Any version of PHP with MCAL support will work, but you will need to have linked against a recent copy of libmcal.

Version

PHP 3 since 3.0.13, PHP 4 since 4.0b4

Example

Example 725. Listing active alarms

$calendar = "{/mstore}";
$MCALconnection = mcal_open($calendar, "username", "password");

// List all events with an alarm active right now
list($year, $month,
     $day, $hour,
     $min, $sec) = explode(":", date("Y:n:j:G:i"));

$events = mcal_list_alarms($MCALconnection, $year, $month,
                           $day, $hour, $min, $sec);

foreach ($events as $eventid) {
    echo "Event " . $eventid . " has an alarm active.<br />";
}



PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.

Powered by: vBulletin Version 3.0.7
Copyright ©2000 - 2005, Jelsoft Enterprises Ltd.
Copyright © 2001 - 2005, ThinkDing LLC. All Rights Reserved.