jackjoe/activity-log

一个简洁的 Laravel 5 活动日志记录器,用于记录网站/应用程序操作。

0.3.3 2018-03-01 08:03 UTC

This package is auto-updated.

Last update: 2024-09-24 22:56:51 UTC


README

Latest Version on Packagist Build Status Scrutinizer Code Quality Total Downloads

安装

基本安装、服务提供者注册和别名设置

安装使用 composer 完成,所以将包添加到您的composer.json文件中

"require": {
	"jackjoe/activity-log": "0.3.*"
},

然后运行 composer update

Laravel 5.5+

Laravel 5.5 具有自动发现功能,您已完成。如果没有,请参阅以下内容。

<= Laravel 5.4

app/config/app.php 中注册服务提供者和别名。将以下内容添加到 providers 数组中

JackJoe\ActivityLog\ActivityLogServiceProvider::class,

并将以下内容添加到 aliases 数组中

'Activity' => JackJoe\ActivityLog\Models\Activity::class,

发布迁移和配置

要从命令行发布此包的配置,请运行以下命令

php artisan vendor:publish --provider="JackJoe\ActivityLog\ActivityLogServiceProvider"

注意:迁移仅被发布;请记住在准备就绪时运行它们。

要从命令行运行迁移以创建 ActivityLog 的表,请运行以下命令

php artisan migrate

基本用法

记录用户活动

Activity::log([
  'contentId'   => $user->id,
  'content' => 'User',
  'action'      => 'ACTION',
  'state'       => 'SUCCESS',
  'details'     => 'Username: ' . $user->username,
  'data'        => json_encode($data)
]);

上述代码将为当前登录用户记录活动。IP 地址将自动保存。

变量指南

  • content:我们处理的内容类型,可以是 PHP 类、控制器、模型等。它提供了更多上下文,说明了此操作发生在何处。
  • contentId(可选):内容的 id,如果是模型的话
  • action:方法名称,方法中的子操作等
  • state:动作状态,如 ERRORSUCCESSWRONG_CODE
  • details:更多关于当前状态的元数据
  • data:原始数据、获取的内容、提交的内容等

贡献

有关详细信息,请参阅 CONTRIBUTING

鸣谢

基于 Regulus/ActivityLog 构建。

许可协议

MIT 许可协议(MIT)。有关更多信息,请参阅 许可文件