Audit Log

Download a plugin showcasing the topic.

Description

The B2B Suite provides a general audit log that can be implemented in every component. The audit log component can save different log types and author information like first name, last name, and email. It provides a one-to-many association index. The database structure is described in the graphic below:

As you can see, the database structure is very flat. In the b2b_audit_log table, we save a log type and a serialized AuditLogValueEntity. All required author information is saved in the b2b_audit_log_author table.

The b2b_audit_log_index saves all association data between an audit log and affected entities. For example, if you change an order position, it would be nice to show this information in the main order view.

A simple example

In this example, we will increase the quantity of an order position. To create an audit log, you can use the following snippet:

$auditLogValue = new AuditLogValueDiffEntity();
$auditLogValue->newValue = 'newValue';
$auditLogValue->oldValue = 'oldValue';

$auditLog = new AuditLogEntity();
$auditLog->logValue = $auditLogValue->toDatabaseString();
$auditLog->logType = 'changeOrderPosition';

$orderReferenceIndex = new AuditLogIndexEntity();
$orderReferenceIndex->referenceId = 10;
$orderReferenceIndex->referenceTable = OrderContextRepository::TABLE_NAME;

$this->auditLogService->createAuditLog($auditLog, $identity, [$orderReferenceIndex]);

With the following snippet, you can get all available audit logs:

$auditLogSearchStruct = new AuditLogSearchStruct();
$auditLogs = $this->auditLogService->fetchList(OrderContextRepository::TABLE_NAME, 10, $auditLogSearchStruct);