thangnm93/yii2-decomposer

一个用于分解已安装包、依赖项、您的应用程序及服务器环境的Yii2包

v0.1.5 2022-07-19 11:10 UTC

This package is auto-updated.

Last update: 2024-09-19 15:42:49 UTC


README

Yii 2 解析器扩展


有关许可信息,请查看LICENSE文件。

Latest Stable Version Total Downloads License PRs

简介

Yii 2 解析器可以分解并列出所有已安装的包及其依赖项,以及您的应用程序正在运行的Yii 2框架和服务器环境详细信息。所有这些只需在your-domain/decomposer的单个路由下点击即可。

此扩展的演示可在这里找到

此扩展基于lubusIN/laravel-decomposer的Laravel用户组件包装器。

要求

安装

安装此扩展的最佳方式是通过composer

运行以下命令

composer require thangnm93/yii2-decomposer

"thangnm93/yii2-decomposer": "*"

将其添加到您的composer.json文件的require部分。

使用方法

扩展安装后,只需按照以下方式修改您的应用程序配置

return [
    'bootstrap' => ['decomposer'],
    'modules' => [
        'decomposer' => [
            'class' => 'thangnm93\decomposer\Module',
        ],
        // ...
    ],
    ...
];

配置common/config/main.php以使用Yii::$app->decompose

return [
    'components' => [
        'decompose' => [
            'class' => 'thangnm93\decomposer\Decomposer',
        ],
    ],
    ...
];

以数组形式获取报告

  • 您可能希望在代码中访问分解器报告,以便将其传递给任何第三方服务(如Bugsnag)或如果需要,将其记录在某个位置。

  • 已引入了getReportArray()辅助方法来解决这个问题。

  • 首先按照以下方式使用分解器类

    use thangnm93\decomposer\helpers\DecomposerHelper;
  • 然后按照以下方式使用getReportArray()辅助方法

    $decomposerStats = DecomposerHelper::getReportArray();
  • 它返回一个具有4个键的多维关联数组:服务器环境、Yii 2环境、已安装的包和额外的统计信息(如果您或您的应用程序中的任何包添加了任何内容),相应详细信息作为关联数组。

以JSON形式获取报告

  • 您可能想以JSON形式访问相同的分解器报告

  • 已引入了getReportJson()辅助方法来解决这个问题。

  • 首先按照以下方式使用分解器类

    use thangnm93\decomposer\helpers\DecomposerHelper;
  • 然后按照以下方式使用getReportJson()辅助方法

    $decomposerStats = DecomposerHelper::getReportJson();
  • 它返回报告的JSON格式

测试

$ ./vendor/bin/phpunit --testdox --coverage-text --coverage-clover=coverage.clover

贡献

感谢您考虑为Yii 2 Decomposer做出贡献。您可以在此阅读贡献指南。

安全性

如果您发现任何与安全相关的问题,请通过电子邮件contact@thangnm.info联系。

鸣谢