API Documentation
\

\Horde_Compress_Tnef_Icalendar

Object to parse and represent iCalendar data encapsulated in a TNEF file.

Summary

Methods
Properties
Constants
__construct()
setTnefAttribute()
setMapiAttribute()
toArray()
__get()
setMethod()
$type
PART_ACTION
PART_TENTATIVE
PART_DECLINE
PART_ACCEPTED
_getx()
_geti()
_parseRecurrence()
_toItip()
$_logger
$_data
$_options
$_method
$_summary
$_location
$_url
$_startUtc
$_endUtc
$_duration
$_allday
$_organizer
$_lastModifier
$_from
$_uid
$_recurrence
$_type
$_created
$_modified
$_content
$_requiredAttendees
$_partStat
$_description
$_rsvp
N/A
No private methods found
No private properties found
N/A

Constants

PART_ACTION

PART_ACTION

PART_TENTATIVE

PART_TENTATIVE

PART_DECLINE

PART_DECLINE

PART_ACCEPTED

PART_ACCEPTED

Properties

$type

$type : string

MIME type.

Type

string

$_logger

$_logger : \Horde_Log_Logger

Type

\Horde_Log_Logger

$_data

$_data : string

Type

string

$_options

$_options : array

Type

array

$_method

$_method : string

ICalendar METHOD

Type

string

$_summary

$_summary : string

Type

string

$_location

$_location : string

Type

string

$_url

$_url : string

Type

string

$_startUtc

$_startUtc : \Horde_Date

Type

\Horde_Date

$_endUtc

$_endUtc : \Horde_Date

Type

\Horde_Date

$_duration

$_duration : string

Type

string

$_allday

$_allday : boolean

Type

boolean

$_organizer

$_organizer : string

Type

string

$_lastModifier

$_lastModifier : string

Type

string

$_from

$_from : string

The "From" attribute used by iTip responses.

Type

string

$_uid

$_uid : string

Type

string

$_recurrence

$_recurrence : array

Recurrence data.

Type

array

$_type

$_type : integer

Type

integer

$_created

$_created : \Horde_Date

Type

\Horde_Date

$_modified

$_modified : \Horde_Date

Type

\Horde_Date

$_content

$_content : string

Cache of the iCalendar text.

Type

string

$_requiredAttendees

$_requiredAttendees : string

List of required attendees parsed from the MAPI object.

Type

string

$_partStat

$_partStat : string

The current PARTSTAT property for this meeting request.

Type

string — A self::PART_* constant.

$_description

$_description : string

The description/body of the meeting request.

Type

string

$_rsvp

$_rsvp : boolean

RSVP property

Type

boolean

Methods

__construct()

__construct(  $logger,   $data = null,   $options = array())

Parameters

$logger
$data
$options

setTnefAttribute()

setTnefAttribute(integer  $attribute, mixed  $value, integer  $size)

Allow this object to set any TNEF attributes it needs to know about, ignore any it doesn't care about.

Parameters

integer $attribute

The attribute descriptor.
mixed $value

The value from the MAPI stream.
integer $size

The byte length of the data, as reported by the MAPI data.

setMapiAttribute()

setMapiAttribute(integer  $type, integer  $name, mixed  $value,   $ns = null)

Allow this object to set any MAPI attributes it needs to know about, ignore any it doesn't care about.

Parameters

integer $type

The attribute type descriptor.
integer $name

The attribute name descriptor.
mixed $value

The value to set.
$ns

Throws

\Horde_Compress_Exception

toArray()

toArray() : array

Output the data for this object in an array.

Returns

array —
  • type: (string) The MIME type of the content.
    • subtype: (string) The MIME subtype.
    • name: (string) The filename.
    • stream: (string) The file data.

__get()

__get(string  $property) : mixed

Accessor

Parameters

string $property

Returns

mixed

setMethod()

setMethod(string  $method, string  $class = null)

Set the METHOD parameter, used to help generate the PART-STAT attribute.

Parameters

string $method

The METHOD parameter.
string $class

The message class.

_getx()

_getx(  $data, integer  $bytes) : string

Pop specified number of bytes from the buffer.

Parameters

$data
integer $bytes

How many bytes to retrieve.

Returns

string —

The specified number of bytes from $data.

_geti()

_geti(  $data, integer  $bits) : integer

Pop specified number of bits from the buffer

Parameters

$data
integer $bits

How many bits to retrieve.

Returns

integer —

The value from $data.

_parseRecurrence()

_parseRecurrence(string  $value) : \Horde_Date_Recurrence

Parse recurrence properties.

Parameters

string $value

MAPI stream

Throws

\Horde_Compress_Exception

Returns

\Horde_Date_Recurrence

_toItip()

_toItip() : array

Generate an iTip from embedded TNEF MEETING data.

Returns

array —

see @self::toArray().