Horde_Compress_Tnef_Object
in package
Base object for any files/attachments encapsulated in a TNEF file.
Tags
Table of Contents
- $_data : string
- $_logger : Horde_Log_Logger
- $_options : array<string|int, mixed>
- __construct() : mixed
- setMapiAttribute() : mixed
- Allow this object to set any MAPI attributes it needs to know about, ignore any it doesn't care about.
- 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.
Properties
$_data
protected
string
$_data
$_logger
protected
Horde_Log_Logger
$_logger
$_options
protected
array<string|int, mixed>
$_options
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 —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
Parameters
- $type : int
-
The attribute type descriptor.
- $name : int
-
The attribute name descriptor.
- $value : mixed
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.