Audit Trail Docs

RecipientAudit extends BaseAudit

Payment recipients audit trail implementations

Table of Contents

Methods

recipientCreatedLog()  : void
Log payment recipient creation
recipientDeletedLog()  : void
Log payment recipient deletion
recipientRestoredLog()  : void
log payment recipient restoration
recipientUpdatedLog()  : void
Log payment recipient update
addAuditLog()  : void
Log an audit trail entry
getCompanyId()  : int
Extract company ID from various model types.
getUserId()  : int
Get the current authenticated user ID, or fallback to job context user ID.

Methods

recipientCreatedLog()

Log payment recipient creation

public static recipientCreatedLog(UsersPaymentCache|UsersPaymentCache|SimpleUsersPaymentCache $recipient[, int $userId = 0 ]) : void
Parameters
$recipient : UsersPaymentCache|UsersPaymentCache|SimpleUsersPaymentCache

The newly created recipient

$userId : int = 0

The ID of the user who performed the action (optional)

Tags
audit-event

Payment Recipient Created

audit-module

Payments

audit-action

CREATE

audit-trigger

When a new payment recipient is created in the system

recipientDeletedLog()

Log payment recipient deletion

public static recipientDeletedLog(UsersPaymentCache|UsersPaymentCache|SimpleUsersPaymentCache $recipient[, int $userId = 0 ]) : void
Parameters
$recipient : UsersPaymentCache|UsersPaymentCache|SimpleUsersPaymentCache

The recipient being deleted

$userId : int = 0

The ID of the user who performed the action (optional)

Tags
audit-event

Payment Recipient Deleted

audit-module

Payments

audit-action

DELETE

audit-trigger

When a payment recipient is deleted from the system

recipientRestoredLog()

log payment recipient restoration

public static recipientRestoredLog(UsersPaymentCache|UsersPaymentCache|SimpleUsersPaymentCache $recipient[, int $userId = 0 ]) : void
Parameters
$recipient : UsersPaymentCache|UsersPaymentCache|SimpleUsersPaymentCache

The recipient being restored

$userId : int = 0
Tags
audit-event

Payment Recipient Restored

audit-module

Payments

audit-action

RESTORE

audit-trigger

When a previously deleted payment recipient is restored in the system

recipientUpdatedLog()

Log payment recipient update

public static recipientUpdatedLog(UsersPaymentCache|UsersPaymentCache|SimpleUsersPaymentCache $oldRecipient, UsersPaymentCache|UsersPaymentCache|SimpleUsersPaymentCache $newRecipient[, int $userId = 0 ]) : void
Parameters
$oldRecipient : UsersPaymentCache|UsersPaymentCache|SimpleUsersPaymentCache

The recipient data before the update

$newRecipient : UsersPaymentCache|UsersPaymentCache|SimpleUsersPaymentCache

The recipient data after the update

$userId : int = 0

The ID of the user who performed the action (optional)

Tags
audit-event

Payment Recipient Updated

audit-module

Payments

audit-action

UPDATE

audit-trigger

When an existing payment recipient is updated in the system

addAuditLog()

Log an audit trail entry

protected static addAuditLog(int $companyId, int $userId, string $message, string $module, string $action[, mixed|null $currentRecord = null ][, mixed|null $updatedRecord = null ][, string|null $objectName = null ][, string $queueName = 'audit-trails' ][, bool $afterCommit = false ]) : void
Parameters
$companyId : int

Company identifier

$userId : int

User identifier (default 0 for system actions)

$message : string

Human-readable audit message

$module : string

Module name (PAYROLL, LEAVE, PAYMENTS, etc.) - must be a valid AuditModulesEnum value

$action : string

Action type (CREATE, UPDATE, DELETE, etc.) - must be a valid AuditActionsEnum value

$currentRecord : mixed|null = null

Current data being logged

$updatedRecord : mixed|null = null

The updated data (for updates)

$objectName : string|null = null

Optional name of the object being logged - if not provided, will be inferred from the model

$queueName : string = 'audit-trails'

Optional queue name for async processing. Default 'audit-trails'

$afterCommit : bool = false

Whether to log after DB commit

Tags
throws
ValueError

If invalid enum values are provided

getCompanyId()

Extract company ID from various model types.

protected static getCompanyId(mixed $model) : int

This method attempts to determine the company ID from the provided model instance.

It checks for a direct company_id property or navigates through related employee models.

Parameters
$model : mixed

Model instance

Tags
throws
Exception

When company ID cannot be determined

Return values
int —

Company ID

getUserId()

Get the current authenticated user ID, or fallback to job context user ID.

protected static getUserId() : int

This method first checks for an authenticated user via the auth() helper. If no user is authenticated, it looks for a user_id in the job context (for queued jobs).

To add a user ID to the job context, you can use this in your job setup:

 app()->instance('job_context', ['user_id' => $userId]);

If neither is available, it returns 0 to indicate a system action.

Return values
int —

The determined user ID, or 0 if none found


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results