Delicious Bookmark this on Delicious Share on Facebook SlashdotSlashdot It! Digg! Digg



PHP : Function Reference : MCAL Functions : mcal_fetch_event

mcal_fetch_event

Fetches an event from the calendar stream (PHP 4)
object mcal_fetch_event ( int mcal_stream, int event_id [, int options] )

mcal_fetch_event() fetches an event from the calendar stream specified by id.

Returns an event object consisting of:

  • int id - ID of that event.
  • int public - TRUE if the event if public, FALSE if it is private.
  • string category - Category string of the event.
  • string title - Title string of the event.
  • string description - Description string of the event.
  • int alarm - number of minutes before the event to send an alarm/reminder.
  • object start - Object containing a datetime entry.
  • object end - Object containing a datetime entry.
  • int recur_type - recurrence type
  • int recur_interval - recurrence interval
  • datetime recur_enddate - recurrence end date
  • int recur_data - recurrence data

All datetime entries consist of an object that contains:

  • int year - year
  • int month - month
  • int mday - day of month
  • int hour - hour
  • int min - minutes
  • int sec - seconds
  • int alarm - minutes before event to send an alarm

The possible values for recur_type are:

  • 0 - Indicates that this event does not recur
  • 1 - This event recurs daily
  • 2 - This event recurs on a weekly basis
  • 3 - This event recurs monthly on a specific day of the month (e.g. the 10th of the month)
  • 4 - This event recurs monthly on a sequenced day of the week (e.g. the 3rd Saturday)
  • 5 - This event recurs on an annual basis

Related Examples ( Source code ) » mcal_fetch_event


Code Examples / Notes » mcal_fetch_event

cmoyer

Contrary to what the manual says, the End Date for recurance is not
datetime recur_endate,
it's object recur_enddate


Change Language


Follow Navioo On Twitter
mcal_append_event
mcal_close
mcal_create_calendar
mcal_date_compare
mcal_date_valid
mcal_day_of_week
mcal_day_of_year
mcal_days_in_month
mcal_delete_calendar
mcal_delete_event
mcal_event_add_attribute
mcal_event_init
mcal_event_set_alarm
mcal_event_set_category
mcal_event_set_class
mcal_event_set_description
mcal_event_set_end
mcal_event_set_recur_daily
mcal_event_set_recur_monthly_mday
mcal_event_set_recur_monthly_wday
mcal_event_set_recur_none
mcal_event_set_recur_weekly
mcal_event_set_recur_yearly
mcal_event_set_start
mcal_event_set_title
mcal_expunge
mcal_fetch_current_stream_event
mcal_fetch_event
mcal_is_leap_year
mcal_list_alarms
mcal_list_events
mcal_next_recurrence
mcal_open
mcal_popen
mcal_rename_calendar
mcal_reopen
mcal_snooze
mcal_store_event
mcal_time_valid
mcal_week_of_year
eXTReMe Tracker