lyrasoft / action-log
LYRASOFT Action Log Package
Installs: 468
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 1
Type:windwalker-package
Requires
- php: >=8.2
- lyrasoft/luna: ^2.1
- lyrasoft/toolkit: ^1.1
- openspout/openspout: ^4.22
This package is auto-updated.
Last update: 2024-10-15 16:36:49 UTC
README
Installation
Install from composer
composer require lyrasoft/action-log
Then copy files to project
php windwalker pkg:install lyrasoft/action-log -t routes -t migrations
And run migrtions.
Next, add Middleware to routes/admin.route.php
use Lyrasoft\ActionLog\Middleware\ActionLogMiddleware; // ... $router->group('admin') // ... ->middleware(ActionLogMiddleware::class) // ...
If you want to log front and admin, you may put middleware to
main.route.php
Languages
Add this line to admin & front middleware to load language from package automatically:
use Lyrasoft\ActionLog\ActionLogPackage; // ... $this->lang->loadAllFromVendor(ActionLogPackage::class, 'ini');
If you want to copy language file to project, run this:
php windwalker pkg:install lyrasoft/action-log -t lang
Register Admin Menu
Edit resources/menu/admin/sidemenu.menu.php
// Action Log $menu->link('操作記錄') ->to($nav->to('action_log_list')) ->icon('fal fa-shoe-prints');
Getting Started
If you have setup ActionLog package, now try to save any item or filter any list, you can see a new log shows on
action_logs
table:
Auto Clear
Bt default, ActionLog only reserve last 3 months logs. It has 1/100 chance to trigger clear action.
You can configure the reserve time and clear chance at config file or using env to configure them:
return [ 'action_log' => [ 'reserve_max_time' => env('ACTION_LOG_MAX_TIME') ?: '3months', 'auth_clear' => [ 'chance' => env('ACTION_LOG_CLEAR_CHANCE', 1), 'chance_base' => env('ACTION_LOG_CLEAR_CHANCE_BASE', 100) ], // ... ] ];
Configure Middleware
Add options to middleware:
$router->group('admin') // ... ->middleware( ActionLogMiddleware::class, options: [ 'methods' => ['POST', 'DELETE'], 'enabled' => (bool) env('ACTION_LOG_ENABLE'), 'max_time' => '7days', // ... ] ) // ...
Prepare Log Handler
Add a custom handler to configure every log, must use $log
argument to inject log item.
This is an example to override user name.
use Lyrasoft\ActionLog\Entity\ActionLog; use Lyrasoft\Luna\User\UserService; $router->group('admin') // ... ->middleware( ActionLogMiddleware::class, options: [ 'prepare_log' => function (ActionLog $log, UserService $userService) { $user = $userService->getUser(); $log->setName($user->getFirstName() . ' ' . $user->getLastName()); } ] ) // ...
If you want to ignore some actions, just return FALSE in prepare log handler:
'prepare_log' => function (ActionLog $log, UserService $userService) { // ... if ($log->getTask() === '...') { // This log will not save return false; } }
Manually Log
Just inject ActionLogService
to do this.
/** @var \Lyrasoft\ActionLog\Service\ActionLogService $actionLogService */ $actionLogService = $app->retrieve(\Lyrasoft\ActionLog\Service\ActionLogService::class); $appRequest = $app->retrieve(\Windwalker\Core\Http\AppRequest::class); $actionLogService->clearExpiredIfTriggered(); $actionLogService->log($appRequest, $response ?? null); // Or just create entity item. $log = $actionLogService->createLogItem($appRequest, $response ?? null);
Custom Task (Action) and Entity Render
By default, the admin list table shows task and entity by english programaticlly name.
You can custom the render name by events. Create a subscriber:
namespace App\Subscriber; use Lyrasoft\ActionLog\Event\FormatEntityEvent; use Lyrasoft\ActionLog\Event\FormatTaskEvent; use Windwalker\Event\Attributes\EventSubscriber; use Windwalker\Event\Attributes\ListenTo; #[EventSubscriber] class ActionLogSubscriber { #[ListenTo(FormatTaskEvent::class)] public function formatTask(FormatTaskEvent $event): void { $text = &$event->getTaskText(); $log = $event->getLog(); $task = $log->getTask(); // Custom you task text // Same examples if ($task === 'relativeContracts') { $text = '相關合約操作'; } if ($task === 'relativeRentals') { $text = '相關委託操作'; } if ($task === 'addToCart') { $text = '加入購物車'; } } #[ListenTo(FormatEntityEvent::class)] public function formatEntity(FormatEntityEvent $event): void { $text = &$event->getEntityText(); $log = $event->getLog(); // Custom you entity text } }
Register this subscriber to etc/app/main.php
:
// ... 'listeners' => [ \Lyrasoft\ActionLog\Service\ActionLogService::class => [ \App\Subscriber\ActionLogSubscriber::class ] ],
The text you return from event will show at table list: