lancodev/laravel-analytics

0.7 2023-01-03 15:13 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

本软件包提供了一种简单的方法,在现有的Laravel应用程序中捕获网站分析数据。

安装

使用composer安装该软件包

composer require lancodev/laravel-analytics

发布组件和视图

php artisan vendor:publish --tag="laravel-analytics-components"
php artisan vendor:publish --tag="analytics-views"

运行软件包的安装命令

php artisan analytics:install

使用方法

可追踪特性

该软件包提供了一个可选的 Trackable 特性,可以用来将页面访问分析分配给一个模型。该特性提供了一个 pageViews 关联,可以用来检索该模型的页面访问。

这通常是由 User 模型实现的。然而,也可以由任何其他您希望跟踪页面访问的模型实现。

要使用该特性,只需将以下内容添加到您的模型中

namespace App\Models;

use Lancodev\LaravelAnalytics\Traits\Trackable;

class User
{
    use Trackable;
}

跟踪

要开始跟踪分析,将 <x-analytics-analytics /> 组件添加到您的布局文件中。这将向您的应用程序添加必要的JavaScript。

<html>
    <head>
        <title>My Application</title>
    </head>
    <body>
        ``` content ```

        <x-analytics-analytics />
    </body>
</html>

<x-analytics-analytics /> 组件接受以下属性

  • trackable: 要追踪的可变实体
    • 示例: <x-analytics-analytics :trackable="auth()->user()" />
    • 这将将与当前用户关联所有页面访问分析

分析仪表板

该软件包还提供了一个简单的仪表板组件,可以用来显示应用程序的分析数据。

可以通过添加以下内容将仪表板添加到任何视图中

<x-analytics-dashboard />

这将在您的页面中添加以下内容

analyticsdashboardscreenshot.png

测试

composer test

变更日志

有关最近更改的更多信息,请参阅变更日志

贡献

有关详细信息,请参阅贡献指南

安全漏洞

请查阅我们的安全策略了解如何报告安全漏洞。

鸣谢

许可证

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