PHP Class IMP_Maillog_Storage_Base, horde

Author: Michael Slusarz ([email protected])

Show file Open project: horde/horde Class Usage Examples

Public Methods

Method	Description
deleteLogs ( IMP_Maillog_Messages \| array $msgs )	Delete log entries.
getChanges ( integer $ts ) : array	Retrieve changes to the maillog since the provided timestamp.
getLog ( IMP_Maillog_Message $msg, array $types = [] ) : array	Retrieve history for a message.
isAvailable ( IMP_Maillog_Message $msg, IMP_Maillog_Log_Base $log ) : boolean	Is this storage driver available for the given message/log type?
saveLog ( IMP_Maillog_Message $msg, IMP_Maillog_Log_Base $log ) : boolean	Store a log entry.

Method Details

deleteLogs() abstract public method

Delete log entries.

abstract public deleteLogs ( IMP_Maillog_Messages \| array $msgs )
$msgs	IMP_Maillog_Messages \| array	Message objects (IMP_Maillog_Message objects).

getChanges() abstract public method

Retrieve changes to the maillog since the provided timestamp.

abstract public getChanges ( integer $ts ) : array
$ts	integer	Timestamp.
return	array	An array of messages (IMP_Maillog_Message objects) changed since the provided timestamp.

getLog() abstract public method

Retrieve history for a message.

abstract public getLog ( IMP_Maillog_Message $msg, array $types = [] ) : array
$msg	IMP_Maillog_Message	A message object.
$types	array	Return only these log types (IMP_Maillog_Log_Base class names). If empty, returns all types.
return	array	Array of IMP_Maillog_Log_Base objects.

isAvailable() abstract public method

Is this storage driver available for the given message/log type?

abstract public isAvailable ( IMP_Maillog_Message $msg, IMP_Maillog_Log_Base $log ) : boolean
$msg	IMP_Maillog_Message	A message object.
$log	IMP_Maillog_Log_Base	Log entry.
return	boolean	True if the storage driver can handle data for the given input.

saveLog() abstract public method

Store a log entry.

abstract public saveLog ( IMP_Maillog_Message $msg, IMP_Maillog_Log_Base $log ) : boolean
$msg	IMP_Maillog_Message	Message object.
$log	IMP_Maillog_Log_Base	Log entry.
return	boolean	True if log entry was saved.