README

Kirby 3/4 插件，用于连接 Kirby 到 Posthog

安装

使用 composer

composer require bnomei/kirby3-posthog

使用 git 子模块

git submodule add https://github.com/bnomei/kirby3-posthog.git site/plugins/kirby3-posthog

使用下载和复制：下载最新版本并复制到 site/plugins

商业使用

支持开源！

此插件免费，但如果您在商业项目中使用它，请考虑赞助我或捐款。
如果我的工作帮助您赚到钱，那么我得到一些回报似乎也是公平的，对吧？

友善一点。分享一点。谢谢。

－ Bruno

设置

您可以在配置中设置 apikey 和主机。

site/config/config.php

return [
    // other config settings ...
    'bnomei.posthog.apikey' => 'YOUR-KEY-HERE',
    'bnomei.posthog.host' => 'YOUR-HOST-HERE',
];

如果您使用的是 dotenv 插件，您也可以设置一个回调。

site/config/config.php

return [
    // other config settings ...
    'bnomei.posthog.apikey' => function() { return env('POSTHOG_APIKEY'); },
    'bnomei.posthog.host' => function() { return env('POSTHOG_HOST'); },
];

JavaScript

通过插件中包含的片段输出跟踪 JavaScript。

  <?php snippet('posthog'); ?>
  </body>
</html>

用法

PHP 跟踪页面视图

site/template/default.php

<?php
// track page view event for current kirby user or identified posthog user
$page->posthogCapturePageView();

// be careful to not have any whitespace before <html>
><html>
    <!-- ... --->
</html>

PHP 辅助函数

使用 posthog() 辅助函数访问 Posthog。您可以使用 Posthog PHP 库中的所有方法。

<?php

posthog()->capture([
    'distinctId' => site()->posthogDistinctId(),
    'event' => 'movie played',
    'properties' => array(
        'movieId' => '123',
        'category' => 'romcom'
    )
])

注意：官方 posthog 文档中的静态类不支持。

除了 posthog() 辅助函数之外，此插件还为原始库添加以下功能。

默认在 localhost 上禁用
功能标志列表缓存 - 否则每次访问列表时都会向您的 posthog 实例发送一个 HTTP 请求。对于每个功能标志检查，它仍然会发送一个。

设置

有关 apikey 和 personalapikey 的更多信息，请参阅： https://posthog.com/docs/api

依赖

Posthog PHP

免责声明

此插件“按原样”提供，不提供任何保证。自行承担使用风险，并在将其用于生产环境之前自行测试。

许可

MIT

不建议在推广种族主义、性别歧视、同性恋恐惧症、动物虐待、暴力或其他任何形式的仇恨言论的项目中使用此插件。

bnomei / kirby3-posthog

维护者

详细信息