Matomo插件目录结构

每个插件在根目录中都有自己的目录插件/目录中。一般来说,插件都有类似的结构作为Matomo核心对于大多数事情。大多数插件只有很少的文件,而其他一些插件有更多的文件。下面是插件中可能存在的一些文件和目录的列表。

文件/目录 描述
plugin.json 包含插件的元数据例如联系信息、描述等等。主要用于市场上的插件。
PluginName.php美元 PluginName美元需要替换为插件的名称。这个文件是允许插件监听的插件文件事件和方法钩子,例如安装()激活而且卸载()
活动/ 该目录包括应记录的活动Matomo活动/审计日志高级功能。
API.php 定义了API方法对于这个插件。
Archiver.php 该文件包括关于如何从日志原始数据创建归档报告的逻辑。
类别/ 此目录包括用于构建报表菜单的菜单类别和子类别。例如,它们定义了它们在菜单中显示的顺序。
changes.json 这个可选文件包含更改通知将显示在“What's New?”对话框中。
列/ 这个目录包括和指标。
命令/ 这个目录包括控制台命令
配置/ 这个目录可以包括各种文件,如“config.php”和“test.php”,以更改Matomo使用依赖注入
Controller.php 定义了控制器操作对于这个插件。
刀/ 此目录包括主要连接到数据库并执行查询的数据访问对象。它通常不包含太多逻辑。
数据表/过滤器 这个目录可能包括自定义插件数据表过滤器
诊断/ 这个目录通常包括系统检查
文档/ index.md 该文件的降价内容将显示在Marketplace上的Documentation选项卡中。
文档/ faq.md 该文件的降价内容将显示在市场上的FAQ选项卡中。
图像/ 此目录包括显示在用户界面中的图像和图标。
朗/ 这个目录包括用于翻译的语言文件
libs / 此目录可能包括第三方库。另外一个node_modules目录可以使用。
javascript / 这个目录包括JS文件。
LocationProvider / 此目录可能包括自定义位置提供程序。
MeasurableSettings.php 定义了自定义设置Matomo的一个可测量/站点。
Menu.php 该文件用于添加、删除或更改菜单项
模型/ 这个目录包括Models。这些通常使用类和有更多的逻辑。
报告/ 这个目录包括报告.每个报告都有一个PHP文件。
截屏/ 这个目录包括插件的截图,然后显示在我们的Matomo市场。
更新/ 这个目录包括迁移更新文件。
UserSettings.php 定义了用户设置显示在个人设置页面,可以由每个用户编辑。每个用户的设置存储方式不同,这意味着这里的更改不会影响其他用户的设置。
样式表/ 这个目录包括CSS或更少的样式表文件。
SystemSettings.php 定义了系统设置在Matomo的一般设置中显示,超级用户可以编辑。
Tasks.php 定义了计划任务与cron类似,周期性地执行。
模板/ 该目录包括树枝模板文件。
测试/夹具/ 此目录包括用于自动化测试的所有类型的fixture。
测试/框架/模拟 此目录可能包括PHP测试中使用的PHP模拟。
测试/集成/ 此目录包括集成PHP测试
测试/ javascript / index . php 该文件包括JavaScript测试为我们的JS跟踪器和标签管理器。
测试/ javascript / head.php 这个文件可以用来在JavaScript测试中为我们的JS跟踪器和标签管理器加载额外的JS文件。
测试/特/ 这个目录包括travis yml文件在插件的.travis中添加额外的步骤。yml文件
测试/ UI / 这个目录包括UI截图测试.每个测试文件以_spec.js
测试/单位/ 此目录包括单元PHP测试
测试/系统/ 此目录包括系统PHP测试
tracker.js 如果存在这样的文件,则此代码将被添加到Matomo JavaScript跟踪代码.如果一个tracker.min.js存在,则将使用缩小版。
跟踪/ RequestProcessor.php 该文件通常用于在跟踪请求期间与各种事件挂钩
跟踪/ LogTable / 如果插件为跟踪数据创建了自定义日志表,则该目录可以包含日志表。
供应商/ 由Composer安装的库。
VisitorDetails.php 此文件用于添加访问者日志或访问者配置文件的附加信息
可视化/ 这个目录包括可视化显示不同的报告数据。
部件/ 这个目录包括小部件.每个小部件有一个PHP文件。
Baidu