modera/activity-logger-bundle

v3.1.0 2021-09-05 12:51 UTC

README

此包提供设施,允许您记录在应用程序逻辑执行过程中发生的不同域事件。之后,您可以查询这些已记录的事件(在本包范围内称为活动)。关键点是,以后这些活动可以由普通用户审核,以查看系统中发生了什么。

除非您需要在应用程序逻辑中查询活动,否则请依靠通用的Psr的LoggerInterface接口来记录您的活动。

安装

步骤 1:下载包

composer require modera/activity-logger-bundle:4.x-dev

此命令要求您全局安装了Composer,如Composer文档中的安装章节所述。

步骤 2:启用包

此包应由Flex自动启用。如果您不使用Flex,则需要手动通过在项目的config/bundles.php文件中添加以下行来启用包:

<?php
// config/bundles.php

return [
    // ...
    Modera\ActivityLoggerBundle\ModeraActivityLoggerBundle::class => ['all' => true],
];

文档

要记录您的活动,您将使用标准Psr\Log\LoggerInterface接口的实现,这意味着您的应用程序不会直接依赖于此包,而是依赖于一个通用的接口,您可以在以后切换(例如,如果您决定使用某个默认的Monolog日志处理器),如果需要的话。

此包声明了两个附加接口 - Modera\ActivityLoggerBundle\Manager\ActivityManagerInterfaceModera\ActivityLoggerBundle\Model\ActivityInterface。前者扩展了Psr的LoggerInterface并添加了一个方法 - "查询",此方法可用于查询活动。此方法返回的活动是ActivityInterface的实现。默认情况下,此包提供ActivityManagerInterface的一个实现,该实现使用Doctrine ORM的EntityManager存储活动 - Modera\ActivityLoggerBundle\Manager\DoctrineOrmActivityManager

许可

此包采用MIT许可证。请参阅包中的完整许可证:Resources/meta/LICENSE