API Documentation
\

\Horde_Compress_Dbx

This class allows dbx files (e.g. from Outlook Express) to be read.

Summary

Methods
Properties
Constants
__construct()
compress()
compressDirectory()
decompress()
$canCompress
$canDecompress
No constants found
_readString()
_readMessage()
_readMessageInfo()
_readIndex()
$_logger
$_flagArray
$_mails
$_tmp
N/A
No private methods found
No private properties found
N/A

Properties

$canCompress

$canCompress : boolean

Does this driver support compressing data?

Type

boolean

$canDecompress

$canDecompress : boolean

Does this driver support decompressing data?

Type

boolean

$_logger

$_logger : \Horde_Log_Logger

Logger

Type

\Horde_Log_Logger

$_flagArray

$_flagArray : array

TODO

Type

array

$_mails

$_mails : array

TODO

Type

array

$_tmp

$_tmp : array

TODO

Type

array

Methods

__construct()

__construct(array  $options = array())

Constructor.

Parameters

array $options

Additional options for the compressor backend.

compress()

compress(mixed  $data, array  $params = array()) : mixed

Compresses the data.

Parameters

mixed $data

The data to compress.
array $params

An array of arguments needed to compress the data.

Throws

\Horde_Compress_Exception

Returns

mixed —

The compressed data.

compressDirectory()

compressDirectory(string  $directory, array  $params = array()) : mixed

Compresses a directory.

Parameters

string $directory

The directory to recursively compress.
array $params

An array of arguments needed to compress the data.

Throws

\Horde_Compress_Exception

Returns

mixed —

The compressed data.

decompress()

decompress(mixed  $data, array  $params = array()) : array

Decompresses the data.

Parameters

mixed $data

The data to decompress.
array $params

An array of arguments needed to decompress the data.

Returns

array —

List of messages.

_readString()

_readString(string  $buf, integer  $pos) : string

Returns a null-terminated string from the specified data.

Parameters

string $buf

TODO
integer $pos

TODO

Returns

string —

TODO

_readMessage()

_readMessage(string  $data, integer  $position) : string

TODO

Parameters

string $data

TODO
integer $position

TODO

Throws

\Horde_Compress_Exception

Returns

string —

TODO

_readMessageInfo()

_readMessageInfo(string  $data, integer  $position) : array

TODO

Parameters

string $data

TODO
integer $position

TODO

Throws

\Horde_Compress_Exception

Returns

array —

TODO

_readIndex()

_readIndex(string  $data, integer  $position)

TODO

Parameters

string $data

TODO
integer $position

TODO

Throws

\Horde_Compress_Exception