Class RepeatingEvent

Description
Description | Methods (details)

A repeating event parameter object.

This is a parameter object. It only has simple accessors.

Located in /includes/classes/RptEvent.class.php (line 18) 

Event
   |
   --RepeatingEvent
Method Summary
Description | Methods (details)
Event RepeatingEvent (string $name, string $description, string $date, string $time, int $id, mixed $extForID, int $priority, string $access, int $duration, string $status, string $owner, mixed $category, string $login,  $cal_type,  $location,  $url,  $due_date,  $due_time,  $percent, string $moddate, string $modtime,  $guid, string $rpt_type, string $end, int $frequency, string $days, string $rpt_bymonth, string $rpt_bymonthday, string $rpt_byday, string $rpt_bysetpos, string $rpt_byweekno, string $rpt_byyearday, string $rpt_wkst, string $rpt_count, string $endtime, array $exceptions, array $inclusions, array $rpt_all_dates)
void addRepeatAllDates (array $dates)
void addRepeatException (string $exception, int $id)
void addRepeatInclusion (string $inclusion)
array getRepeatAllDates ()
string getRepeatByDay ()
string getRepeatByMonth ()
string getRepeatByMonthDay ()
string getRepeatBySetPos ()
string getRepeatByWeekNo ()
string getRepeatByYearDay ()
integer getRepeatCount ()
string getRepeatDays ()
int getRepeatEnd ()
string getRepeatEndDateTime ()
string getRepeatEndDateTimeTS ()
int getRepeatEndTime ()
array getRepeatExceptions ()
int getRepeatFrequency ()
array getRepeatInclusions ()
string getRepeatType ()
string getRepeatWkst ()
Methods
Description | Methods (details)
Constructor RepeatingEvent (line 163)

Creates a new RepeatingEvent.

  • return: The new Event
  • access: public
Event RepeatingEvent (string $name, string $description, string $date, string $time, int $id, mixed $extForID, int $priority, string $access, int $duration, string $status, string $owner, mixed $category, string $login,  $cal_type,  $location,  $url,  $due_date,  $due_time,  $percent, string $moddate, string $modtime,  $guid, string $rpt_type, string $end, int $frequency, string $days, string $rpt_bymonth, string $rpt_bymonthday, string $rpt_byday, string $rpt_bysetpos, string $rpt_byweekno, string $rpt_byyearday, string $rpt_wkst, string $rpt_count, string $endtime, array $exceptions, array $inclusions, array $rpt_all_dates)
  • string $name: Name of the event
  • string $description: Event's description
  • string $date: Event's date (in YYYYMMDD format)
  • string $time: Event's time (in HHMMSS format)
  • string $moddate: Event's mod date (in YYYYMMDD format)
  • string $modtime: Event's mod time (in HHMMSS format)
  • int $id: Event's ID
  • mixed $extForID: Event's extension ID (or '' for none)
  • int $priority: Event's priority
  • string $access: Event's access level
  • int $duration: Event's duration (in minutes)
  • string $status: Event's status
  • string $owner: Event's cal_create_by
  • mixed $category: Event's category ID
  • string $login: Event's owner
  • string $rpt_type: Event's repeat type
  • string $end: End date for repetition
  • string $endtime: End time for repetition
  • int $frequency: Frequency of repetition
  • string $days: Days on which the event falls (for weekly events)
  • string $rpt_bymonth: Months that events occur
  • string $rpt_bymonthday: Days of month that events occur
  • string $rpt_byday: Days on which the event falls (replaces $days)
  • string $rpt_bysetpos: Nth occurance within existing event set
  • string $rpt_byweekno: Weeks that events occur
  • string $rpt_byyearday: Days of the year that events occur
  • string $rpt_wkst: Start day of week for ByDay events
  • string $rpt_count: Number of repeat occurances (including orginal date)
  • array $exceptions: Dates on which the event should not occur
  • array $inclusions: Additional dates on which the event should occur
  • array $rpt_all_dates: All dates on which the event should occur
  • $cal_type
  • $location
  • $url
  • $due_date
  • $due_time
  • $percent
  • $guid
addRepeatAllDates (line 443)

Adds the event's complete date list

  • access: public
void addRepeatAllDates (array $dates)
  • array $dates: All date of event (in YYYYMMDD format)
addRepeatException (line 399)

Adds an exception to this event

Add the ID to the end to aid in matching up with the events class

  • access: public
void addRepeatException (string $exception, int $id)
  • string $exception: Date of exception (in YYYYMMDD format)
  • int $id: ID of exception
addRepeatInclusion (line 421)

Adds an inclusion to this event

  • access: public
void addRepeatInclusion (string $inclusion)
  • string $inclusion: Date of inclusion (in YYYYMMDD format)
getRepeatAllDates (line 432)

Gets the event's complete date list

  • return: The event's total dates
  • access: public
array getRepeatAllDates ()
getRepeatByDay (line 325)

Gets the days in which the event falls.

  • return: The days on which the event falls
  • access: public
string getRepeatByDay ()
getRepeatByMonth (line 305)

Gets the months in which the event falls.

  • return: The months on which the event falls
  • access: public
string getRepeatByMonth ()
getRepeatByMonthDay (line 315)

Gets the days of the month in which the event falls.

  • return: The days on which the event falls
  • access: public
string getRepeatByMonthDay ()
getRepeatBySetPos (line 335)

Gets the Nth occurance of the event set.

  • return: The Nth occurance of the event set
  • access: public
string getRepeatBySetPos ()
getRepeatByWeekNo (line 345)

Gets the weeks in which the event falls.

  • return: The weeks on which the event falls
  • access: public
string getRepeatByWeekNo ()
getRepeatByYearDay (line 355)

Gets the days of the year in which the event falls.

  • return: The days of the year on which the event falls
  • access: public
string getRepeatByYearDay ()
getRepeatCount (line 375)

Gets the Count value for this event

  • return: The number of repeat events
  • access: public
integer getRepeatCount ()
getRepeatDays (line 295)

Gets the days on which the event falls.

  • return: The days on which the event falls
  • access: public
string getRepeatDays ()
getRepeatEnd (line 223)

Gets the event's end date

  • return: The event's end date
  • access: public
int getRepeatEnd ()
getRepeatEndDateTime (line 246)

Gets the event's end date/time

  • return: The event's end date/time (in YYYYMMDDHHMMSS format)
  • access: public
string getRepeatEndDateTime ()
getRepeatEndDateTimeTS (line 258)

Gets the event's end date/time

  • return: The event's end date/time (in UNIX Timestamp format)
  • access: public
string getRepeatEndDateTimeTS ()
getRepeatEndTime (line 235)

Gets the event's end time

  • return: The event's end time
  • access: public
int getRepeatEndTime ()
getRepeatExceptions (line 385)

Gets the event's exception dates

  • return: The event's exception dates
  • access: public
array getRepeatExceptions ()
getRepeatFrequency (line 284)

Gets the event's repeat frequency

  • return: The event's repeat frequency
  • access: public
int getRepeatFrequency ()
getRepeatInclusions (line 410)

Gets the event's inclusion dates

  • return: The event's inclusion dates
  • access: public
array getRepeatInclusions ()
getRepeatType (line 211)

Gets the event's repeat type

Can be one of:

  • daily
  • weekly
  • monthlyByDay
  • monthlyBySetPos
  • monthlyByDate
  • yearly

  • return: The event's repeat type
  • access: public
string getRepeatType ()
getRepeatWkst (line 365)

Gets the start of the week for ByDay events.

  • return: The start of the week for ByDay events
  • access: public
string getRepeatWkst ()

Inherited Methods

Inherited From Event

Event::Event()
Event::getAccess()
Event::getCalType()
Event::getCalTypeName()
Event::getCategory()
Event::getClone()
Event::getDate()
Event::getDateTime()
Event::getDateTimeAdjusted()
Event::getDateTimeTS()
Event::getDescription()
Event::getDue()
Event::getDueDate()
Event::getDueDateTimeTS()
Event::getDueTime()
Event::getDuration()
Event::getEndDate()
Event::getEndDateTime()
Event::getEndDateTimeTS()
Event::getEndTime()
Event::getExtForID()
Event::getGuid()
Event::getID()
Event::getLocation()
Event::getLogin()
Event::getModDate()
Event::getModTime()
Event::getName()
Event::getOwner()
Event::getPercent()
Event::getPriority()
Event::getStatus()
Event::getTime()
Event::getUrl()
Event::isAllDay()
Event::isTimed()
Event::isUntimed()
Event::setClone()
Event::setDate()
Event::setDuration()
Event::setExtForID()
Event::setGuid()
Event::setName()
Event::setTime()

Documentation generated on Thu, 10 Jun 2010 17:08:34 -0400 by phpDocumentor 1.4.3