IMP_Maillog_Storage_Base
in package
AbstractYes
Abstract storage driver for the IMP_Maillog class.
Tags
Table of Contents
Methods
- 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.
Methods
deleteLogs()
Delete log entries.
public
abstract deleteLogs(IMP_Maillog_Messages|array<string|int, mixed> $msgs) : mixed
Parameters
- $msgs : IMP_Maillog_Messages|array<string|int, mixed>
-
Message objects (IMP_Maillog_Message objects).
getChanges()
Retrieve changes to the maillog since the provided timestamp.
public
abstract getChanges(int $ts) : array<string|int, mixed>
Parameters
- $ts : int
-
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
abstract 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.
isAvailable()
Is this storage driver available for the given message/log type?
public
abstract isAvailable(IMP_Maillog_Message $msg, IMP_Maillog_Log_Base $log) : bool
Parameters
- $msg : IMP_Maillog_Message
-
A message object.
- $log : IMP_Maillog_Log_Base
-
Log entry.
Return values
bool —True if the storage driver can handle data for the given input.
saveLog()
Store a log entry.
public
abstract saveLog(IMP_Maillog_Message $msg, IMP_Maillog_Log_Base $log) : bool
Parameters
- $msg : IMP_Maillog_Message
-
Message object.
- $log : IMP_Maillog_Log_Base
-
Log entry.
Return values
bool —True if log entry was saved.