AuditService
in package
Audit Service.
Change tracking and audit trail for objects.
Table of Contents
Methods
- getActivitySummary() : array<string|int, mixed>
- Get activity summary.
- getObjectHistory() : array<string|int, mixed>
- Get object history.
- getRecentActivity() : array<string|int, mixed>
- Get recent activity.
- getUserActivity() : array<string|int, mixed>
- Get activity by user.
- log() : int
- Log an action.
- logChanges() : void
- Log multiple field changes.
- search() : array<string|int, mixed>
- Search audit logs.
Methods
getActivitySummary()
Get activity summary.
public
getActivitySummary([int $days = 30 ]) : array<string|int, mixed>
Parameters
- $days : int = 30
Return values
array<string|int, mixed>getObjectHistory()
Get object history.
public
getObjectHistory(int $objectId[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $objectId : int
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>getRecentActivity()
Get recent activity.
public
getRecentActivity([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>getUserActivity()
Get activity by user.
public
getUserActivity(int $userId[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $userId : int
- $params : array<string|int, mixed> = []
Return values
array<string|int, mixed>log()
Log an action.
public
log(array<string|int, mixed> $data) : int
Parameters
- $data : array<string|int, mixed>
Return values
intlogChanges()
Log multiple field changes.
public
logChanges(int $objectId, array<string|int, mixed> $changes[, int|null $userId = null ][, string|null $action = 'update' ][, string|null $ipAddress = null ]) : void
Parameters
- $objectId : int
- $changes : array<string|int, mixed>
- $userId : int|null = null
- $action : string|null = 'update'
- $ipAddress : string|null = null
search()
Search audit logs.
public
search(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>