NZTA\SDLT\Service\AuditService
This service is injected into any required data-models such as {@link Questionnaire} {@link Task} and {@link TaskSubmission} objects.
See and .
Usage:
```yml
SilverStripe\Core\Injector\Injector:
auditService: '%$NZTA\SDLT\Audit\AuditService'
```
```php
$this->auditService->commit('Create', 'Model was created', $model, Security::getCurrentUser()->Email);
```
Synopsis
class AuditService
{
- // constants
- const CREATE = 'Create';
- const SUBMIT = 'Submit';
- const CHANGE = 'Change';
- const COMPLETE = 'Complete';
- const APPROVE = 'Approve';
- const DENY = 'Deny';
- // methods
- public void commit()
- public void validateEvent()
- public static string normalise_event()
- public void audit()
Hierarchy
Uses
- SilverStripe\Core\Injector\Injectable
Constants
Name | Value |
---|---|
CREATE | 'Create' |
SUBMIT | 'Submit' |
CHANGE | 'Change' |
COMPLETE | 'Complete' |
APPROVE | 'Approve' |
DENY | 'Deny' |
Methods
public
- audit() — Encapsulates all model-specific auditing processes.
- commit() — Commit a single audit event.
- normalise_event() — Normalise an event, to produce something like: "QUESTIONNAIRE.CREATE" (etc)
- validateEvent() — Is the passed $event legitimate?