AnewtCalendar class

A class representing an iCalendar calendar object.

Page Contents

Class Overview
Public Methods
Private Static Methods
Private Attributes
Inheritance

Class Overview

A class representing an iCalendar calendar object.

It has some basic properties and may contain one or more events (represented by AnewtCalendarEvent). An instance of this class can be serialized to a text/calendar (.ics) file, which can be imported into calendering applications such as Evolution, iCal or Outlook.

The available properties are:

filename contains the filename for this calendar
method defines the METHOD for the calendar. This is PUBLISH by default.
generator contains the product identifier (optional, defaults to an Anewt-specific string)

A filename is optional, but it is recommended to set one for better client compatibility, since some platforms ignore the MIME type information and rely on the file name (extension) to determine what actions to perform.

Public Methods ¶

`__construct``()` ¶

Construct a new AnewtCalendar instance.

`add_event``($event)` ¶

Add an event to the calendar.

Parameters

$event: An AnewtCalendarEvent instance

`render``()` ¶

Render this calendar to a string in iCal format.

Return value

String representation of this calendar

`flush``()` ¶

Output the calendar to a browser.

This renders the calendar and all its asssociated events, and sends the output to the browser with the correct HTTP headers for the MIME type and (optionally) the downoad filename.

Private Static Methods ¶

`static escape_string``($str, $multiline)` [private] [static] ¶

Escape a string so that it can be used for TEXT fields.

Newlines and other characters are escaped to match the iCalendar specification.

Parameters

$str: A string to escape.
$multiline: Boolean to indicate whether this is a multiline string. This affects how the string is escaped.

Return value

The escaped string

Private Attributes ¶

`$events` [private] ¶

Array holding all events.

AnewtCalendar class

Page Contents

Class Overview

See also

Public Methods ¶

`__construct``()` ¶

`add_event``($event)` ¶

Parameters

`render``()` ¶

Return value

`flush``()` ¶

Private Static Methods ¶

`static escape_string``($str, $multiline)` [private] [static] ¶

Parameters

Return value

Private Attributes ¶

`$events` [private] ¶

Inheritance

Base Classes

Inherited members

AnewtCalendar class

Page Contents

Class Overview

See also

Public Methods ¶

__construct() ¶

add_event($event) ¶

Parameters

render() ¶

Return value

flush() ¶

Private Static Methods ¶

static escape_string($str, $multiline) [private] [static] ¶

Parameters

Return value

Private Attributes ¶

$events [private] ¶

Inheritance

Base Classes

Inherited members

`__construct``()` ¶

`add_event``($event)` ¶

`render``()` ¶

`flush``()` ¶

`static escape_string``($str, $multiline)` [private] [static] ¶

`$events` [private] ¶