README

Kirby Plugin for interfacing with Posthog

Install

unzip master.zip as folder site/plugins/kirby3-posthog or
git submodule add https://github.com/bnomei/kirby3-posthog.git site/plugins/kirby3-posthog or
composer require bnomei/kirby3-posthog

Setup

You can set the apikey and host in the config.

site/config/config.php

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

You can also set a callback if you use the dotenv Plugin.

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

Output the tracking Javascript via the snippet included in the plugin.

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

Usage

PHP track pageview

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 helper function

Use the posthog()-helper to access Posthog. You can use all methods from the Posthog PHP library.

<?php

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

In addition to the posthog()-helper this plugin adds the following features to the original library.

Disabled on localhost by default
Cache for Feature Flag list - it would otherwise send a http request to your posthog instance every time you access the list. It still will send one for every feature flag check.

Warning

Using the static class from the official Posthog docs is not supported.

Settings

bnomei.posthog.	Default	Description
apikey	`string or callback`
personalapikey	`string or callback`
host	`string or callback`
enabled	`true or false or 'force'`	but disabled on localhost setups by default
featureflags	`1`	duration (in minutes) to cache the feature flags in minutes

Tip

Read more about apikey and personalapikey here: https://posthog.com/docs/api

Dependencies

Posthog PHP

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.

bnomei/kirby3-posthog

包简介

关键字：

README 文档