ensi/laravel-auditing

0.3.6 2023-09-14 12:02 UTC

This package is auto-updated.

Last update: 2024-04-14 13:18:10 UTC


README

Opiniated fork of owen-it/laravel-auditing

Установка

  1. composer require ensi/laravel-auditing
  2. php artisan vendor:publish --provider="Ensi\LaravelAuditing\LaravelAuditingServiceProvider"
  3. Добавьте в config/app класс провайдера Ensi\LaravelAuditing\LaravelAuditingServiceProvider::class

Использование

По-умолчанию никакая история изменения для моделей не сохраняется. Чтобы включить логирование для конкретной модели надо добавить ей трейт SupportsAudit и интерфейс Auditable

use Ensi\LaravelAuditing\Contracts\Auditable;
use Ensi\LaravelAuditing\SupportsAudit;

class Something extends Model implements Auditable {
    use SupportsAudit;
}

В случае, если мы меняем данные дочерних с логической точки зрения моделей и хотим чтобы в истории это изменение проходило под родительской моделью, необходимо в транзакции до изменения данных задать корневую сущность (т.е модель). Делается это через фасад Transaction или менеджер \\Ensi\\LaravelAuditing\\Transactions\\ExtendedTransactionManager

DB::transaction(function () {
    Transaction::setRootEntity($rootModel);
    
    $relatedModel->save();
});

Для добавления в историю данных о том кто произвел изменения (конкретный пользователь, или, например, консольная команда) опять же нужно это сделать до изменения данных, но уже через фасад Subject или инъекцию \\Ensi\\LaravelAuditing\\Resolvers\\SubjectManager

Subject::attach($subject); // $subject - объект реализующий Ensi\LaravelAuditing\Contracts

Субъект не отвязывается после завершения транзакции. Его можно отвязать вручную вызовом метода Subject::detach().

При обработке http запросов, можно задавать субъекта в middleware. В консольных командах и обработчиках очереди событий переназначать в процессе выполнения.

Субъектом может являться любая сущность, поддерживающая интерфейс \Ensi\LaravelAuditing\Contracts\Principal. Если субъектом является выполняемое задание, например, импорт из файла, то оно может возвращать идентификатор пользователя, создавшего задание в методе getUserIdentifier(), а в качестве наименования возвращать имя импортируемого файла.

В модели пользователя методы getAuthIdentifier() и getUserIdentifier() возвращают один и тот же идентификатор.

Также в отличии от исходного пакета в истории сохраняются не только измененные поля, но и полное состояние объекта модели на момент изменения.

Contributing

Testing

  1. composer install
  2. npm i
  3. composer test

Лицензия

The MIT License (MIT).