README

用于管理 PHP 的 Plausible 追踪的简单包。

安装

您可以通过 composer 安装此包

composer require marekzelezny/plausible

将以下行添加到布局文件的 <head> 标签中

<x-plausible::script />

将配置文件 config/plausible.php 中的 plausible 域添加到环境文件中

PLAUSIBLE_DOMAIN=example.com

使用方法

您可以启用以下 Plausible 功能的追踪

页面浏览的定制属性
外链点击
文件下载

页面浏览的定制属性

要启用此功能，您必须在环境文件中添加以下行

PLAUSIBLE_TRACKING_PAGEVIEW_PROPS=true

然后您可以通过在控制器中使用函数 plausible() 来添加自定义属性到您的页面

示例用法

plausible()
    ->property('pageType', 'article')
    ->property('category', 'news');

这将返回以下内容到您添加了 <x-plausible::script /> 的页面

<script defer data-domain="example.com" src="https://#/js/script.manual.pageview-props.js"></script>
<script>
    window.plausible = window.plausible || function() {
        (window.plausible.q = window.plausible.q || []).push(arguments)
    }

    plausible('pageview', {
        props: {
            pageType: 'article',
            category: 'news'
        }
    });
</script>

您也可以一次添加一个属性的多个值

plausible()
    ->property('author', ['John Doe', 'Jane Doe'])

这将通过调用添加一个属性的多个值

plausible('pageview', {
    props: {author: 'John Doe'}
});

plausible('pageview', {
    props: {author: 'Jane Doe'}
});

这是目前向一个属性添加多个值的唯一方法，因为 Plausible 还不支持数组。

全局默认属性

您还可以通过在应用程序服务提供者的 boot() 方法中添加来设置所有页面视图的全局默认属性。

外链点击、文件下载

外链和文件下载需要在 Plausible 控制台中设置额外的目标。您可能可以在这里获取更多信息。

一旦您在 Plausible 控制台中设置了目标，您就可以启用这些功能的追踪

PLAUSIBLE_TRACKING_OUTBOUND_LINK_CLICKS=true
PLAUSIBLE_TRACKING_FILE_DOWNLOADS=true

这将添加用于追踪外链点击和文件下载的 Plausible 脚本，然后它们会自动追踪。

marekzelezny / plausible

维护者

详细信息

README

安装

使用方法

页面浏览的定制属性

全局默认属性

外链点击、文件下载