EasyPeasyICS Class Reference

Collaboration diagram for EasyPeasyICS:

Public Member Functions
	__construct ($calendarName="")
	Constructor. More...
	addEvent ($start, $end, $summary='', $description='', $url='', $uid='')
	Add an event to this calendar. More...
	getEvents ()
	clearEvents ()
	Clear all events. More...
	getName ()
	Get the name of the calendar. More...
	setName ($name)
	Set the name of the calendar. More...
	render ($output=true)
	Render and optionally output a vcal string. More...

Protected Attributes
	$calendarName
	$events = array()

Detailed Description

Definition at line 20 of file EasyPeasyICS.php.

Constructor & Destructor Documentation

__construct()

EasyPeasyICS::__construct

(

$calendarName = ""

)

Constructor.

Parameters

string

$calendarName

Definition at line 37 of file EasyPeasyICS.php.

    {
        $this->calendarName = $calendarName;
    }

References $calendarName.

Member Function Documentation

addEvent()

EasyPeasyICS::addEvent	(		$start,
			$end,
			$summary = '',
			$description = '',
			$url = '',
			$uid = ''
	)

Add an event to this calendar.

Parameters

string	$start	The start date and time as a unix timestamp
string	$end	The end date and time as a unix timestamp
string	$summary	A summary or title for the event
string	$description	A description of the event
string	$url	A URL for the event
string	$uid	A unique identifier for the event - generated automatically if not provided

Returns

array An array of event details, including any generated UID

Definition at line 52 of file EasyPeasyICS.php.

    {
        if (empty($uid)) {
            $uid = md5(uniqid(mt_rand(), true)) . '@EasyPeasyICS';
        }
        $event = array(
            'start' => gmdate('Ymd', $start) . 'T' . gmdate('His', $start) . 'Z',
            'end' => gmdate('Ymd', $end) . 'T' . gmdate('His', $end) . 'Z',
            'summary' => $summary,
            'description' => $description,
            'url' => $url,
            'uid' => $uid
        );
        $this->events[] = $event;
        return $event;
    }

References $url.

clearEvents()

EasyPeasyICS::clearEvents

(

)

Clear all events.

Definition at line 80 of file EasyPeasyICS.php.

    {
        $this->events = array();
    }

getEvents()

EasyPeasyICS::getEvents

(

)

Returns

array Get the array of events.

Definition at line 72 of file EasyPeasyICS.php.

    {
        return $this->events;
    }

References $events.

getName()

EasyPeasyICS::getName

(

)

Get the name of the calendar.

Returns

string

Definition at line 89 of file EasyPeasyICS.php.

    {
        return $this->calendarName;
    }

References $calendarName.

render()

EasyPeasyICS::render

(

$output = true

)

Render and optionally output a vcal string.

Parameters

bool

$output

Whether to output the calendar data directly (the default).

Returns

string The complete rendered vlal

Definition at line 108 of file EasyPeasyICS.php.

    {
        //Add header
        $ics = 'BEGIN:VCALENDAR
METHOD:PUBLISH
VERSION:2.0
X-WR-CALNAME:' . $this->calendarName . '
PRODID:-//hacksw/handcal//NONSGML v1.0//EN';
 
        //Add events
        foreach ($this->events as $event) {
            $ics .= '
BEGIN:VEVENT
UID:' . $event['uid'] . '
DTSTAMP:' . gmdate('Ymd') . 'T' . gmdate('His') . 'Z
DTSTART:' . $event['start'] . '
DTEND:' . $event['end'] . '
SUMMARY:' . str_replace("\n", "\\n", $event['summary']) . '
DESCRIPTION:' . str_replace("\n", "\\n", $event['description']) . '
URL;VALUE=URI:' . $event['url'] . '
END:VEVENT';
        }
 
        //Add footer
        $ics .= '
END:VCALENDAR';
 
        if ($output) {
            //Output
            $filename = $this->calendarName;
            //Filename needs quoting if it contains spaces
            if (strpos($filename, ' ') !== false) {
                $filename = '"'.$filename.'"';
            }
            header('Content-type: text/calendar; charset=utf-8');
            header('Content-Disposition: inline; filename=' . $filename . '.ics');
            echo $ics;
        }
        return $ics;
    }

References $calendarName, and $filename.

setName()

EasyPeasyICS::setName

(

$name

)

Set the name of the calendar.

Parameters

$name

Definition at line 98 of file EasyPeasyICS.php.

    {
        $this->calendarName = $name;
    }

Field Documentation

$calendarName

EasyPeasyICS::$calendarName

protected

Definition at line 26 of file EasyPeasyICS.php.

Referenced by __construct(), getName(), and render().

$events

EasyPeasyICS::$events = array()

protected

Definition at line 31 of file EasyPeasyICS.php.

Referenced by getEvents().

---

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

• Services/Mail/phpmailer/extras/EasyPeasyICS.php