PHP Class Horde_Compress_Tnef_Object, horde

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Michael J Rubinsky ([email protected])
Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_data string
$_logger Horde_Log_Logger
$_options array

Public Methods

Method Description
__construct ( $logger, $data = null, $options = [] )
setMapiAttribute ( integer $type, integer $name, $value ) Allow this object to set any MAPI attributes it needs to know about, ignore any it doesn't care about.
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.
toArray ( ) : array Output the data for this object in an array.

Protected Methods

Method Description
_geti ( &$data, integer $bits ) : integer Pop specified number of bits from the buffer
_getx ( &$data, integer $bytes ) : string Pop specified number of bytes from the buffer.

Method Details

__construct() public method

public __construct ( $logger, $data = null, $options = [] )

_geti() protected method

Pop specified number of bits from the buffer
protected _geti ( &$data, integer $bits ) : integer
$bits integer How many bits to retrieve.
return integer The value from $data.

_getx() protected method

Pop specified number of bytes from the buffer.
protected _getx ( &$data, integer $bytes ) : string
$bytes integer How many bytes to retrieve.
return string The specified number of bytes from $data.

setMapiAttribute() public method

Allow this object to set any MAPI attributes it needs to know about, ignore any it doesn't care about.
public setMapiAttribute ( integer $type, integer $name, $value )
$type integer The attribute type descriptor.
$name integer The attribute name descriptor.

setTnefAttribute() public method

Allow this object to set any TNEF attributes it needs to know about, ignore any it doesn't care about.
public setTnefAttribute ( integer $attribute, mixed $value, integer $size )
$attribute integer The attribute descriptor.
$value mixed The value from the MAPI stream.
$size integer The byte length of the data, as reported by the MAPI data.

toArray() public method

Output the data for this object in an array.
public toArray ( ) : array
return array - type: (string) The MIME type of the content. - subtype: (string) The MIME subtype. - name: (string) The filename. - stream: (string) The file data.

Property Details

$_data protected property

protected string $_data
return string

$_logger protected property

protected Horde_Log_Logger $_logger
return Horde_Log_Logger

$_options protected property

protected array $_options
return array