Class Event

Description

An event parameter object.

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

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


	
			
Direct descendents
Class Description
 class RepeatingEvent A repeating event parameter object.
Method Summary
 Event Event (string $name, string $description, string $date, string $time, int $id, mixed $extForID, int $priority, string $access, int $duration, string $status, string $owner,  $category, string $login, string $calType, string $location, string $url, int $dueDate, int $dueTime, int $percent, string $moddate, string $modtime, [ $guid = ""])
 string getAccess ()
 string getCalType ()
 string getCalTypeName ()
 mixed getCategory ()
 void getClone ()
 string getDate ()
 string getDateTime ()
 integer getDateTimeTS ()
 string getDescription ()
 int getDue ()
 string getDueDate ()
 integer getDueDateTimeTS ()
 string getDueTime ()
 int getDuration ()
 string getEndDate ()
 string getEndDateTime ()
 string getEndDateTimeTS ()
 string getEndTime ()
 mixed getExtForID ()
 void getGuid ()
 int getID ()
 string getLocation ()
 string getLogin ()
 string getModDate ()
 string getModTime ()
 string getName ()
 string getOwner ()
 int getPercent ()
 int getPriority ()
 string getStatus ()
 string getTime ()
 string getUrl ()
 bool isAllDay ()
 bool isTimed ()
 bool isUntimed ()
 void setClone ( $date)
 void setDate ( $date)
 void setDuration ( $duration)
 void setExtForID ( $forID)
 void setGuid ( $guid)
 void setName ( $name)
 void setTime ( $time)
Methods
Constructor Event (line 231)

Creates a new Event.

  • return: The new Event
  • access: public
Event Event (string $name, string $description, string $date, string $time, int $id, mixed $extForID, int $priority, string $access, int $duration, string $status, string $owner,  $category, string $login, string $calType, string $location, string $url, int $dueDate, int $dueTime, int $percent, string $moddate, string $modtime, [ $guid = ""])
  • 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
  • string $login: Event's owner
  • string $calType: Event's type
  • string $location: Event's location
  • string $url: Event's url
  • int $dueDate: Task's due date (in YYYYMMDD format)
  • int $dueTime: Task's due time (in HHMMSS format)
  • int $percent: Task's percentage of completion
  • $category
  • $guid
getAccess (line 473)

Gets the event's access level

  • return: The event's access level
  • access: public
string getAccess ()
getCalType (line 539)

Gets the event's type

  • return: The event's type
  • access: public
string getCalType ()
getCalTypeName (line 550)

Gets the event's type name

  • return: The event's type name
  • access: public
string getCalTypeName ()
getCategory (line 517)

Gets the event's category ID

  • return: The event's category ID (or '' for none)
  • access: public
mixed getCategory ()
getClone (line 762)

Get clone

  • access: public
void getClone ()
getDate (line 299)

Gets the event's date

  • return: The event's date (in YYYYMMDD format)
  • access: public
string getDate ()
getDateTime (line 400)

Gets the event's date/time

  • return: The event's date/time (in YYYYMMDDHHMMSS format)
  • access: public
string getDateTime ()
getDateTimeAdjusted (line 303)
void getDateTimeAdjusted ()
getDateTimeTS (line 413)

Gets the event's date/time as a Unix timestamp

  • return: The event's date/time as a timestamp
  • access: public
integer getDateTimeTS ()
getDescription (line 288)

Gets the event's description

  • return: The event's description
  • access: public
string getDescription ()
getDue (line 589)

Gets the event's due date and time

  • return: The event's due date time
  • access: public
int getDue ()
getDueDate (line 368)

Gets the task due date

  • return: The task due date (in YYYYMMDD format)
  • access: public
string getDueDate ()
getDueDateTimeTS (line 379)

Gets the task's due date/time as a Unix timestamp

  • return: The task's due date/time as a timestamp
  • access: public
integer getDueDateTimeTS ()
getDueTime (line 357)

Gets the task due time

  • return: The task due time (in HHMMSS format)
  • access: public
string getDueTime ()
getDuration (line 484)

Gets the event's duration

  • return: The event's duration (in minutes)
  • access: public
int getDuration ()
getEndDate (line 610)

Gets the event's end date

  • return: The event's end date YYYYMM Format
  • access: public
string getEndDate ()
getEndDateTime (line 654)

Gets the event's end datetime

  • return: The event's end datetime YYYYMMSSHHMMSS Format
  • access: public
string getEndDateTime ()
getEndDateTimeTS (line 666)

Gets the event's end datetime as UNIX timestamp

  • return: The event's end datetime UNIX timestamp Format
  • access: public
string getEndDateTimeTS ()
getEndTime (line 632)

Gets the event's end time

  • return: The event's end time HHMMSS Format
  • access: public
string getEndTime ()
getExtForID (line 446)

Gets the event's extension ID

  • return: The event's extension ID (or '' for none)
  • access: public
mixed getExtForID ()
getGuid (line 775)
void getGuid ()
getID (line 435)

Gets the event's ID

  • return: The event's ID
  • access: public
int getID ()
getLocation (line 569)

Gets the event's location

  • return: The event's location
  • access: public
string getLocation ()
getLogin (line 528)

Gets the event's owner

  • return: The event's owner
  • access: public
string getLogin ()
getModDate (line 335)

Gets the event's modified date

  • return: The event's modifieddate (in YYYYMMDD format)
  • access: public
string getModDate ()
getModTime (line 346)

Gets the event's modified time

  • return: The event's modified time (in HHMMSS format)
  • access: public
string getModTime ()
getName (line 277)

Gets the event's name

  • return: The event's name
  • access: public
string getName ()
getOwner (line 506)

Gets the event's owner

  • return: The event's owner
  • access: public
string getOwner ()
getPercent (line 599)

Gets the task's percent complete

  • return: The task's percentage
  • access: public
int getPercent ()
getPriority (line 462)

Gets the event's priority

  • return: The event's priority
  • access: public
int getPriority ()
getStatus (line 495)

Gets the event's status

  • return: The event's status
  • access: public
string getStatus ()
getTime (line 324)

Gets the event's time

  • return: The event's time (in HHMMSS format)
  • access: public
string getTime ()
getUrl (line 579)

Gets the event's url

  • return: The event's url
  • access: public
string getUrl ()
isAllDay (line 688)

Determine if event is All Day

  • return: True if event is All Day
  • access: public
bool isAllDay ()
isTimed (line 700)

Determine if event is Timed

  • return: True if event is Timed
  • access: public
bool isTimed ()
isUntimed (line 713)

Determine if event is Untimed

  • return: True if event is Untimed
  • access: public
bool isUntimed ()
setClone (line 771)

Set clone

  • access: public
void setClone ( $date)
  • $date
setDate (line 744)

Set cal_date

  • access: public
void setDate ( $date)
  • $date
setDuration (line 724)

Set cal_duration

  • access: public
void setDuration ( $duration)
  • $duration
setExtForID (line 450)
void setExtForID ( $forID)
  • $forID
setGuid (line 779)
void setGuid ( $guid)
  • $guid
setName (line 753)

Set cal_name

  • access: public
void setName ( $name)
  • $name
setTime (line 734)

Set cal_time

  • access: public
void setTime ( $time)
  • $time

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