## File: README.md

<a href="https://spatie.be/open-source?utm_source=github&utm_medium=banner&utm_campaign=laravel-activitylog">
      
        
        
      
    </a>

<h1>Log activity inside your Laravel app</h1>

[](https://packagist.org/packages/spatie/laravel-activitylog)
[](https://github.com/spatie/laravel-activitylog/actions/workflows/run-tests.yml)
[](https://github.com/spatie/laravel-activitylog/actions/workflows/php-cs-fixer.yml)
[](https://packagist.org/packages/spatie/laravel-activitylog)
    


The `spatie/laravel-activitylog` package provides easy to use functions to log the activities of the users of your app. It can also automatically log model events.
The package stores all activity in the `activity_log` table.

Here's a demo of how you can use it:

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

You can retrieve all activity using the `Spatie\Activitylog\Models\Activity` model.

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

Here's a more advanced example:

```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'
```

Here's an example on [event logging](https://spatie.be/docs/laravel-activitylog/advanced-usage/logging-model-events).

```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
```

Calling `$activity->attribute_changes` will return this collection:

```php
[
   'attributes' => [
        'name' => 'updated name',
        'text' => 'Lorem',
    ],
    'old' => [
        'name' => 'original name',
        'text' => 'Lorem',
    ],
];
```

## Support us

[](https://spatie.be/github-ad-click/laravel-activitylog)

We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).

## Documentation

You'll find the documentation on [https://spatie.be/docs/laravel-activitylog/introduction](https://spatie.be/docs/laravel-activitylog/introduction).

Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving the activity log? Feel free to [create an issue on GitHub](https://github.com/spatie/laravel-activitylog/issues), we'll try to address it as soon as possible.

## Installation

You can install the package via composer:

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

The package will automatically register itself.

You can publish the migration with:

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

_Note_: The default migration assumes you are using integers for your model IDs. If you are using UUIDs, or some other format, adjust the format of the `subject_id` and `causer_id` fields in the published migration before continuing.

After publishing the migration you can create the `activity_log` table by running the migrations:

```bash
php artisan migrate
```

You can optionally publish the config file with:

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

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes.

## Upgrading

Please see [UPGRADING](UPGRADING.md) for details.

## Testing

```bash
composer test
```

## Contributing

Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.

## Security

If you've found a bug regarding security please mail [security@spatie.be](mailto:security@spatie.be) instead of using the issue tracker.

## Credits

-   [Freek Van der Herten](https://github.com/freekmurze)
-   [Sebastian De Deyne](https://github.com/sebastiandedeyne)
-   [Tom Witkowski](https://github.com/Gummibeer)
-   [All Contributors](../../contributors)

Special thanks to [Ahmed Nagi](https://github.com/nagi1) for all the work he put in `v4` and to [Caneco](https://twitter.com/caneco) for the original logo.

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

---

## File: art/README.md

# Laravel Activity Log Art

The logo was inspired by the [Spatie](https://spatie.be) brand, and the well known minimal design of Laravel packages.

## Fonts

The logo is using the following fonts:

- [Inter 500](https://fonts.google.com/specimen/Inter#500)
- [Inter 600](https://fonts.google.com/specimen/Inter#600)

## Colors

|                            |#hex     |rgb()             |
|---                         |---      |---               |
||`#E8F1F4`|`rgb(232,241,244)`|
||`#C6DDE4`|`rgb(198,221,228)`|
||`#A3C8D4`|`rgb(163,200,212)`|
||`#5E9EB3`|`rgb(94,158,179)` |
||`#197593`|`rgb(25,117,147)` |
||`#176984`|`rgb(23,105,132)` |
||`#0F4658`|`rgb(15,70,88)`   |
||`#0B3542`|`rgb(11,53,66)`   |
||`#08232C`|`rgb(8,35,44)`    |

## Requirements

- A screen or a printer

## Installation

- Open the file
- *Right-click* on the image
- Choose **"Save image as…"** option

## Maintainers

**Laravel Activity Log** logo is designed and maintained by [Caneco](https://twitter.com/caneco).

## License

All rights reserved, but with the following extra conditions:

- It is **OK** to use the Laravel Activity Log logo in the following cases:
    - In marketing materials for technical events, e.g. meetups, hackathons, conferences and workshops that are related to Laravel.
    - In open source projects related to Laravel.
    - In technical articles/videos/books/papers for educational purposes.
    - To illustrate a commercial product.

- It is **NOT OK** to use the Laravel Activity Log logo in the following cases without prior written consent from the copyright owners:
    - Using the Laravel Activity Log logo in a commercial product for purposes other than illustrating its integration.
    - Sell physical products that uses the Laravel Activity Log logo or its variants, e.g. t-shirts.

By any means the owner reserves the right of final explanation for any use case not explicitly stated above.

---

## File: docs/introduction.md

---
title: Introduction
weight: 1
---

The `spatie/laravel-activitylog` package provides easy to use functions to log the activities of the users of your app. It can also automatically log model events. All activity will be stored in the `activity_log` table.

Here's a little demo of how you can use it:

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

You can retrieve all activity using the `Spatie\Activitylog\Models\Activity` model.

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

Here's a more advanced example:

```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'
```

Here's an example on [event logging](/docs/laravel-activitylog/v5/advanced-usage/logging-model-events).

```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
```

Calling `$activity->attribute_changes` will return this collection:

```php
[
    'attributes' => [
        'name' => 'updated name',
        'text' => 'Lorem',
    ],
    'old' => [
        'name' => 'original name',
        'text' => 'Lorem',
    ],
];
```

## We have badges!

<section class="article_badges">
    [](https://packagist.org/packages/spatie/laravel-activitylog)
    [](https://github.com/spatie/laravel-activitylog/actions/workflows/run-tests.yml)
    [](https://github.com/spatie/laravel-activitylog/blob/main/LICENSE.md)
    [](https://packagist.org/packages/spatie/laravel-activitylog)
</section>