Documentation

Horde_Compress_Dbx extends Horde_Compress_Base
in package

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

Tags
author

Jan Schneider jan@horde.org

category

Horde

copyright

2003-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

$canCompress  : bool
Does this driver support compressing data?
$canDecompress  : bool
Does this driver support decompressing data?
$_flagArray  : array<string|int, mixed>
TODO
$_logger  : Horde_Log_Logger
Logger
$_mails  : array<string|int, mixed>
TODO
$_tmp  : array<string|int, mixed>
TODO
__construct()  : mixed
Constructor.
compress()  : mixed
Compresses the data.
compressDirectory()  : mixed
Compresses a directory.
decompress()  : array<string|int, mixed>
Decompresses the data.
_readIndex()  : mixed
TODO
_readMessage()  : string
TODO
_readMessageInfo()  : array<string|int, mixed>
TODO
_readString()  : string
Returns a null-terminated string from the specified data.

Properties

$canCompress

Does this driver support compressing data?

public bool $canCompress = \false

$canDecompress

Does this driver support decompressing data?

public bool $canDecompress = \true

$_flagArray

TODO

protected array<string|int, mixed> $_flagArray = array(0x1 => 'MsgFlags', 0x2 => 'Sent', 0x4 => 'position', 0x7 => 'MessageID', 0x8 => 'Subject', 0x9 => 'From_reply', 0xa => 'References', 0xb => 'Newsgroup', 0xd => 'From', 0xe => 'Reply_To', 0x12 => 'Received', 0x13 => 'Receipt', 0x1a => 'Account', 0x1b => 'AccountID', 0x80 => 'Msg', 0x81 => 'MsgFlags', 0x84 => 'position', 0x91 => 'size')

$_logger

Logger

protected Horde_Log_Logger $_logger

$_mails

TODO

protected array<string|int, mixed> $_mails = array()

$_tmp

TODO

protected array<string|int, mixed> $_tmp = array()

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $options = array() ]) : mixed
Parameters
$options : array<string|int, mixed> = array()

Additional options for the compressor backend.

Return values
mixed

compress()

Compresses the data.

public compress(mixed $data[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$data : mixed

The data to compress.

$params : array<string|int, mixed> = array()

An array of arguments needed to compress the data.

Tags
throws
Horde_Compress_Exception
Return values
mixed

The compressed data.

compressDirectory()

Compresses a directory.

public compressDirectory(string $directory[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$directory : string

The directory to recursively compress.

$params : array<string|int, mixed> = array()

An array of arguments needed to compress the data.

Tags
since

Horde_Compress 2.2.0

throws
Horde_Compress_Exception
Return values
mixed

The compressed data.

decompress()

Decompresses the data.

public decompress(mixed $data[, array<string|int, mixed> $params = array() ]) : array<string|int, mixed>
Parameters
$data : mixed

The data to decompress.

$params : array<string|int, mixed> = array()

An array of arguments needed to decompress the data.

Return values
array<string|int, mixed>

List of messages.

_readIndex()

TODO

protected _readIndex(string $data, int $position) : mixed
Parameters
$data : string

TODO

$position : int

TODO

Tags
throws
Horde_Compress_Exception
Return values
mixed

_readMessage()

TODO

protected _readMessage(string $data, int $position) : string
Parameters
$data : string

TODO

$position : int

TODO

Tags
throws
Horde_Compress_Exception
Return values
string

TODO

_readMessageInfo()

TODO

protected _readMessageInfo(string $data, int $position) : array<string|int, mixed>
Parameters
$data : string

TODO

$position : int

TODO

Tags
throws
Horde_Compress_Exception
Return values
array<string|int, mixed>

TODO

_readString()

Returns a null-terminated string from the specified data.

protected _readString(string $buf, int $pos) : string
Parameters
$buf : string

TODO

$pos : int

TODO

Return values
string

TODO

Search results