vincentbean/laravel-plausible

Laravel Plausible

2.1.2 2024-03-09 14:06 UTC

This package is auto-updated.

Last update: 2024-09-09 15:11:11 UTC


README

Tests Coverage Analysis Total downloads

此包提供带有脚本标签的blade视图以及一个用于轻松发送自定义事件的Plausible包装器。

安装

您可以通过composer安装此包

composer require vincentbean/laravel-plausible

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="VincentBean\Plausible\LaravelPlausibleServiceProvider" --tag="config"

将以下内容添加到您的env文件中

PLAUSIBLE_TRACKING_DOMAIN=DOMAIN_YOU_WANT_TO_TRACK
PLAUSIBLE_DOMAIN=OPTIONAL_IF_SELF_HOSTING

用法

此包支持客户端和服务器端跟踪。

客户端跟踪

将组件包含在您的布局中,以添加plausible脚本,可选跟踪扩展。

<x-plausible::tracking />
or
<x-plausible::tracking extensions="hash, outbound-links, etc.." />

Plausible将通过window对象提供,以便通过JavaScript发送自定义事件

plausible('event')

服务器端跟踪

使用中间件在服务器端跟踪页面访问量。

// app/Http/Kernel.php
    'web' => [
        // Add this middleware to the web group to track globally
        \VincentBean\Plausible\Middleware\TrackPlausiblePageviews::class,
    ],

自定义事件

您可以在服务器上触发自定义事件。

\VincentBean\Plausible\Events\PlausibleEvent::fire('custom event', ['country' => 'netherlands']);

如果从队列作业或事件监听器触发事件,可能需要传递用户的ipuser-agent字符串,这些字符串由Plausible用于生成用户会话ID。

\VincentBean\Plausible\Events\PlausibleEvent::fire('custom event', ['country' => 'netherlands'], headers: [
    'X-Forwarded-For' => $event->userIp,
    'user-agent' => $event->userAgent
]);

更新日志

请参阅更新日志以获取有关最近更改的更多信息。

贡献

请参阅贡献指南以获取详细信息。

鸣谢

许可协议

MIT许可协议(MIT)。请参阅许可文件以获取更多信息。