Activity Log

The User plugin includes an activity log that records key events in a user's lifecycle, such as signing in, changing their password, or being banned by an administrator. These events are displayed in a timeline view accessible from the backend.

Logging Custom Events

Other plugins can log custom events to a user's activity timeline using the UserLog model.

use RainLab\User\Models\UserLog;

UserLog::createRecord($userId, 'acme-order-placed', [
    'order_id' => $order->id,
    'order_total' => $order->total,
]);

Use the createRecord method for user-initiated events and the createSystemRecord method for events initiated by an administrator.

UserLog::createSystemRecord($userId, 'acme-order-refunded', [
    'order_id' => $order->id,
]);

Both methods accept the following arguments.

The IP address is captured automatically with each log entry.

Registering a Detail Partial

Each log type renders its detail text using a partial file. Listen to the rainlab.user.extendLogDetailViewPath event to return a path to your custom partial.

Event::listen('rainlab.user.extendLogDetailViewPath', function($record, $type) {
    if ($type === 'acme-order-placed') {
        return plugins_path('acme/shop/models/userlog/_detail_order_placed.php');
    }
});

Inside the partial, the $record variable is the UserLog model instance. You can access any data stored in the $data array as attributes on the record, along with the following built-in attributes.

Here is an example partial.

<?= __(":name placed order #:order_id", [
    'name' => $record->actor_user_name_linked,
    'order_id' => $record->order_id,
]) ?>

If no partial is found for a log type, the timeline will display the type string followed by "event" as a fallback.

Registering Filter Options

Log types registered by your plugin can appear in the activity type filter on the Timelines page. Listen to the rainlab.user.extendLogTypeOptions event and return an array of type identifiers and their labels.

Event::listen('rainlab.user.extendLogTypeOptions', function() {
    return [
        'acme-order-placed' => __("Order Placed"),
        'acme-order-refunded' => __("Order Refunded"),
    ];
});

Available Log Types

The following log types are included with the plugin.