Horde_Compress_Tnef_Icalendar
extends Horde_Compress_Tnef_Object
in package
Object to parse and represent iCalendar data encapsulated in a TNEF file.
Tags
Table of Contents
- PART_ACCEPTED = 'ACCEPTED'
- PART_ACTION = 'NEEDS-ACTION'
- PART_DECLINE = 'DECLINE'
- PART_TENTATIVE = 'TENTATIVE'
- $type : string
- MIME type.
- $_allday : bool
- $_content : string
- Cache of the iCalendar text.
- $_created : Horde_Date
- $_data : string
- $_description : string
- The description/body of the meeting request.
- $_duration : string
- $_endUtc : Horde_Date
- $_from : string
- The "From" attribute used by iTip responses.
- $_lastModifier : string
- $_location : string
- $_logger : Horde_Log_Logger
- $_method : string
- ICalendar METHOD
- $_modified : Horde_Date
- $_options : array<string|int, mixed>
- $_organizer : string
- $_partStat : string
- The current PARTSTAT property for this meeting request.
- $_recurrence : array<string|int, mixed>
- Recurrence data.
- $_requiredAttendees : string
- List of required attendees parsed from the MAPI object.
- $_rsvp : bool
- RSVP property
- $_startUtc : Horde_Date
- $_summary : string
- $_type : int
- $_uid : string
- $_url : string
- __construct() : mixed
- __get() : mixed
- Accessor
- setMapiAttribute() : mixed
- Allow this object to set any MAPI attributes it needs to know about, ignore any it doesn't care about.
- setMethod() : mixed
- Set the METHOD parameter, used to help generate the PART-STAT attribute.
- setTnefAttribute() : mixed
- Allow this object to set any TNEF attributes it needs to know about, ignore any it doesn't care about.
- toArray() : array<string|int, mixed>
- Output the data for this object in an array.
- _geti() : int
- Pop specified number of bits from the buffer
- _getx() : string
- Pop specified number of bytes from the buffer.
- _parseRecurrence() : Horde_Date_Recurrence
- Parse recurrence properties.
- _toItip() : array<string|int, mixed>
- Generate an iTip from embedded TNEF MEETING data.
Constants
PART_ACCEPTED
public
mixed
PART_ACCEPTED
= 'ACCEPTED'
PART_ACTION
public
mixed
PART_ACTION
= 'NEEDS-ACTION'
PART_DECLINE
public
mixed
PART_DECLINE
= 'DECLINE'
PART_TENTATIVE
public
mixed
PART_TENTATIVE
= 'TENTATIVE'
Properties
$type
MIME type.
public
string
$type
= 'text/calendar'
$_allday
protected
bool
$_allday
$_content
Cache of the iCalendar text.
protected
string
$_content
$_created
protected
Horde_Date
$_created
$_data
protected
string
$_data
$_description
The description/body of the meeting request.
protected
string
$_description
$_duration
protected
string
$_duration
$_endUtc
protected
Horde_Date
$_endUtc
$_from
The "From" attribute used by iTip responses.
protected
string
$_from
$_lastModifier
protected
string
$_lastModifier
$_location
protected
string
$_location
$_logger
protected
Horde_Log_Logger
$_logger
$_method
ICalendar METHOD
protected
string
$_method
$_modified
protected
Horde_Date
$_modified
$_options
protected
array<string|int, mixed>
$_options
$_organizer
protected
string
$_organizer
$_partStat
The current PARTSTAT property for this meeting request.
protected
string
$_partStat
A self::PART_* constant.
$_recurrence
Recurrence data.
protected
array<string|int, mixed>
$_recurrence
= array()
$_requiredAttendees
List of required attendees parsed from the MAPI object.
protected
string
$_requiredAttendees
$_rsvp
RSVP property
protected
bool
$_rsvp
= \false
$_startUtc
protected
Horde_Date
$_startUtc
$_summary
protected
string
$_summary
$_type
protected
int
$_type
$_uid
protected
string
$_uid
$_url
protected
string
$_url
Methods
__construct()
public
__construct(mixed $logger[, mixed $data = null ][, mixed $options = array() ]) : mixed
Parameters
- $logger : mixed
- $data : mixed = null
- $options : mixed = array()
Return values
mixed —__get()
Accessor
public
__get(string $property) : mixed
Parameters
- $property : string
Return values
mixed —setMapiAttribute()
Allow this object to set any MAPI attributes it needs to know about, ignore any it doesn't care about.
public
setMapiAttribute(int $type, int $name, mixed $value[, mixed $ns = null ]) : mixed
Parameters
- $type : int
-
The attribute type descriptor.
- $name : int
-
The attribute name descriptor.
- $value : mixed
-
The value to set.
- $ns : mixed = null
Tags
Return values
mixed —setMethod()
Set the METHOD parameter, used to help generate the PART-STAT attribute.
public
setMethod(string $method[, string $class = null ]) : mixed
Parameters
- $method : string
-
The METHOD parameter.
- $class : string = null
-
The message class.
Return values
mixed —setTnefAttribute()
Allow this object to set any TNEF attributes it needs to know about, ignore any it doesn't care about.
public
setTnefAttribute(int $attribute, mixed $value, int $size) : mixed
Parameters
- $attribute : int
-
The attribute descriptor.
- $value : mixed
-
The value from the MAPI stream.
- $size : int
-
The byte length of the data, as reported by the MAPI data.
Return values
mixed —toArray()
Output the data for this object in an array.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —- type: (string) The MIME type of the content.
- subtype: (string) The MIME subtype.
- name: (string) The filename.
- stream: (string) The file data.
_geti()
Pop specified number of bits from the buffer
protected
_geti(string &$data, int $bits) : int
Parameters
- $data : string
-
The data string.
- $bits : int
-
How many bits to retrieve.
Return values
int —The value from $data.
_getx()
Pop specified number of bytes from the buffer.
protected
_getx(string &$data, int $bytes) : string
Parameters
- $data : string
-
The data string.
- $bytes : int
-
How many bytes to retrieve.
Return values
string —The specified number of bytes from $data.
_parseRecurrence()
Parse recurrence properties.
protected
_parseRecurrence(string $value) : Horde_Date_Recurrence
Parameters
- $value : string
-
MAPI stream
Tags
Return values
Horde_Date_Recurrence —_toItip()
Generate an iTip from embedded TNEF MEETING data.
protected
_toItip() : array<string|int, mixed>
Return values
array<string|int, mixed> —see @self::toArray().