JavaScript Editor Javascript debugger     Website design 

↑

mcal_fetch_current_stream_event

Returns an object containing the current streams event structure (PHP 4)
object mcal_fetch_current_stream_event ( int stream )

mcal_fetch_current_stream_event() returns the current stream's event structure as an object containing:

  • 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


→