Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laravel-backpack/activity-log
https://github.com/laravel-backpack/activity-log
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/laravel-backpack/activity-log
- Owner: Laravel-Backpack
- License: mit
- Created: 2022-11-20T21:48:48.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T10:14:10.000Z (2 months ago)
- Last Synced: 2024-12-24T02:48:10.669Z (10 days ago)
- Language: PHP
- Size: 164 KB
- Stars: 30
- Watchers: 7
- Forks: 7
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license.md
Awesome Lists containing this project
README
# Activity Log
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Total Downloads][ico-downloads]][link-downloads]
[](https://github.com/the-whole-fruit/manifesto)
Ever wanted to see WHO changed WHAT and WHEN inside your app? Want to remember all the DB changes your users have done? Well... this package doesn't do that. [`spatie/laravel-activitylog`](https://github.com/spatie/laravel-activitylog) does, and does it very well. This package adds a web interface for it, for projects using [Backpack for Laravel](https://backpackforlaravel.com/). It gives your admin/superadmin the ability to see
- the activities performed _by_ certain models;
- the activities performed _on_ certain models;
- and more;
How does it all work? Well:
- when a change happens to an Eloquent model, the Spatie package will make a note of it in the database;
- this package adds a web interface, so the admin can see the changes (aka activity log);
## Preview
**NOTE**: The filters are a [Backpack\PRO](https://backpackforlaravel.com/products/pro-for-one-project) feature. If you don't have that package the filters won't be available.
## Demo
Try it right now, in [our online demo](https://demo.backpackforlaravel.com/admin/activity-log). Edit some entities, and check the [activity logs](https://demo.backpackforlaravel.com/admin/activity-log).
## Installation
In your Laravel + Backpack project, install this package:
```bash
# install this interface package:
composer require backpack/activity-log
# add a menu item for it
php artisan backpack:add-menu-content ""
```
But also, if your package didn't already have [`spatie/laravel-activitylog`](https://github.com/spatie/laravel-activitylog) installed and set up, please [follow the installation steps in their docs](https://spatie.be/docs/laravel-activitylog/v4/installation-and-setup). We'll also copy-paste them here, for your convenience:
```bash
php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="activitylog-config"
php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="activitylog-migrations"
php artisan migrate
```
## Usage
> Note: If your models _are not_ configured to create activity logs yet, [read the FAQ on how to log all model events](#how-to-log-model-events-created-updated-deleted-etc). If you are unsure, then you have not configured them to log activities - read it.
### ActivityLog list view
Use it to browse all activity, filter the view, search the view, etc:
### ActivityLog show view
Use it to see details about a particular activity:
### CrudController operations
If you want your CrudControllers to show links to their activities, just use one or both of the provided Backpack operations:
- **ModelActivityOperation**: Displays a general button, allowing users to see a comprehensive list of all activities for that Model.
- **EntryActivityOperation**: Adds line buttons to each entry in the list, enabling users to view activity logs specific to individual entries.
#### ModelActivityOperation - on a CrudController, display a link to that Model's activity log
Say you have a `UserCrudController`. If you want a new button to show up next to _the `Add User` button_, that will take you to _all of the activities of all Users_, then use `\Backpack\ActivityLog\Http\Controllers\Operations\ModelActivityOperation` on your `UserCrudController`.
```diff
Note: this is NOT a feature that is provided by this package. It's provided by `spatie/laravel-activitylog`.
> But we try to help document the most common use case we have found, so it's easier for you to do it.
You want a new Activity registered, whenever a model is `created`, `updated`, `deleted` etc? So that there's a record of WHO did WHAT and WHEN it happened? Here's how you can set up `spatie/laravel-activitylog` to log all model events.
**Step 1.** Create a new model trait at `App\Models\Traits\LogsActivity.php` with the following content:
```php
logAll()->logOnlyDirty();
}
}
```
**Step 2.** Use that trait on all Models where you want all events logged:
```diff
logFillable()
->logOnlyDirty();
}
```
#### Can I customize the logs even further?
Yes, you can! The Spatie laravel-activitylog package offers a range of advanced customization options.
For detailed insights into these options, check out the official Log Options documentation by Spatie, at https://spatie.be/docs/laravel-activitylog/v4/api/log-options
#### I am using `backpack/permission-manager` so I don't have access to `UserCrudController`
If you haven't customized your `UserCrudController` yet, you can achieve this by binding the Backpack controller to your custom controller. In your `App\Providers\AppServiceProvider.php`:
```php
class AppServiceProvider extends ServiceProvider
{
public function register()
{
$this->app->bind(
\Backpack\PermissionManager\app\Http\Controllers\UserCrudController::class,
\App\Http\Controllers\Admin\UserCrudController::class
);
```
Then in your `App\Http\Controllers\Admin\UserCrudController.php` you can do something like:
```php
use Backpack\PermissionManager\app\Http\Controllers\UserCrudController as OriginalUserCrudController;
class UserCrudController extends OriginalUserCrudController
{
use \Backpack\ActivityLog\Http\Controllers\Operations\ModelActivityOperation;
use \Backpack\ActivityLog\Http\Controllers\Operations\EntryActivityOperation;
}
```
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Antonio Almeida](https://github.com/promatik)
- [Cristian Tabacitu](https://github.com/tabacitu)
- [All Contributors][link-contributors]
## License
This project was released under MIT License, so you can install it on top of any Backpack & Laravel project. Please see the [license file](license.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/backpack/activity-log.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/backpack/activity-log.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/backpack/activity-log
[link-downloads]: https://packagist.org/packages/backpack/activity-log
[link-author]: https://github.com/backpack
[link-contributors]: ../../contributors