infog/used_files_mapper

这是一个小型库,可以帮助通过记录使用的 PHP 文件来调试应用程序。

0.7.1 2020-02-17 10:00 UTC

This package is auto-updated.

Last update: 2024-09-17 19:54:32 UTC


README

此库将记录您的 PHP 应用程序使用的 php 文件。

这里的想法是了解代码的哪些部分被使用,哪些没有被使用,因此可以更安全地删除它们。

当升级 PHP 版本或学习新的代码库时,此库特别有用。

它通过记录使用的文件,然后从这些文件中生成使用报告来实现。

用法

只需在索引文件中注册映射器,并传递一个要写入输出的文件名即可

<?php

use InFog\UsedFilesMapper\FilesMapper;

FilesMapper::register('/tmp/usedfiles.log');

运行应用程序后,您将在传递给注册方法的日志文件中看到使用的文件列表。

保留日志

您是否想使用报告命令生成包含使用文件列表的漂亮 HTML 页面?那么您应该使用 MODE_APPEND 选项在日志文件中保留使用的文件。

<?php

use InFog\UsedFilesMapper\FilesMapper;

FilesMapper::register('/tmp/usedfiles.log', FilesMapper::MODE_APPEND);

生成热图

为了生成报告,您需要日志文件和应用程序的代码库。

以下是一个示例

  • 服务器上的文件位于 /app/website
  • 收集了一些使用情况后,您已将报告下载到 ~/Desktop/usedfiles.log
  • 代码库位于 ~/Projects/website

可以使用以下命令生成报告

cd ~/Projects/website
./vendor/infog/used_files_mapper/bin/report . /app/website/ ~/Desktop/usedfiles.log /tmp/report.html

许可协议

本程序是自由软件:您可以在自由软件基金会发布的 GNU 通用公共许可证的条款下重新分发和/或修改它,无论是许可证的第 3 版,还是(根据您的选择)任何后续版本。

本程序是根据希望它会有所帮助的愿望进行分发的,但不提供任何保证;甚至不提供适销性或适用于特定目的的隐含保证。有关详细信息,请参阅 GNU 通用公共许可证。

您应该已经随本程序收到一份 GNU 通用公共许可证副本。如果没有,请参阅https://gnu.ac.cn/licenses/