Documentation

IMP_Maillog_Storage_Composite extends IMP_Maillog_Storage_Base
in package

Composite storage driver for the IMP_Maillog class.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2014-2017 Horde LLC

license

http://www.horde.org/licenses/gpl GPL

Table of Contents

Properties

$_drivers  : array<string|int, mixed>
List of drivers.

Methods

__construct()  : mixed
Constructor.
deleteLogs()  : mixed
Delete log entries.
getChanges()  : array<string|int, mixed>
Retrieve changes to the maillog since the provided timestamp.
getLog()  : array<string|int, mixed>
Retrieve history for a message.
isAvailable()  : bool
Is this storage driver available for the given message/log type?
saveLog()  : bool
Store a log entry.

Properties

$_drivers

List of drivers.

protected array<string|int, mixed> $_drivers

Methods

__construct()

Constructor.

public __construct(array<string|int, mixed> $drivers) : mixed
Parameters
$drivers : array<string|int, mixed>

List of drivers.

deleteLogs()

Delete log entries.

public deleteLogs(mixed $msgs) : mixed
Parameters
$msgs : mixed

Message objects (IMP_Maillog_Message objects).

getChanges()

Retrieve changes to the maillog since the provided timestamp.

public getChanges(mixed $ts) : array<string|int, mixed>
Parameters
$ts : mixed

Timestamp.

Return values
array<string|int, mixed>

An array of messages (IMP_Maillog_Message objects) changed since the provided timestamp.

getLog()

Retrieve history for a message.

public getLog(IMP_Maillog_Message $msg[, array<string|int, mixed> $types = array() ]) : array<string|int, mixed>
Parameters
$msg : IMP_Maillog_Message

A message object.

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

Return only these log types (IMP_Maillog_Log_Base class names). If empty, returns all types.

Return values
array<string|int, mixed>

Array of IMP_Maillog_Log_Base objects.


        
On this page

Search results