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

mcal_fetch_event
Prev	XXXVI. MCAL Functions	Next

mcal_fetch_event

Name

mcal_fetch_event — Fetch an event

Synopsis

object mcal_fetch_event(MCALconnection, eventid[, options]); int MCALconnection: An open MCAL connection int eventid: The unique ID of the event to be fetched int options (optional): A bitmask of flags for future expansion

Returns

The event object corresponding to the given ID.

Description

mcal_fetch_event() gives you back an object containing all information about the event that you ask for. You will most likely get the eventid from either mcal_list_events() or mcal_list_alarms() , but it can also be stored elsewhere, perhaps as an event associated with another part of your site. The properties of the event object are:

id: The unique ID of the event.
public: The event's class. 1 if the event is public, 0 if the event is private.
category: The event's category.
title: The event's title.
description: The event's description.
alarm: The number of minutes before an event that an alarm should be triggered.
start: A datetime object saying when the event starts.
end: A datetime object saying when the event ends.
recur_type: The recurrence type. One of the following constants: MCAL_RECUR_NONE, MCAL_RECUR_DAILY, MCAL_RECUR_WEEKLY, MCAL_RECUR_MONTHLY_MDAY, MCAL_RECUR_MONTHLY_WDAY, or MCAL_RECUR_YEARLY.
recur_interval: The recurrence interval.
recur_enddate: A datetime object holding the date the recurrence ends.
recur_data: Any additional recurrence data, such as what days of the week an MCAL_RECUR_WEEKLY event occurs on.
attrlist: A key-value array of any custom attributes that have been added to the event with mcal_event_add_attribute() .

Version

PHP 3 since 3.0.13, PHP 4 since 4.0b4

Example

Example 723. Fetching an event and looping through all of its attributes

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

$events = mcal_list_events($MCALconnection, $start_year,
                           $start_month, $start_day
                           $end_year, $end_month,
                           $end_day);
$eventID = $events[0];
$eventObject = mcal_fetch_event($MCALconnection, $eventID);

// This loop will display all of the attributes that an event has,
// including any attributes that you have added with
// mcal_event_add_attribute.
foreach ($eventObject as $attribute => $value) {
    if (is_array($value) || is_object($value)) {
        echo $attribute . " contains:<br /><blockquote>";
        foreach ($value as $iattribute => $ivalue) {
            echo $iattribute . " is: " . $ivalue . "<br />";
        }
        echo "</blockquote>";
    } else {
        echo $attribute . " is: " . $value . "<br />";
    }
}

Prev	Home	Next
mcal_fetch_current_stream_event	Up	mcal_is_leap_year

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.