добавляю основной trait для автоматического логирования изменений в моделях, его нужно подключать в моделях, изменения которых планируется логировать (подробнее в конфлюенс). Также добавляю конфиг с настройками пакета логирования (хотя возможно, он автоматически создается при установке пакета)
This commit is contained in:
vasya
@@ -0,0 +1,148 @@
|
||||
<?php
|
||||
|
||||
namespace app\Traits;
|
||||
|
||||
use PHPUnit\Event\Code\Throwable;
|
||||
use Spatie\Activitylog\LogOptions;
|
||||
use Spatie\Activitylog\Traits\LogsActivity;
|
||||
use Spatie\Activitylog\Contracts\Activity;
|
||||
use App\Enums\LogBusinessEvents;
|
||||
|
||||
trait LogsActivity_custom
|
||||
{
|
||||
//"наследуем" готовый трейт из пакета логирования, чтобы расширить его
|
||||
use LogsActivity;
|
||||
|
||||
/**
|
||||
*
|
||||
* @param string имя журнала логирования (название приложения). Нужно переопределять в модели в зависимости от используемого приложения (модуля)
|
||||
*/
|
||||
protected $logActivity_custom__name;
|
||||
/**
|
||||
* @param array Массив с кастомными значениями, которые хотим логировать независимо от модели, событие в которой логируется
|
||||
*/
|
||||
// protected $activityCustomProperties = [
|
||||
// 'custom__user_login' => session()->get('_auth_login'),
|
||||
// ];
|
||||
protected $activityCustomProperties = [];
|
||||
/**
|
||||
* @var array массив с кастомными значениями, которые относятся к самому действию логирования, а не к изменениям в результате логируемого действия (properties). Например, название совершенного действия: архивация, отмена, восстановление и т.д.
|
||||
*/
|
||||
protected $activityCustomDescription = [];
|
||||
/**
|
||||
* @var string название совершенного бизнес-действия (не события из поля event, там могут быть только eloquent события: create, udate и т.д.). По умолчанию действие - изменение.
|
||||
*
|
||||
* Свойство статическое, потому что при использовании нестатического свойства, его значение после присваения "сбрасывается" до значения по умолчанию из за специфики работы с моделью. Каждое создание экземпляра модели может привести к сбросу свойства до значения по умолчанию. Если свойство статическое, его можно менять в любой момент и во всех экземплярах этой модели оно будет изменено
|
||||
*/
|
||||
protected static $businessEvent = LogBusinessEvents::Edit;
|
||||
|
||||
/**
|
||||
* Единые опции логирования любых события в моделях, где указано использование данного трейта
|
||||
*
|
||||
* @return LogOptions
|
||||
*/
|
||||
public function getActivitylogOptions(): LogOptions
|
||||
{
|
||||
return LogOptions::defaults()
|
||||
->logAll() //Логируем все поля
|
||||
->logOnlyDirty() //Логируем только изменившиеся по сравнению с текущим состоянием значения
|
||||
->useLogName($this->logActivity_custom__name ? $this->logActivity_custom__name : 'default') //Имя журнала (имя приложения) события которого логируются
|
||||
->logExcept(['created_at', 'updated_at']); //Поля, значения которых не логируются
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Тут прописываем дополнительные свойства, которые будут добавляться к каждой записи логирования изменения моделей
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function getActivityLogDefaultProp (): array
|
||||
{
|
||||
//Добавляем логин пользователя к записи с логированием события. Если изменение произошло через web роут, то берется логин из объекта ldap (свойство samaccountname), если было обращение через api ендпоинт, берется логин из таблицы users, где делается запись при аутентификации пользователя. Это связано со спецификой аутентификации при вызове web роута и api ендпоинта
|
||||
//UPD: решил отказаться от логирования пользователя через расширение properties, но для примера пока оставил
|
||||
//return ['custom__user_login' => auth()->user()->login ?? auth()->user()->samaccountname[0]];
|
||||
return [];
|
||||
}
|
||||
|
||||
// public function getActivitylogOptions(): LogOptions
|
||||
// {
|
||||
// //CauserResolver::setCauser('dgavrilov');
|
||||
// return LogOptions::defaults()
|
||||
// ->logAll() // Перечисляем логируемые поля. В данном случае, логируем все поля
|
||||
// ->logExcept(['created_at', 'updated_at']) // Поля, которые не будут логироваться не при каких условиях
|
||||
// ->logOnlyDirty() // Логируются только поля, данные в которых были изменены
|
||||
// //->useLogName($this->getLogName());
|
||||
// ->useLogName($this->logActivity_custom__name ? $this->logActivity_custom__name : 'default'); //Имя журнала логирования. Либо переопределеяется в модели, который использует данный трейт, либо по умолчанию ставится default
|
||||
// // ->tapActivity(function (Activity $activity) {
|
||||
// // // Указываем пользователя из сессии/кук
|
||||
// // //$activity->causer_id = auth()->id(); // или явно: 1
|
||||
// // $activity->causer_id = 'dgavrilov'; // или явно: 1
|
||||
// // //$activity->causer_type = \App\Models\User::class;
|
||||
// // });
|
||||
// }
|
||||
|
||||
/**
|
||||
* Метод позволяет "вмешаться" в процесс логирования в "последний момент" перед записью в модель activity_log. В данном случае, значения в поле properties обогащаются доп значениями, которые мы описали в свойстве $this->activityCustomProperties
|
||||
*
|
||||
* @param Activity $activity
|
||||
* @param string $eventName
|
||||
* @return void
|
||||
*/
|
||||
public function tapActivity(Activity $activity, string $eventName)
|
||||
{
|
||||
$this->activityCustomProperties = array_merge($this->activityCustomProperties, $this->getActivityLogDefaultProp());
|
||||
// $this->activityCustomDescription = $this->setLogDescription();
|
||||
$activity->properties = $activity->properties->merge(['custom_props' => $this->activityCustomProperties]);
|
||||
//переопределение поле description модели activityLog
|
||||
// $activity->description = json_encode($this->activityCustomDescription);
|
||||
$activity->business_event = self::$businessEvent;
|
||||
}
|
||||
|
||||
#Гаврилов
|
||||
//ЛУЧШЕ СДЕЛАТЬ ЕДИНЫЙ МЕТОД, ПРИНИМАЮЩИЙ НАЗВАНИЕ ACTION, СРАВНИВАЯ ЕГО СО СВОЙСТВОМ ТЕКУЩЕГО КЛАССА businessAction И ВОЗВРАЩАЮЩИЙ ОШИБКУ, ЕСЛИ ТАКОГО СВОЙСТВА НЕТ
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Метод инициации логирования бизнес-действия: создание, редактирование, архивация. В поле event по умолчанию логируются только Eloquent события: create, update и тд
|
||||
*
|
||||
* @param string $action логируемое бизнес-действие
|
||||
* @return void
|
||||
*/
|
||||
public function logBusinessEvent(LogBusinessEvents $event)
|
||||
{
|
||||
self::$businessEvent = $event;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @return array формирование дополнительного описания с информацией для логируемого действия
|
||||
*/
|
||||
// public function setLogDescription()
|
||||
// {
|
||||
// $activityDescription = array_merge(
|
||||
// $this->activityCustomDescription,
|
||||
// );
|
||||
|
||||
// return $activityDescription;
|
||||
// }
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Метод добавления кастомных значений для логирования
|
||||
*
|
||||
* Поля, переданные в метод из модели, где подключен этот трейт
|
||||
*
|
||||
* @param array $properties
|
||||
* @return void
|
||||
*/
|
||||
public function addCustomLogProperties(array $properties): void
|
||||
{
|
||||
$this->activityCustomProperties = array_merge(
|
||||
$this->activityCustomProperties ?? [],
|
||||
$properties
|
||||
);
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user