README

本包为Objective PHP应用程序提供Audit客户端集成。

安装

Audit Package需要PHP 7.0或更高版本才能正常运行。

您需要使用以下命令将其集成到Objective PHP项目中： composer require fei/audit-package。

集成

如下所示，Audit Package必须连接到应用程序的初始化方法。

<?php

use ObjectivePHP\Application\AbstractApplication;
use Fei\Service\Audit\Package\AuditPackage;

class Application extends AbstractApplication
{
    public function init()
    {
        // Define some application steps
        $this->addSteps('init', 'bootstrap', 'auth', 'route', 'rendering');
        
        // Initializations...

        // Plugging the Audit Package in the bootstrap step
        $this->getStep('bootstrap')
        ->plug(AuditPackage::class);

        // Other initializations...
    }
}

Audit Package创建一个Audit客户端服务，该服务将通过带有"audit.client"作为默认标识符的ServicesFactory依赖容器暴露给应用程序。然后，您可以从工厂中获取任何其他服务一样获取审计客户端

class AnyMiddleware {

    public function __invoke(ApplicationInterface $app) {
        // please note that it's a better practice to inject the audit client 
        // into the middleware rather than pulling it from the container
        $auditClient = $app->getServicesFactory()->get('audit.client');
    }

}

应用程序配置

在配置目录中创建一个文件或编辑现有的文件，并将以下Audit配置放入其中

<?php
use Fei\Service\Audit\Client\Audit;
use Fei\Service\Audit\Package\Config\AuditParam;
return [
    new AuditParam([Audit::OPTION_BASEURL => 'http://audit.dev:8181']),
];

在上面的示例中，您需要设置以下配置

• AuditParam期望一个数组，允许以下选项

  • Audit::OPTION_BASEURL：表示可以发送邮件的API可以联系到的URL

请查看audit-client文档以获取有关如何使用此客户端的更多信息。