greensight/laravel-auditing

This package is abandoned and no longer maintained. The author suggests using the ensi/laravel-auditing package instead.

0.1.3 2021-08-27 19:02 UTC

Requires

• php: ^8.0
• illuminate/console: ^7.0|^8.0
• illuminate/database: ^7.0|^8.0
• illuminate/filesystem: ^7.0|^8.0
• illuminate/support: ^7.0|^8.0
• ramsey/uuid: ^4.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• illuminate/contracts: ^8.0
• mockery/mockery: ^1.0
• orchestra/testbench: ^6.0
• php-parallel-lint/php-var-dump-check: ^0.5.0
• phpunit/phpunit: ^9.0

MIT

• Alex Kroll

README

Deprecated, use https://github.com/ensi-platform/laravel-auditing instead Opiniated fork of owen-it/laravel-auditing

Установка

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

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

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

use Greensight\LaravelAuditing\Contracts\Auditable;
use Greensight\LaravelAuditing\SupportsAudit;

class Something extends Model implements Auditable {
    use SupportsAudit;
}

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

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

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

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

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

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

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

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

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

Лицензия

The MIT License (MIT).