Note: we may wish to add someting like this to description: More...

Public Member Functions
	__construct ($id, $start, $end, $title, $description="", $location="", $sequence_id=0, $timeZone=null)
	The iCalendarManager obj is typically instantiated through the EventHandler for an event. More...

	setAliases ()

	setEventDates ($start, $end, $timeZone)
	For all day events: DTSTART;VALUE=DATE:20100101 DTEND;VALUE=DATE:20100101. More...

	setTimeZone ($timeZone, $start_value)
	If time zone is not provided, exlcude the time zone fields so they are not included in the output. More...

	formatTimeZoneHours ($offset)
	Given the numeric time zone value (pos or neg), convert to hour format for iCalendar such as "-0700". More...

	excludeTimeZoneFields ()
	If no time zone provided, exclude all fields between begin_timezone through end_timezone. More...

	isAllDay ($date)

	setAttachment ($path)

	setOrganizer ($replyTo, $replyToName="")

	setAttendee ($mailTo)
	Called from EmailHandler to set the attendee email address. More...

	setAttendeeName ($name)

	formatOrganizer ()
	We wait until final formatting of the iCalendar data to set the organizer properties because values can be set after the iCalendar object is instantiated. More...

	formatAttendee ()
	Given all the settings applied to vars, build the ATTENDEE property to be used in the calendar invitation. More...

	format ()
	Given the icalendar data values and the var settings, format the iCalendar data into a list of properties and values in the field order of the iCalendarData object values. More...

Public Attributes
	$replyTo
	organizer email set in EmailHandler More...

	$replyToName
	organizer name set in EmailHandler More...

	$mailTo
	Attendee email address. More...

	$attendeeName
	optionally include display name of recipient More...

	$rsvp = true
	organizer wants reply More...

	$attendeeStatus
	PARSTAT=TENTATIVE, PARSTAT=NEEDS-ACTION. More...

	$required = false
	ROLE=REQ-PARTICIPANT if required to attend. More...

	$invitees = array()
	optionally show others invited to event More...

	$data
	iCalendarData obj More...

	$aliases = array()
	field aliases or labels More...

Detailed Description

Note: we may wish to add someting like this to description:

The following is a new meeting request:
\nSubject: test send to mac \nOrganizer: "Janice Gallant" janic.nosp@m.e@so.nosp@m.njara.nosp@m..com
\nTime: Wednesday\ , March 20\, 2013\, 1:00:00 PM - 2:00:00 PM GMT -05:00 US/Canada Eastern
\ nInvitees: janic.nosp@m.e.ga.nosp@m.llant.nosp@m.@ver.nosp@m.izon..nosp@m.net

*~*~*~*~*~*~*~*~*~*

X-ALT-DESC;FMTTYPE=text/html:<html><body>

The following is a new meeting request:

Subject:<t d>test send to mac

Organizer:

"Janice Gallant" &lt\;janic.nosp@m.e@so.nosp@m.njara.nosp@m..com&gt\;

Time:

Wednesday\, March 20\, 2013\, 1:0 0:00 PM - 2:00:00 PM GMT -05:00 US/Canada Eastern

\ n

Invitees:

janice.gallant@ver izon.net

*~*~*~*~*~*~*~*~*~*

</body></ht>

Definition at line 126 of file i_calendar_manager.inc.

Constructor & Destructor Documentation

◆ __construct()

iCalendarEventManager::__construct	(	$id,
		$start,
		$end,
		$title,
		$description = `""`,
		$location = `""`,
		$sequence_id = `0`,
		$timeZone = `null`
	)

The iCalendarManager obj is typically instantiated through the EventHandler for an event.

E.g., the StandardEventHandler class can all formatiCalendar to instantiate an iCalendarManager obj by providing its event details such as start_date, end_date, location, etc.

After the obj is created, the calling code can set other configurable values such as attendee name, if known. It can also override default values set in the constructor, such as method.

Parameters

Number	$id	- event id or other unique identifier for the invitation
	DATE	or DATETIME $start
	DATE	or DATETIME $end
String	$title
HTML	$description
String	$location
Number	$sequence_id	- increment sequence id when event is updated
obj	$timeZone	- instance of TimeZone, optional. If provided, set timezone properties

Definition at line 158 of file i_calendar_manager.inc.

      {
           global $config;
                     
           $this->data = new iCalendarData();
           $this->data->set("summary", $title);
           $this->data->set("description", $description);
           $this->data->set("location", $location);
  
           // The uid must be globally unique thus is includes the http_host
           // and the event id.
           $uid = $id . $config["http_host"];
           $this->data->set("uid", $uid);
           
           $this->data->set("sequence", $sequence_id);
           
           $this->data->set("dtstart", $start);
           $this->data->set("dtend", $end);
           
           $today = new DateTime(now()); 
           $this->data->set("dtstamp", $today->format('Ymd\THis'));
           
           $this->data->filter = new ExclusionFilter("last_modified", "standard_rrule", "daylight_rrule");     
           // is last modified needed?
           //$this->data->last_modified = $today;
                
           $this->data->set("priority", 5);
           $this->data->set("class", "PUBLIC");
           
           $this->data->set("begin_calendar", "VCALENDAR");
           $this->data->set("prodid", "-//Microsoft Corporation//Outlook 11.0 MIMEDIR//EN");
           $this->data->set("version", "2.0");
           $this->data->set("begin_event", "VEVENT");
           $this->data->set("transp", "OPAQUE");
           $this->data->set("display_status", "BUSY");
           $this->data->set("end_event", "VEVENT");
           $this->data->set("end_calendar", "VCALENDAR");
           $this->data->set("method", "REQUEST");
           $this->data->set("event_status",  "CONFIRMED");
                     
           $this->setEventDates($start, $end, $timeZone);
  
           $this->setAliases();
      }

Member Function Documentation

◆ excludeTimeZoneFields()

iCalendarEventManager::excludeTimeZoneFields ( )

If no time zone provided, exclude all fields between begin_timezone through end_timezone.

Definition at line 328 of file i_calendar_manager.inc.

      {
           $filter = $this->data->getFilter();
           if(!$filter)
           {
                $filter = new ExclusionFilter();
           }
                
           $fields = $this->data->getFields();
           $tz_field = false;
           foreach($fields as $name => $type)
           {
                if($name == "begin_timezone")
                {
                     $tz_field = true;
                }
                if($tz_field)
                {
                     $filter->excludeField($name);
                }
                if($name == "end_timezone")
                {
                     $tz_field = false;
                }
           }
      }

◆ format()

iCalendarEventManager::format ( )

Given the icalendar data values and the var settings, format the iCalendar data into a list of properties and values in the field order of the iCalendarData object values.

This format function is called from the EmailHandler when formatting the message.

Example:

BEGIN:VCALENDAR PRODID:-//Microsoft Corporation//Outlook 11.0 MIMEDIR//EN VERSION:2.0 METHOD:METHOD BEGIN:VEVENT ORGANIZER;CN=Web Site Administrator:MAILTO:andy@.nosp@m.sonj.nosp@m.ara.c.nosp@m.om ATTENDEE;RSVP=true;CN=Janice Gallant:MAILTO:janic.nosp@m.e@so.nosp@m.njara.nosp@m..com DTSTART;VALUE=DATE:20130328 DTEND;VALUE=DATE:20130328 LOCATION:test TRANSP:OPAQUE STATUS:CONFIRMED X-MICROSOFT-CDO-INTENDEDSTATUS:BUSY UID:243stem2stern SEQUENCE:2 DTSTAMP:20130321T120233 DESCRIPTION:test SUMMARY:test all day PRIORITY:5 CLASS:PUBLIC END:VEVENT END:VCALENDAR

Returns: string

Definition at line 484 of file i_calendar_manager.inc.

      {    
           $this->data->organizer = $this->formatOrganizer();
           $this->data->attendee = $this->formatAttendee();
      
           $filter = $this->data->getFilter();
           $fields = $this->data->getFields();
           foreach (array_keys($fields) as $field)
           {
                if ($field != $pk  && !($filter && $filter->isExcluded($field)))
                {
                     $label = strtoupper($field);
                     if(array_key_exists($field, $this->aliases))
                     {
                          $label = $this->aliases[$field];
                     }
                     
                     $value = $this->data->$field;
                     if(!preg_match("/^;|:/", $value))
                     {
                          $value = ":". $value;
                     }
                     $properties[] = $label . $value;
                }
           }
           
           $out = "\r\n";
           $out .= implode("\n", $properties);
           $out .= "\r\n";
           
           return $out;
      }

◆ formatAttendee()

iCalendarEventManager::formatAttendee ( )

Given all the settings applied to vars, build the ATTENDEE property to be used in the calendar invitation.

Example: ATTENDEE;ROLE=REQ-PARTICIPANT;PARTSTAT=TENTATIVE;DELEGATED-FROM= "MAILTO:iamboss@host2.com";CN=Henry Cabot:MAILTO:hcabot@ host2.com

Definition at line 423 of file i_calendar_manager.inc.

      {
           if($this->required)
           {
                $attendee .= ";ROLE=REQ-PARTICIPANT";
           }
           
           if($this->attendeeStatus)
           {
                $attendee .= ";PARTSTAT={$this->attendeeStatus}";
           }
           
           if($this->rsvp)
           {
                $attendee .= ";RSVP=true";
           }
           
           if($this->attendeeName)
           {
                $attendee .= ";CN={$this->attendeeName}";    
           }
                
           $attendee .= ":MAILTO:{$this->mailTo}";
           
           return $attendee;
      }

◆ formatOrganizer()

iCalendarEventManager::formatOrganizer ( )

We wait until final formatting of the iCalendar data to set the organizer properties because values can be set after the iCalendar object is instantiated.

EmailHandler calls setOrganizer to set the replyTo email address and replyToName

Example: ORGANIZER;CN=John Smith:MAILTO:jsmit.nosp@m.h@ho.nosp@m.st1.c.nosp@m.om

Definition at line 402 of file i_calendar_manager.inc.

      {
           if($this->replyToName)
           {
                $organizer .= ";CN={$this->replyToName}";
           }
           
           $organizer .= ":MAILTO:{$this->replyTo}";
           
           return $organizer;
      }

◆ formatTimeZoneHours()

iCalendarEventManager::formatTimeZoneHours ( $offset )

Given the numeric time zone value (pos or neg), convert to hour format for iCalendar such as "-0700".

Noninteger time zones offset are rare and none are segments other than the half hour. If non integer, set the min to 30 regardless of the entered value.

Parameters

Number $offset

Returns: String

Definition at line 297 of file i_calendar_manager.inc.

      {
           $neg = false;
           if($offset < 0)
           {
                $neg = true;
                $offset = abs($offset);
           }
  
           $hour = $offset;
           $min = "00";
           if(!is_int($offset))
           {
                $hour = floor($offset);
                $min = "30";
           }
           
           $out = str_pad($hour, 2, STR_PAD_LEFT) . $min;
           
           if($neg)
           {
                $out = "-" . $out;
           }
           
           return $out;
      }

◆ isAllDay()

iCalendarEventManager::isAllDay ( $date )

Definition at line 355 of file i_calendar_manager.inc.

      {
           if(preg_match("/00:00:00$/", $date))
           {
                return true;
           }
      
           return false;
      }

◆ setAliases()

iCalendarEventManager::setAliases ( )

Definition at line 203 of file i_calendar_manager.inc.

      {
           $aliases = $this->data->getFieldAliases();
           // Read in default alias definitions from DataItem
           if ($aliases)
           {
                foreach($aliases as $field => $alias)
                {
                     $this->aliases[$field] = $alias;
                }
           }    
      }

◆ setAttachment()

iCalendarEventManager::setAttachment ( $path )

Definition at line 365 of file i_calendar_manager.inc.

      {
           //ATTACH;FMTTYPE=image/jpeg:http://domain.com/images/bastille.jpg
      }

◆ setAttendee()

iCalendarEventManager::setAttendee ( $mailTo )

Called from EmailHandler to set the attendee email address.

The code that calls the EmailHandler can set the attendee name if known.

Parameters

String $mailTo

Definition at line 382 of file i_calendar_manager.inc.

      {
           $this->mailTo = $mailTo;;
      }

◆ setAttendeeName()

iCalendarEventManager::setAttendeeName ( $name )

Definition at line 387 of file i_calendar_manager.inc.

      {
           $this->attendeeName = $name;
      }

◆ setEventDates()

iCalendarEventManager::setEventDates	(	$start,
		$end,
		$timeZone
	)

For all day events: DTSTART;VALUE=DATE:20100101 DTEND;VALUE=DATE:20100101.

Definition at line 221 of file i_calendar_manager.inc.

      {
           $startObj = new DateTime($start);
           $endObj = new DateTime($end);
           
           if($this->isAllDay($start) && $this->isAllDay($end))
           {
                $start_value = ";VALUE=DATE:" . $startObj->format("Ymd");
                $end_value = ";VALUE=DATE:" . $endObj->format("Ymd");
           }
           else
           {
                $start_value = $startObj->format('Ymd\THis');
                $end_value = $endObj->format('Ymd\THis');
           }
           
           if($timeZone)
           {
                $this->setTimeZone($timeZone, $start_value);
                $this->data->set("dtstart", ";TZID=" . $timeZone->time_zone_name . ":". $start_value);
                $this->data->set("dtend", ";TZID=" . $timeZone->time_zone_name . ":". $end_value);
           }
           else
           {
                $this->excludeTimeZoneFields();
                $this->data->set("dtstart", $start_value);
                $this->data->set("dtend", $end_value);
           }
      }

◆ setOrganizer()

iCalendarEventManager::setOrganizer	(	$replyTo,
		$replyToName = `""`
	)

Definition at line 370 of file i_calendar_manager.inc.

      {
           $this->replyTo = $replyTo;
           $this->replyToName = $replyToName;
      }

◆ setTimeZone()

iCalendarEventManager::setTimeZone	(	$timeZone,
		$start_value
	)

If time zone is not provided, exlcude the time zone fields so they are not included in the output.

If provided, set the values.

Parameters

obj $timeZone class TimeZone

Definition at line 259 of file i_calendar_manager.inc.

      {
           $this->data->set("begin_timezone", "VTIMEZONE");
           $this->data->set("begin_standard", "STANDARD");
           $this->data->set("end_standard", "STANDARD");
           $this->data->set("begin_daylight", "DAYLIGHT");
           $this->data->set("end_daylight", "DAYLIGHT");
           $this->data->set("end_timezone", "VTIMEZONE");
           
           $this->data->set("tzid", $timeZone->get("time_zone_name"));
           
           $standard_offset = $this->formatTimeZoneHours($timeZone->standard_offset);
           $daylight_offset = $this->formatTimeZoneHours($timeZone->daylight_offset);
           
           $this->data->set("standard_name", "EST");
           $this->data->set("daylight_name", "EDT");
           $this->data->set("standard_offset", $standard_offset);
           $this->data->set("standard_dst_offset", $daylight_offset);
           $this->data->set("daylight_offset", $daylight_offset);
           $this->data->set("daylight_dst_offset", $standard_offset);  
           
           $this->data->set("standard_start", $start_value);
           $this->data->set("daylight_start", $start_value);
      }

Member Data Documentation

◆ $aliases

iCalendarEventManager::$aliases = array()

field aliases or labels

Definition at line 137 of file i_calendar_manager.inc.

◆ $attendeeName

iCalendarEventManager::$attendeeName

optionally include display name of recipient

Definition at line 131 of file i_calendar_manager.inc.

◆ $attendeeStatus

iCalendarEventManager::$attendeeStatus

PARSTAT=TENTATIVE, PARSTAT=NEEDS-ACTION.

Definition at line 133 of file i_calendar_manager.inc.

◆ $data

iCalendarEventManager::$data

iCalendarData obj

Definition at line 136 of file i_calendar_manager.inc.

◆ $invitees

iCalendarEventManager::$invitees = array()

optionally show others invited to event

Definition at line 135 of file i_calendar_manager.inc.

◆ $mailTo

iCalendarEventManager::$mailTo

Attendee email address.

Definition at line 130 of file i_calendar_manager.inc.

◆ $replyTo

iCalendarEventManager::$replyTo

organizer email set in EmailHandler

Definition at line 128 of file i_calendar_manager.inc.

◆ $replyToName

iCalendarEventManager::$replyToName

organizer name set in EmailHandler

Definition at line 129 of file i_calendar_manager.inc.

◆ $required

iCalendarEventManager::$required = false

ROLE=REQ-PARTICIPANT if required to attend.

Definition at line 134 of file i_calendar_manager.inc.

◆ $rsvp

iCalendarEventManager::$rsvp = true

organizer wants reply

Definition at line 132 of file i_calendar_manager.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/cms/components/calendar/i_calendar_manager.inc

Public Member Functions

Public Attributes

Detailed Description

The following is a new meeting request:

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ excludeTimeZoneFields()

◆ format()

◆ formatAttendee()

◆ formatOrganizer()

◆ formatTimeZoneHours()

◆ isAllDay()

◆ setAliases()

◆ setAttachment()

◆ setAttendee()

◆ setAttendeeName()

◆ setEventDates()

◆ setOrganizer()

◆ setTimeZone()

Member Data Documentation

◆ $aliases

◆ $attendeeName

◆ $attendeeStatus

◆ $data

◆ $invitees

◆ $mailTo

◆ $replyTo

◆ $replyToName

◆ $required

◆ $rsvp