zerig/report

报告用户关于发生了什么。

维护者

详细信息

github.com/Zerig/report

源代码

问题

安装: 17

依赖项: 1

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放性问题: 0

v1.1.0 2020-05-05 13:19 UTC

Requires

MIT 44604aaf4afb25ad632534385ef22809e866b63a

  • Jeronym Pelikovsky <pelikovsky.woop@gmail.com>

report

This package is auto-updated.

Last update: 2024-09-05 22:47:38 UTC

README

报告命名空间设置和收集 操作报告，这些报告应由访客显示。如果没有这些，用户将无法知道发生了什么。如果他的操作成功或失败。\n 例如：'项目已成功更新'。

rData($array)

此类的实例代表一个操作报告。这里有访客需要看到的一切。

\Report\rDATA([
	"group" => "action",               // GROUP of REPORT => mysql, file, form, ...
	"state" => "fail",                 // How action END => success, info, fail
	"msg"   => "This action failed.",  // Message what happend
	"type"  => 0,                      // CODE or NAME of GROUP action => 1062, insert, upload,...
	"num"   => 1                       // How many items was in action
]);

GROUP

每个组报告都有特殊的类继承自 \Report\Action。这是因为每个组都需要以不同的方式解决。

  • Report\Mysql 应设置关于 数据库 操作（插入、更新、删除等）的报告
  • Report\File 应设置关于 文件 操作的报告（删除、上传、移动等）
  • Report\Form 应设置关于 表单 操作的报告（输入为空等）

STATE

每个组报告都有特殊的类继承自 \Report\Action。这是因为每个组都需要以不同的方式解决。

  • 成功 当操作成功时
  • 信息 当你想通知用户某事时
  • 失败 当操作失败时

MSG

在用户操作后显示给用户的文本。它们保存在与方法相同的文件夹中的 JSON 文件中。\n

{
	"action": {
		"fail":{
			"0": "Something goes WRONG!",
			"duplicit": "0% 1% already exist"
		},
		"info":{
			"0": "Nothig is happend."
		},
		"success":{
			"0": "Everything happend successfully."
		}
	}
}
  1. 第一级表示你想要哪个 group 的答案
  2. 第二级是 state：操作如何发生
  3. 第三级 type 表示具体发生了什么。但如果找不到该 type，则使用 type = 0

更多信息请参阅类 \REPORT\ACTION

TYPE

表示具体发生了什么

  • 重复项
  • 文件存在
  • 没有权限删除文件

它们可以作为快捷方式 'duplicit' 或代码 '1062'。如果 JSON 中找不到 type，则使用 type = 0。

NUM

操作中项目数量。在 MYSQL 查询中更改了多少个项目。上传了多少个文件...