Laravel Activitylog

https://github.com/spatie/laravel-activitylog
Admin
A package for Laravel that provides easy-to-use functions to log user activities and automatically...
Tokens:39,192
Snippets:358
Trust Score:10
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### LogOptions::defaults()

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Static method to start configuring model with the default options.

```APIDOC
## LogOptions::defaults()

### Description
Static method to start configuring model with the default options.

### Method
PHP static method

### Signature
public static function defaults(): LogOptions

### Parameters
None

### Returns
LogOptions - A new LogOptions instance with default settings.

### Default Options
- logName: null
- logEmptyChanges: true
- logFillable: false
- logOnlyDirty: false
- logUnguarded: false
- logAttributes: []
- logExceptAttributes: []
- dontLogIfAttributesChangedOnly: []
- attributeRawValues: []
- descriptionForEvent: null

### Example
```php
$options = LogOptions::defaults();
```
```

--------------------------------

### Install v5 via Composer

Source: https://github.com/spatie/laravel-activitylog/blob/main/UPGRADING.md

Use this command to update the package dependency to version 5.

```bash
composer require spatie/laravel-activitylog "^5.0.0"
```

--------------------------------

### Install package via Composer

Source: https://github.com/spatie/laravel-activitylog/blob/main/README.md

Use this command to install the package into your Laravel project.

```bash
composer require spatie/laravel-activitylog
```

--------------------------------

### Logging model creation

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Example showing that creating a model instance automatically logs an activity with the 'created' description and attribute changes.

```php
$newsItem = NewsItem::create([
   'name' => 'original name',
   'text' => 'Lorem'
]);

//creating the newsItem will cause an activity to be logged
$activity = Activity::all()->last();

$activity->description; //returns 'created'
$activity->subject; //returns the instance of NewsItem that was created
$activity->attribute_changes; //returns a collection containing ['attributes' => ['name' => 'original name', 'text' => 'Lorem']];
```

--------------------------------

### Log activity with model and properties

Source: https://github.com/spatie/laravel-activitylog/blob/main/README.md

Log an activity associated with a specific Eloquent model and user, including custom properties. The example demonstrates how to retrieve the last activity and access its subject, causer, properties, and description.

```php
activity()
   ->performedOn($anEloquentModel)
   ->causedBy($user)
   ->withProperties(['customProperty' => 'customValue'])
   ->log('Look, I logged something');

$lastLoggedActivity = Activity::all()->last();

$lastLoggedActivity->subject; //returns an instance of an eloquent model
$lastLoggedActivity->causer; //returns an instance of your user model
$lastLoggedActivity->getProperty('customProperty'); //returns 'customValue'
$lastLoggedActivity->description; //returns 'Look, I logged something'
```

--------------------------------

### Logging model deletion

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Example showing that deleting a model instance logs an activity with the 'deleted' description.

```php
$newsItem->delete();

//deleting the newsItem will cause an activity to be logged
$activity = Activity::all()->last();

$activity->description; //returns 'deleted'
$activity->attribute_changes; //returns a collection containing ['old' => ['name' => 'updated name', 'text' => 'Lorem']];
```

--------------------------------

### Log model events

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/introduction.md

Example of how updating an Eloquent model automatically triggers an activity log entry.

```php
$newsItem->name = 'updated name';
$newsItem->save();

//updating the newsItem will cause an activity to be logged
$activity = Activity::all()->last();

$activity->description; //returns 'updated'
$activity->subject; //returns the instance of NewsItem that was updated
```

--------------------------------

### Run migrations

Source: https://github.com/spatie/laravel-activitylog/blob/main/README.md

Creates the activity_log table in your database.

```bash
php artisan migrate
```

--------------------------------

### LogOptions defaults Method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Initializes the configuration with default options.

```php
/**
 * Start configuring model with the default options.
 */
public static function defaults(): LogOptions;
```

--------------------------------

### Enable buffering via .env

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/buffering.md

Add this configuration to your .env file to enable activity buffering.

```text
ACTIVITYLOG_BUFFER_ENABLED=true
```

--------------------------------

### Publish configuration file

Source: https://github.com/spatie/laravel-activitylog/blob/main/README.md

Optionally publish the package configuration file to customize settings.

```bash
php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="activitylog-config"
```

--------------------------------

### Publish and run migrations

Source: https://github.com/spatie/laravel-activitylog/blob/main/UPGRADING.md

Publish the new migration files and execute them to update the database schema.

```bash
php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="activitylog-migrations"
php artisan migrate
```

--------------------------------

### Enable buffering via config/activitylog.php

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/buffering.md

Alternatively, enable buffering by updating the configuration file directly.

```php
'buffer' => [
    'enabled' => true,
],
```

--------------------------------

### Run tests with composer

Source: https://github.com/spatie/laravel-activitylog/blob/main/README.md

Execute the project's test suite using the composer test command.

```bash
composer test
```

--------------------------------

### Log activity with placeholders

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/using-placeholders.md

Demonstrates using :subject, :causer, and :properties placeholders within a log message. The description is automatically populated with the corresponding values from the provided models and properties.

```php
activity()
    ->performedOn($article)
    ->causedBy($user)
    ->withProperties(['laravel' => 'awesome'])
    ->log('The subject name is :subject.name, the causer name is :causer.name and Laravel is :properties.laravel');

$lastActivity = Activity::all()->last();
$lastActivity->description; //returns 'The subject name is article name, the causer name is user name and Laravel is awesome';
```

--------------------------------

### Using the Activity facade for causer management

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/causer-resolver.md

Recommended approach for setting the causer either globally or within a specific scope using the Activity facade.

```php
use Spatie\Activitylog\Facades\Activity;

// Scoped causer (recommended)
Activity::defaultCauser($admin, function () {
    // all activities here will have $admin as causer
});

// Global causer
Activity::defaultCauser($admin);
```

--------------------------------

### Registering multiple beforeLogging callbacks

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/before-logging-hook.md

Multiple callbacks can be registered and will execute in the order they were defined.

```php
Activity::beforeLogging(function ($activity) {
    $activity->properties = $activity->properties->put('ip', request()->ip());
});

Activity::beforeLogging(function ($activity) {
    $activity->properties = $activity->properties->put('user_agent', request()->userAgent());
});
```

--------------------------------

### Log a simple activity

Source: https://github.com/spatie/laravel-activitylog/blob/main/README.md

Use the activity() helper function to log a basic string message.

```php
activity()->log('Look, I logged something');
```

--------------------------------

### Group activities using custom properties

Source: https://github.com/spatie/laravel-activitylog/blob/main/UPGRADING.md

Since the batch system was removed in v5, use a custom property to group activities.

```php
$groupId = Str::uuid();
activity()->withProperty('group', $groupId)->log('first');
Activity::where('properties->group', $groupId)->get();
```

--------------------------------

### Retrieve all logged activities

Source: https://github.com/spatie/laravel-activitylog/blob/main/README.md

Use the Spatie\Activitylog\Models\Activity model to fetch all records from the activity log.

```php
Activity::all();
```

--------------------------------

### Setting custom properties

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/logging-activity.md

Add arbitrary metadata to an activity using withProperties() and retrieve it later.

```php
activity()
   ->causedBy($userModel)
   ->performedOn($someContentModel)
   ->withProperties(['key' => 'value'])
   ->log('edited');

$lastActivity = Activity::all()->last(); //returns the last logged activity

$lastActivity->getProperty('key'); //returns 'value'

Activity::where('properties->key', 'value')->get(); // get all activity where the `key` custom property is 'value'
```

--------------------------------

### Custom Activity model for custom table/connection

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/installation-and-setup.md

Create a custom Activity model extending the default one to use a custom table name or database connection. Set the table and connection properties as needed.

```php
use Spatie\Activitylog\Models\Activity as BaseActivity;

class Activity extends BaseActivity
{
    protected $table = 'my_custom_activity_log';

    protected $connection = 'my_custom_connection';
}
```

--------------------------------

### getActivitylogOptions()

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Optional method to implement on a model to customize logging behavior. If not implemented, defaults are used.

```APIDOC
## getActivitylogOptions()

### Description
Optional method to implement on a model to customize logging behavior. If not implemented, defaults are used.

### Method
PHP method

### Signature
public function getActivitylogOptions(): LogOptions

### Parameters
None

### Returns
LogOptions - The configured log options.

### Example
```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\LogsActivity;
use Spatie\Activitylog\Support\LogOptions;

class YourModel extends Model
{
    use LogsActivity;

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
            ->logFillable()
            ->logOnlyDirty();
    }
}
```
```

--------------------------------

### Basic Activity Logging Model

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

The simplest implementation of the LogsActivity trait on a model, which uses default logging settings.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\LogsActivity;

class YourModel extends Model
{
    use LogsActivity;
}
```

--------------------------------

### Registering a beforeLogging callback in AppServiceProvider

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/before-logging-hook.md

Call beforeLogging on the Activity facade within the boot method of a service provider to enrich activities with data like the requester's IP address.

```php
use Spatie\
\
Activitylog\\Facades\\Activity;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        Activity::beforeLogging(function (\\Spatie\\Activitylog\\Contracts\\Activity $activity) {
            $activity->properties = $activity->properties->put('ip', request()->ip());
        });
    }
}
```

--------------------------------

### Enable logging

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/disabling-logging.md

Use this method to re-enable logging after it has been disabled.

```php
activity()->enableLogging();
```

--------------------------------

### Configure tracked model attributes with getActivitylogOptions()

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Override getActivitylogOptions() on the model returning a LogOptions instance to log changes to specific attributes or wildcard selections.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\LogsActivity;
use Spatie\Activitylog\Support\LogOptions;

class NewsItem extends Model
{
    use LogsActivity;

    protected $fillable = ['name', 'text'];

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
        ->logOnly(['name', 'text']);
    }
}
```

--------------------------------

### Query and log using ActivityEvent

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Utilize the ActivityEvent enum when querying existing activities or manually logging new ones.

```php
Activity::forEvent(ActivityEvent::Created)->get();

activity()->event(ActivityEvent::Updated)->log('...');
```

--------------------------------

### Log model events

Source: https://github.com/spatie/laravel-activitylog/blob/main/README.md

Demonstrates automatic logging when an Eloquent model is saved. The activity captures the description and the subject model instance.

```php
$newsItem->name = 'updated name';
$newsItem->save();

//updating the newsItem will cause the logging of an activity
$activity = Activity::all()->last();

$activity->description; //returns 'updated'
$activity->subject; //returns the instance of NewsItem that was saved
```

--------------------------------

### LogOptions useLogName Method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Sets a custom name for the activity log.

```php
/**
 * Customize log name.
 */
public function useLogName(string $logName): LogOptions;
```

--------------------------------

### Registering a batch UUID hook

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/before-logging-hook.md

Use the beforeLogging hook to assign a shared UUID to all activities logged during a single request.

```php
use Illuminate\\Support\\Str;
use Spatie\\Activitylog\\Facades\\Activity;

// In your AppServiceProvider::boot()
$batchUuid = (string) Str::uuid();

Activity::beforeLogging(function ($activity) use ($batchUuid) {
    $activity->batch_uuid = $batchUuid;
});
```

--------------------------------

### Published config file contents

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/installation-and-setup.md

The default configuration file for the package. It includes options for enabling logging, cleaning old activities, default log name, auth driver, soft-deleted subjects, activity model, excluded attributes, and customizable action classes.

```php
return [

    /*
     * If set to false, no activities will be saved to the database.
     */
    'enabled' => env('ACTIVITYLOG_ENABLED', true),

    /*
     * When the clean command is executed, all recording activities older than
     * the number of days specified here will be deleted.
     */
    'clean_after_days' => 365,

    /*
     * If no log name is passed to the activity() helper
     * we use this default log name.
     */
    'default_log_name' => 'default',

    /*
     * You can specify an auth driver here that gets user models.
     * If this is null we'll use the current Laravel auth driver.
     */
    'default_auth_driver' => null,

    /*
     * If set to true, the subject relationship on activities
     * will include soft deleted models.
     */
    'include_soft_deleted_subjects' => false,

    /*
     * This model will be used to log activity.
     * It should implement the Spatie\Activitylog\Contracts\Activity interface
     * and extend Illuminate\Database\Eloquent\Model.
     */
    'activity_model' => \Spatie\Activitylog\Models\Activity::class,

    /*
     * These attributes will be excluded from logging for all models.
     * Model-specific exclusions via logExcept() are merged with these.
     */
    'default_except_attributes' => [],

    /*
     * These action classes can be overridden to customize how activities
     * are logged and cleaned. Your custom classes must extend the originals.
     */
    'actions' => [
        'log_activity' => \Spatie\Activitylog\Actions\LogActivityAction::class,
        'clean_log' => \Spatie\Activitylog\Actions\CleanActivityLogAction::class,
    ],
];
```

--------------------------------

### logAll()

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Log all attributes on the model. Equivalent to logOnly(['*']).

```APIDOC
## logAll()

### Description
Log all attributes on the model. Equivalent to logOnly(['*']).

### Method
PHP method

### Signature
public function logAll(): LogOptions

### Parameters
None

### Returns
LogOptions - The current LogOptions instance for chaining.

### Example
```php
LogOptions::defaults()->logAll();
```
```

--------------------------------

### Run activitylog:clean command

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/cleaning-up-the-log.md

Executes the artisan command to delete activity logs older than the configured clean_after_days.

```bash
php artisan activitylog:clean
```

--------------------------------

### Log advanced activity with properties

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/introduction.md

Log an activity associated with a model and user, including custom properties and retrieval of specific activity attributes.

```php
activity()
   ->performedOn($anEloquentModel)
   ->causedBy($user)
   ->withProperties(['customProperty' => 'customValue'])
   ->log('Look mum, I logged something');

$lastLoggedActivity = Activity::all()->last();

$lastLoggedActivity->subject; //returns an instance of an eloquent model
$lastLoggedActivity->causer; //returns an instance of your user model
$lastLoggedActivity->getProperty('customProperty'); //returns 'customValue'
$lastLoggedActivity->description; //returns 'Look mum, I logged something'
```

--------------------------------

### LogOptions logAll Method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Logs all attributes on the model, equivalent to logOnly(['*']).

```php
/**
 * Log all attributes on the model.
 */
public function logAll(): LogOptions;
```

--------------------------------

### LogOptions setDescriptionForEvent Method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Allows customization of the log description using a callback function.

```php
/**
 * Customize log description using callback.
 */
public function setDescriptionForEvent(Closure $callback): LogOptions;
```

--------------------------------

### useLogName(string $logName)

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Customize log name.

```APIDOC
## useLogName(string $logName)

### Description
Customize log name.

### Method
PHP method

### Signature
public function useLogName(string $logName): LogOptions

### Parameters
- **logName** (string) - Required - The custom log name to use.

### Returns
LogOptions - The current LogOptions instance for chaining.

### Example
```php
LogOptions::defaults()->useLogName('user_activity');
```
```

--------------------------------

### Adding a batch UUID column to activity_log

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/before-logging-hook.md

To group activities, first add a nullable, indexed UUID column to the activity_log table using a migration.

```php
Schema::table('activity_log', function (Blueprint $table) {
    $table->uuid('batch_uuid')->nullable()->index();
});
```

--------------------------------

### Log to the default log

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/using-multiple-logs.md

Activities are logged to the default log when no name is specified. The default log name can be configured in the config file.

```php
activity()->log('hi');

$lastActivity = Activity::all()->last();

$lastActivity->log_name; //returns 'default';
```

--------------------------------

### Retrieve activity by log name

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/using-multiple-logs.md

Use standard Eloquent queries to filter activity by the log_name column.

```php
Activity::where('log_name', 'other-log')->get(); //returns all activity from the 'other-log'
```

--------------------------------

### Publish migration file

Source: https://github.com/spatie/laravel-activitylog/blob/main/README.md

Publishes the migration file to your application. If using UUIDs or non-integer IDs, adjust the subject_id and causer_id fields in the published migration before running the migration.

```bash
php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="activitylog-migrations"
```

--------------------------------

### Register custom action in config/activitylog.php

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/customizing-actions.md

Shows the configuration array in config/activitylog.php where the custom LogActivityAction is registered under the 'log_activity' key, while the default CleanActivityLogAction remains for 'clean_log'.

```php
// config/activitylog.php
'actions' => [
    'log_activity' => \App\Actions\CustomLogActivityAction::class,
    'clean_log' => \Spatie\Activitylog\Actions\CleanActivityLogAction::class,
],
```

--------------------------------

### LogOptions logEmptyChanges Method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Enables the storage of empty logs.

```php
/**
 * Allow storing empty logs.
 */
public function logEmptyChanges(): LogOptions;
```

--------------------------------

### Tapping activity before logging

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/logging-activity.md

Use the tap() method to modify the activity instance before it is saved to the database.

```php
use Spatie\
Activitylog\
Contracts\
Activity as ActivityContract;

activity()
   ->causedBy($userModel)
   ->performedOn($someContentModel)
   ->tap(function(ActivityContract $activity) {
      $activity->my_custom_field = 'my special value';
   })
   ->log('edited');

$lastActivity = Activity::all()->last();

$lastActivity->my_custom_field; // returns 'my special value'
```

--------------------------------

### Enable basic model event logging with LogsActivity

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use the LogsActivity trait on an Eloquent model to automatically log created, updated, and deleted events without tracking attribute changes.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\LogsActivity;

class NewsItem extends Model
{
    use LogsActivity;
}
```

--------------------------------

### Using ActivityEvent enum

Source: https://github.com/spatie/laravel-activitylog/blob/main/UPGRADING.md

Methods that accept event names now support the ActivityEvent enum, while plain strings remain supported for custom event names.

```php
use Spatie\Activitylog\Enums\ActivityEvent;

Activity::forEvent(ActivityEvent::Created)->get();
activity()->event(ActivityEvent::Updated)->log('...');
```

--------------------------------

### logEmptyChanges()

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Allow storing empty logs.

```APIDOC
## logEmptyChanges()

### Description
Allow storing empty logs.

### Method
PHP method

### Signature
public function logEmptyChanges(): LogOptions

### Parameters
None

### Returns
LogOptions - The current LogOptions instance for chaining.

### Example
```php
LogOptions::defaults()->logEmptyChanges();
```
```

--------------------------------

### Customizing Activity Logging Options

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Overriding getActivitylogOptions to specify custom logging behavior, such as logging only fillable attributes and only when changes occur.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\LogsActivity;
use Spatie\Activitylog\Support\LogOptions;

class YourModel extends Model
{
    use LogsActivity;

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
        ->logFillable()
        ->logOnlyDirty();
    }
}
```

--------------------------------

### Retrieving logged activity

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/logging-activity.md

Retrieve the last logged activity using the Activity model and access its description.

```php
$lastActivity = Activity::all()->last(); //returns the last logged activity

$lastActivity->description; //returns 'Look mum, I logged something';
```

--------------------------------

### Upgrade package to v4

Source: https://github.com/spatie/laravel-activitylog/blob/main/UPGRADING.md

Use Composer to update the package dependency to version 4.0.0.

```bash
composer require spatie/laravel-activitylog "^4.0.0"
```

--------------------------------

### Tap Activity before logged from event

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use the beforeActivityLogged method on your model to fill properties and add custom fields before the activity is saved.

```php
use Illuminate	ypes
use Illuminate	ypes
use Illuminate	ypes;

class NewsItem extends Model
{
    use LogsActivity;

    public function beforeActivityLogged(Activity $activity, string $eventName)
    {
        $activity->description = "activity.logs.message.{$eventName}";
    }
}
```

--------------------------------

### Set custom activity model in config

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/installation-and-setup.md

Update the activity_model config key to point to your custom Activity model class.

```php
'activity_model' => \App\Models\Activity::class,
```

--------------------------------

### Specify a custom log name

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/using-multiple-logs.md

Pass a string to the activity function to log to a specific log name.

```php
activity('other-log')->log("hi");

Activity::all()->last()->log_name; //returns 'other-log';
```

--------------------------------

### Logging on Pivot Models

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

To log changes on pivot models, add a primary key column to the pivot table and configure the pivot model to use it by setting $incrementing to true.

```php
use Illuminate	ypes
use Illuminate	ypes;

final class PivotModel extends Pivot
{
    use LogsActivity;

    public $incrementing = true;
}
```

--------------------------------

### CauserResolver::withCauser

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/causer-resolver.md

Executes a callback with a temporary causer set, then restores the previous causer.

```APIDOC
## CauserResolver::withCauser

### Description
Temporarily sets a causer for the duration of the callback, then restores the previous causer. Useful for scoped causer resolution.

### Method
withCauser

### Parameters
- **$causer** (?Model) - Required - The causer to use during the callback.
- **$callback** (Closure) - Required - The callback to execute with the temporary causer.

### Return Value
- mixed - The return value of the callback.

### Example
```php
$result = app(CauserResolver::class)->withCauser($admin, function () {
    // activities here will have $admin as causer
    return 'done';
});
```
```

--------------------------------

### setDescriptionForEvent(Closure $callback)

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Customize log description using callback.

```APIDOC
## setDescriptionForEvent(Closure $callback)

### Description
Customize log description using callback.

### Method
PHP method

### Signature
public function setDescriptionForEvent(Closure $callback): LogOptions

### Parameters
- **callback** (Closure) - Required - A closure that receives the event name and returns a description string.

### Returns
LogOptions - The current LogOptions instance for chaining.

### Example
```php
LogOptions::defaults()->setDescriptionForEvent(function (string $eventName) {
    return "Model was {$eventName}";
});
```
```

--------------------------------

### Migrate database schema for v5

Source: https://github.com/spatie/laravel-activitylog/blob/main/UPGRADING.md

This migration updates the activity_log table by adding the attribute_changes column, dropping the batch_uuid column, and moving existing data from properties to attribute_changes.

```php
// Example upgrade migration
Schema::table('activity_log', function (Blueprint $table) {
    $table->json('attribute_changes')->nullable()->after('causer_id');
    $table->dropColumn('batch_uuid');
});

// Then migrate existing data: move 'attributes' and 'old' from properties to attribute_changes
DB::table('activity_log')
    ->where(function ($query) {
        $query->whereNotNull('properties->attributes')
            ->orWhereNotNull('properties->old');
    })
    ->eachById(function ($row) {
        $properties = json_decode($row->properties, true);
        $changes = array_intersect_key($properties, array_flip(['attributes', 'old']));
        $remaining = array_diff_key($properties, array_flip(['attributes', 'old']));

        DB::table('activity_log')->where('id', $row->id)->update([
            'attribute_changes' => empty($changes) ? null : json_encode($changes),
            'properties' => empty($remaining) ? null : json_encode($remaining),
        ]);
});
```

--------------------------------

### Re-enabling logging for a model instance

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use the enableLogging() method to resume logging for a model instance after it has been previously disabled.

```php
$newsItem = NewsItem::create([
   'name' => 'original name',
   'text' => 'Lorem'
]);

// Updating with logging disabled
$newsItem->disableLogging();

$newsItem->update(['name' => 'The new name is not logged']);

// Updating with logging enabled
$newsItem->enableLogging();

$newsItem->update(['name' => 'The new name is logged']);
```

--------------------------------

### logOnlyDirty()

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Log changes that have actually changed after the update.

```APIDOC
## logOnlyDirty()

### Description
Log changes that have actually changed after the update.

### Method
PHP method

### Signature
public function logOnlyDirty(): LogOptions

### Parameters
None

### Returns
LogOptions - The current LogOptions instance for chaining.

### Example
```php
LogOptions::defaults()->logOnlyDirty();
```
```

--------------------------------

### CauserResolver withCauser method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/causer-resolver.md

Executes a closure with a specific causer set for the duration of the callback.

```php
public function withCauser(?Model $causer, Closure $callback): mixed;
```

--------------------------------

### Check activity ID with buffering

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/buffering.md

Note that buffered activities do not receive a database ID until the buffer is flushed after the response is sent.

```php
$activity = activity()->log('some activity');

// With buffering enabled, $activity->id will be null here.
// The activity will be saved after the response is sent.
```

--------------------------------

### Update CauserResolver usage to Activity::defaultCauser

Source: https://github.com/spatie/laravel-activitylog/blob/main/UPGRADING.md

The CauserResolver facade has been removed in v5. Use the Activity::defaultCauser method instead.

```php
// v4
CauserResolver::setCauser($admin);
CauserResolver::withCauser($admin, fn() => ...);

// v5
Activity::defaultCauser($admin);
Activity::defaultCauser($admin, fn() => ...);
```

--------------------------------

### Use backed enums in LogOptions

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/using-multiple-logs.md

Backed enums are supported in the useLogName method of LogOptions.

```php
public function getActivitylogOptions(): LogOptions
{
    return LogOptions::defaults()
        ->useLogName(LogName::Orders);
}
```

--------------------------------

### Customizing resolution with CauserResolver

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/causer-resolver.md

Advanced usage for low-level control by resolving the CauserResolver from the container and defining a custom resolution callback. Note that setCauser() takes priority over resolveUsing().

```php
use Spatie\Activitylog\Support\CauserResolver;

// Custom resolution callback
app(CauserResolver::class)->resolveUsing(function ($subject) {
    return User::find(1);
});
```

--------------------------------

### Exclude attributes with logExcept

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use ->logExcept() to prevent specific attributes from appearing in the logged output when using wildcard logging.

```php
use Illuminate	ypes
use Spatie	ypes
use Spatie	ypes

class NewsItem extends Model
{
    use LogsActivity;

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
        ->logAll()
        ->logExcept(['password', 'remember_token']);
    }
}
```

--------------------------------

### LogOptions logOnly Method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Specifies a list of attributes to be logged.

```php
/**
 * Only log changes to these specific attributes.
 */
public function logOnly(array $attributes): LogOptions;
```

--------------------------------

### Default LogOptions Properties

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

The default configuration properties applied when calling LogOptions::defaults().

```php
public ?string $logName = null;

public bool $logEmptyChanges = true;

public bool $logFillable = false;

public bool $logOnlyDirty = false;

public bool $logUnguarded = false;

public array $logAttributes = [];

public array $logExceptAttributes = [];

public array $dontLogIfAttributesChangedOnly = [];

public array $attributeRawValues = [];

public ?Closure $descriptionForEvent = null;
```

--------------------------------

### Customizing the description with setDescriptionForEvent

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use the setDescriptionForEvent method within getActivitylogOptions to provide a callback that modifies the default event description string.

```php
use Illuminate	ypes
use Spatie\Activitylog\Models\Concerns\LogsActivity;
use Spatie\Activitylog\Support\LogOptions;

class NewsItem extends Model
{
    use LogsActivity;

    protected $fillable = ['name', 'text'];

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
        ->setDescriptionForEvent(fn(string $eventName) => "This model has been {$eventName}");
    }
}
```

```php
$newsItem = NewsItem::create([
   'name' => 'original name',
   'text' => 'Lorem'
]);

//creating the newsItem will cause an activity to be logged
$activity = Activity::all()->last();

$activity->description; //returns 'This model has been created'
```

--------------------------------

### dontLogEmptyChanges()

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Don't store empty logs. Empty logs can occur when you're tracking specific attributes but none of them actually changed.

```APIDOC
## dontLogEmptyChanges()

### Description
Don't store empty logs. Empty logs can occur when you're tracking specific attributes but none of them actually changed.

### Method
PHP method

### Signature
public function dontLogEmptyChanges(): LogOptions

### Parameters
None

### Returns
LogOptions - The current LogOptions instance for chaining.

### Example
```php
LogOptions::defaults()->dontLogEmptyChanges();
```
```

--------------------------------

### Activity::defaultCauser

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/causer-resolver.md

Recommended way to set a default causer for activities, either scoped to a callback or globally.

```APIDOC
## Activity::defaultCauser

### Description
Sets the default causer for activities. When used with a callback, the causer is applied only within that callback's scope. Without a callback, it sets the global default causer.

### Method
Activity::defaultCauser

### Parameters
- **$causer** (Model) - Required - The model to set as the default causer.
- **$callback** (Closure) - Optional - If provided, the causer is applied only within this callback.

### Example
```php
use Spatie\Activitylog\Facades\Activity;

// Scoped causer (recommended)
Activity::defaultCauser($admin, function () {
    // all activities here will have $admin as causer
});

// Global causer
Activity::defaultCauser($admin);
```
```

--------------------------------

### Log specific JSON sub-keys with arrow notation

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use arrow notation within logOnly to target specific sub-keys of a JSON column for logging. This requires the column to be cast to a collection or array.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\LogsActivity;
use Spatie\Activitylog\Support\LogOptions;

class NewsItem extends Model
{
    use LogsActivity;

    protected $fillable = ['preferences', 'name'];

    protected $casts = [
        'preferences' => 'collection' // casting the JSON database column
    ];

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
        ->logOnly(['preferences->notifications->status', 'preferences->hero_url']);
    }
}
```

```php
// Create a news item.
$newsItem = NewsItem::create([
    'name' => 'Title',
    'preferences' => [
        'notifications' => [
            'status' => 'off',
        ],
        'hero_url' => ''
    ],
]);

// Update the json object
$newsItem->update([
    'preferences' => [
        'notifications' => [
            'status' => 'on',
        ],
        'hero_url' => 'http://example.com/hero.png'
    ],
]);

$lastActivity = Activity::latest()->first();

$lastActivity->attribute_changes->toArray();
```

```php
// output
[
    "attributes" => [
        "preferences" => [
            "notifications" => [
                "status" => "on",
            ],
            "hero_url" => "http://example.com/hero.png",
        ],
    ],
    "old" => [
        "preferences" => [
            "notifications" => [
                "status" => "off",
            ],
            "hero_url" => "",
        ],
    ],
]
```

--------------------------------

### Querying activity with scopes

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use the Activity model query scopes to filter logs by subject, causer, or event type. These scopes can be chained together for complex filtering.

```php
use Spatie\Activitylog\Models\Activity;

// get all activities for a specific subject
Activity::forSubject($newsItem)->get();

// get all activities caused by a specific user
Activity::causedBy($user)->get();

// get all activities for a specific event
Activity::forEvent('updated')->get();

// these scopes can be combined
Activity::forSubject($newsItem)->causedBy($user)->forEvent('updated')->get();
```

--------------------------------

### Use backed enums for log names

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/using-multiple-logs.md

Backed enums can be used as log names; the enum value is stored in the log_name column.

```php
enum LogName: string
{
    case Orders = 'orders';
    case Auth = 'auth';
}

activity(LogName::Orders)->log('hi');

Activity::all()->last()->log_name; //returns 'orders'
```

--------------------------------

### Setting custom event

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/logging-activity.md

Define a custom event name for the activity using the event() method.

```php
activity()
    ->causedBy($userModel)
    ->performedOn($someContentModel)
    ->event('verified')
    ->log('The user has verified the content model.');
```

--------------------------------

### Optimize MySQL table space

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/cleaning-up-the-log.md

Reclaims space after cleaning the activity_log table. These operations lock the database and should only be run in maintenance mode.

```sql
OPTIMIZE TABLE activity_log;
```

```sql
ANALYZE TABLE activity_log;
```

--------------------------------

### Schedule activitylog:clean in Laravel

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/cleaning-up-the-log.md

Adds the clean command to the Laravel scheduler in routes/console.php. The --force flag is required to bypass confirmation prompts in production environments.

```php
// routes/console.php

use Illuminate	ung\Support\Facades\Schedule;

Schedule::command('activitylog:clean --force')->daily();
```

--------------------------------

### Setting a subject with performedOn

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/logging-activity.md

Specify the model on which the activity is performed using the performedOn() method.

```php
activity()
   ->performedOn($someContentModel)
   ->log('edited');

$lastActivity = Activity::all()->last(); //returns the last logged activity

$lastActivity->subject; //returns the model that was passed to `performedOn`;
```

--------------------------------

### LogOptions logUnguarded Method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Logs changes to all attributes not listed in the model's $guarded property.

```php
/**
 * Log changes to all attributes that are not listed in $guarded.
 */
public function logUnguarded(): LogOptions;
```

--------------------------------

### Customizing logged events with $recordEvents

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use the $recordEvents property to specify exactly which events should be logged for a model.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\LogsActivity;

class NewsItem extends Model
{
    use LogsActivity;

    //only the `deleted` event will get logged automatically
    protected static $recordEvents = ['deleted'];
}
```

--------------------------------

### Customizing the log name with useLogName

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Pass a string to the useLogName method to override the default log name for the model.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\LogsActivity;
use Spatie\Activitylog\Support\LogOptions;

class NewsItem extends Model
{
    use LogsActivity;

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
        ->useLogName('system');
    }
}
```

--------------------------------

### LogOptions logExcept Method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Excludes specific attributes from being logged.

```php
/**
 * Exclude these attributes from being logged.
 */
public function logExcept(array $attributes): LogOptions;
```

--------------------------------

### Setting custom created date

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/logging-activity.md

Override the default created_at timestamp using the createdAt() method.

```php
activity()
    ->causedBy($userModel)
    ->performedOn($someContentModel)
    ->createdAt(now()->subDays(10))
    ->log('created');
```

--------------------------------

### Run code without logging

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/disabling-logging.md

Use the withoutLogging method to execute a specific block of code without triggering any activity logs, such as model events or explicit calls.

```php
activity()->withoutLogging(function () {
    // ...
});
```

--------------------------------

### logUnguarded()

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Log changes to all attributes that are not listed in $guarded. Can be combined with logFillable() or logOnly().

```APIDOC
## logUnguarded()

### Description
Log changes to all attributes that are not listed in $guarded. Can be combined with logFillable() or logOnly(). The final set of logged attributes is the union of all sources.

### Method
PHP method

### Signature
public function logUnguarded(): LogOptions

### Parameters
None

### Returns
LogOptions - The current LogOptions instance for chaining.

### Example
```php
LogOptions::defaults()->logUnguarded();
```
```

--------------------------------

### Log related model attributes with dot notation

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use dot notation in the logOnly array to log attributes from directly related models.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\LogsActivity;
use Spatie\Activitylog\Support\LogOptions;

class NewsItem extends Model
{
    use LogsActivity;

    protected $fillable = ['name', 'text', 'user_id'];

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
        ->logOnly(['name', 'text', 'user.name']);
    }

    public function user()
    {
        return $this->belongsTo(User::class);
    }
}
```

--------------------------------

### Use the inLog scope

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/using-multiple-logs.md

The inLog scope simplifies filtering by one or multiple log names, including support for arrays and backed enums.

```php
Activity::inLog('other-log')->get();

//you can pass multiple log names to the scope
Activity::inLog('default', 'other-log')->get();

//passing an array is just as good
Activity::inLog(['default', 'other-log'])->get();

//backed enums work here too
Activity::inLog(LogName::Orders)->get();
Activity::inLog(LogName::Orders, LogName::Auth)->get();
```

--------------------------------

### LogOptions logFillable Method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Logs changes to all attributes defined in the model's $fillable property.

```php
/**
 * Log changes to all the $fillable attributes of the model.
 */
public function logFillable(): LogOptions;
```

--------------------------------

### logFillable()

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Log changes to all the $fillable attributes of the model. Can be combined with logUnguarded() or logOnly().

```APIDOC
## logFillable()

### Description
Log changes to all the $fillable attributes of the model. Can be combined with logUnguarded() or logOnly(). The final set of logged attributes is the union of all sources.

### Method
PHP method

### Signature
public function logFillable(): LogOptions

### Parameters
None

### Returns
LogOptions - The current LogOptions instance for chaining.

### Example
```php
LogOptions::defaults()->logFillable();
```
```

--------------------------------

### Prevent empty logs with dontLogEmptyChanges

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use ->dontLogEmptyChanges() to prevent the package from storing logs when no tracked attributes have changed.

```php
use Illuminate	ypes
use Spatie	ypes
use Spatie	ypes

class NewsItem extends Model
{
    use LogsActivity;

    protected $fillable = ['name', 'text'];

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
        ->logOnly(['text'])
        ->logOnlyDirty()
        ->dontLogEmptyChanges();
    }
}
```

--------------------------------

### Customize log name per model

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/using-multiple-logs.md

Use the useLogName method within the getActivitylogOptions method to set a custom log name for a specific model.

```php
public function getActivitylogOptions(): LogOptions
{
    return LogOptions::defaults()
        ->useLogName('custom_log_name_for_this_model');
}
```

--------------------------------

### CauserResolver::resolveUsing

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/causer-resolver.md

Sets a custom callback to resolve the causer when none is set explicitly.

```APIDOC
## CauserResolver::resolveUsing

### Description
Sets a custom resolution callback that will be used to determine the causer when no causer is explicitly set. Note that setCauser() takes priority over this callback.

### Method
resolveUsing

### Parameters
- **$callback** (Closure) - Required - The callback that receives the subject and returns the causer model.

### Return Value
- static - Returns the instance for chaining.

### Example
```php
use Spatie\Activitylog\Support\CauserResolver;

app(CauserResolver::class)->resolveUsing(function ($subject) {
    return User::find(1);
});
```
```

--------------------------------

### CauserResolver resolveUsing method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/causer-resolver.md

Registers a custom callback for resolving the causer.

```php
public function resolveUsing(Closure $callback): static;
```

--------------------------------

### Implement HasActivity trait in User model

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Use the HasActivity trait to combine both logging and causer functionality in a single model.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Activitylog\Models\Concerns\HasActivity;
use Spatie\Activitylog\Support\LogOptions;

class User extends Model
{
    use HasActivity;

    public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
        ->logFillable();
    }
}
```

--------------------------------

### CauserResolver setCauser method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/causer-resolver.md

Manually sets the causer for the current context.

```php
public function setCauser(?Model $causer): static;
```

--------------------------------

### LogOptions logOnlyDirty Method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Restricts logging to only those attributes that have actually changed after an update.

```php
/**
 * Log changes that have actually changed after the update.
 */
public function logOnlyDirty(): LogOptions;
```

--------------------------------

### Clean a specific log channel

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/cleaning-up-the-log.md

Filters the activity log by the log_name attribute by passing the channel name as an argument.

```bash
php artisan activitylog:clean my_log_channel
```

--------------------------------

### Scope causer to a block using Activity::defaultCauser

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/define-causer-for-runtime.md

Pass a callback as the second argument to Activity::defaultCauser to scope the causer to that specific block. The previous causer is automatically restored after the callback executes.

```php
use Spatie\
\\nActivitylog\\Facades\\Activity;

Activity::defaultCauser($admin, function () {
    $product->update(['name' => 'New name']);
    // this activity will have $admin as the causer
});

// the previous causer is restored here
```

--------------------------------

### logOnly(array $attributes)

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/log-options.md

Only log changes to these specific attributes.

```APIDOC
## logOnly(array $attributes)

### Description
Only log changes to these specific attributes.

### Method
PHP method

### Signature
public function logOnly(array $attributes): LogOptions

### Parameters
- **attributes** (array) - Required - The list of attribute names to log.

### Returns
LogOptions - The current LogOptions instance for chaining.

### Example
```php
LogOptions::defaults()->logOnly(['name', 'email']);
```
```

--------------------------------

### Setting a causer with causedBy

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/logging-activity.md

Define the causer of the activity using the causedBy() method.

```php
activity()
   ->causedBy($userModel)
   ->performedOn($someContentModel)
   ->log('edited');

$lastActivity = Activity::all()->last(); //returns the last logged activity

$lastActivity->causer; //returns the model that was passed to `causedBy`;
```

--------------------------------

### Override retention days per call

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/basic-usage/cleaning-up-the-log.md

Uses the --days option to specify the retention period for a single execution, overriding the default configuration.

```bash
php artisan activitylog:clean --days=7
```

--------------------------------

### Retrieve activities as causer

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/logging-model-events.md

Access the activities caused by the current user using the activitiesAsCauser relationship provided by the CausesActivity trait.

```php
Auth::user()->activitiesAsCauser;
```

--------------------------------

### CauserResolver resolve method

Source: https://github.com/spatie/laravel-activitylog/blob/main/docs/advanced-usage/causer-resolver.md

Resolves the causer based on the provided subject.

```php
public function resolve(Model | int | string | null $subject = null): ?Model;
```
Tokens:
Raw