README

重要

此存储库和项目不由 PostHog 支持。

非官方的 PostHog SDK for Symfony

这是 PostHog 的非官方 Symfony SDK。

入门指南

使用此 posthog-symfony SDK 可为您带来以下好处

快速集成和配置 PostHog 至您的 Symfony 应用
默认情况下，每个事件将包含以下数据
- 当前认证用户
- Symfony 环境

安装

要安装 SDK，您需要在项目中使用 Composer。有关安装说明，请参阅文档。

composer require sanderverkuil/posthog-symfony

启用 Bundle

如果您使用 Flex 食谱安装了包，则 Bundle 将自动启用。否则，您需要将 Bundle 添加到项目 Kernel.php 文件中注册的 Bundle 列表中以启用它。

class AppKernel extends \Symfony\Component\HttpKernel\Kernel
{
    public function registerBundles(): array
    {
        return [
            // ...
            new \PostHog\PostHogBundle\PostHogBundle(),
        ];
    }

    // ...
}

默认情况下，Bundle 将在所有环境中启用。要启用事件报告，您需要添加一个密钥（请参阅下一步）。

配置

添加您的项目 PostHog 密钥。将密钥添加到您的 config/packages/posthog.yaml 文件中。

请注意，如果您将 key 值留空（或未声明），将禁用 PostHog 集成：

post_hog:
    key: "<ph_project_api_key>"
    host: "https://app.posthog.com/" # Or https://eu.posthog.com/ for EU

可选：使用自定义 HTTP 工厂/传输

这使用 HTTPlug 以保持传输无关性，您需要安装两个提供 php-http/async-client-implementation 和 psr/http-message-implementation 的包。

建议的包包括

Symfony HTTP 客户端 (symfony/http-client)
Guzzle 的消息工厂 (http-interop/http-factory-guzzle)

维护版本

0.x 正在 master 分支上积极维护和开发，并使用 PostHog SDK 3.0；

为 SDK 贡献

请参阅 CONTRIBUTING.md。

许可协议

在 MIT 许可协议下发布，请参阅 LICENSE。

致谢

我要感谢 @getsentry，他们的灵感是如何设置一个 symfony bundle 的一些通用事情。
我要感谢 @posthog 的产品。

sanderverkuil / posthog-symfony

维护者

详细信息