1. interface
  2. XELOS
  3. \
  4. Framework
  5. \
  6. Module
  7. \
  8. Model
  9. \
  10. Interfaces
  11. \
  12. AuditableInterface

AuditableInterface

interface AuditableInterface

Constants

OBSERVE_EVENT_SAVE

Events observed on Model
OBSERVE_EVENT_DELETE

AUDIT_EVENT_CREATED

AUDIT_EVENT_UPDATED

AUDIT_EVENT_DELETED

AUDIT_EVENT_RESTORED

AUDIT_EVENT_MISC

Methods

AuditTrail|null
addAuditTrail(string $event = AuditableInterface::AUDIT_EVENT_MISC, string|null $customMessage = null)

Add Audit Trail

array
getAuditExcludeProperties()

Get the (Auditable) attributes excluded from audit.

array
getAuditIncludeProperties()

Get the (Auditable) attributes included in audit.

AuditTrail[]|ModelCollection
getAuditTrail(int $limit = 50)

Get Audit Trail

initAuditableTrait()

No description

Details

at line 37
AuditTrail|null addAuditTrail(string $event = AuditableInterface::AUDIT_EVENT_MISC, string|null $customMessage = null)

Add Audit Trail

Parameters

string $event

AuditableInterface::AUDITEVENT*
string|null $customMessage

Return Value

AuditTrail|null

at line 60
array getAuditExcludeProperties()

Get the (Auditable) attributes excluded from audit.

Return Value

array

at line 53
array getAuditIncludeProperties()

Get the (Auditable) attributes included in audit.

Return Value

array

at line 46
AuditTrail[]|ModelCollection getAuditTrail(int $limit = 50)

Get Audit Trail

Parameters

int $limit

Return Value

AuditTrail[]|ModelCollection

at line 27
initAuditableTrait()

No description