README

此 Laravel >= 6.0 包允许您将视图与 Eloquent 模型关联。

安装后，您可以进行如下操作

// Return total views count
views($post)->count();

// Return total views count that have been made since 20 February 2017
views($post)->period(Period::since('2017-02-20'))->count();

// Return total views count that have been made between 2014 and 2016
views($post)->period(Period::create('2014', '2016'))->count();

// Return total unique views count (based on visitor cookie)
views($post)->unique()->count();

// Record a view
views($post)->record();

// Record a view with a cooldown
views($post)->cooldown(now()->addHours(2))->record();

概述

有时您不想引入第三方服务（如 Google Analytics）来跟踪您的应用程序的页面访问量。这时，这个包就派上用场了。Eloquent Viewable 允许您轻松地将视图与 Eloquent 模型关联起来。它注重简洁性。

此包将每个视图记录单独存储在数据库中。这样做的好处是可以进行非常具体的计数。例如，如果我们想了解在 2018 年 1 月 10 日至 2 月 17 日之间有多少人查看了一篇特定的帖子，我们可以这样做： views($post)->period(Period::create('10-01-2018', '17-02-2018'))->count();。缺点是，根据您的应用程序的访问者数量，您的数据库可能会 迅速增长。

特性

以下是主要特性

将视图与 Eloquent 模型关联
获取总访问量
获取特定时期的访问量
获取唯一访问量
获取可查看类型的访问量（Eloquent 模型类）
按访问量排序可查看项
设置访问间的冷却时间
内置优雅的缓存包装器
忽略爬虫、被忽略的 IP 地址或带有 DNT 标头的请求的访问量

文档

在本文档中，您可以找到有关使用此 Laravel 包的一些有用信息。

入门

要求

本包需要 PHP 7.4+ 和 Laravel 6+。

Lumen 的支持未维护。

版本信息

安装

首先，您需要通过 Composer 安装包

composer require cyrildewit/eloquent-viewable

其次，您可以使用以下命令发布迁移

php artisan vendor:publish --provider="CyrildeWit\EloquentViewable\EloquentViewableServiceProvider" --tag="migrations"

最后，您需要运行 migrate 命令

php artisan migrate

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

php artisan vendor:publish --provider="CyrildeWit\EloquentViewable\EloquentViewableServiceProvider" --tag="config"

手动注册服务提供者

如果您更喜欢手动注册包，您可以将以下提供者添加到您应用程序的提供者列表中。

// config/app.php

'providers' => [
    // ...
    CyrildeWit\EloquentViewable\EloquentViewableServiceProvider::class,
];

使用

准备您的模型

要将视图与模型关联，该模型必须实现以下接口和特质

接口： CyrildeWit\EloquentViewable\Contracts\Viewable
特质： CyrildeWit\EloquentViewable\InteractsWithViews

示例

use Illuminate\Database\Eloquent\Model;
use CyrildeWit\EloquentViewable\InteractsWithViews;
use CyrildeWit\EloquentViewable\Contracts\Viewable;

class Post extends Model implements Viewable
{
    use InteractsWithViews;

    // ...
}

记录访问量

要创建视图记录，您可以在流畅的 Views 实例上调用 record 方法。

views($post)->record();

记录访客的访问的最佳位置是在您的控制器中。例如

// PostController.php
public function show(Post $post)
{
    views($post)->record();

    return view('post.show', compact('post'));
}

注意：此包默认会过滤掉爬虫。测试时请注意这一点，因为Postman例如也是一个爬虫。

设置冷却时间

您可以在Views实例上使用cooldown方法在视图记录之间添加冷却时间。当您设置冷却时间时，需要指定分钟数。

views($post)
    ->cooldown($minutes)
    ->record();

除了传递整数分钟数之外，您还可以传递一个DateTimeInterface实例。

$expiresAt = now()->addHours(3);

views($post)
    ->cooldown($expiresAt)
    ->record();

工作原理

当使用会话延迟记录视图时，此包还会在访问者的会话中保存视图的快照以及过期日期时间。每次访问者再次查看项目时，此包都会检查其会话并决定是否将视图保存到数据库中。

检索访问量

获取总访问量

views($post)->count();

获取特定时期的访问量

use CyrildeWit\EloquentViewable\Support\Period;

// Example: get views count from 2017 upto 2018
views($post)
    ->period(Period::create('2017', '2018'))
    ->count();

此包附带的Period类提供了许多实用功能。Period类的API如下所示

两个日期时间之间

$startDateTime = Carbon::createFromDate(2017, 4, 12);
$endDateTime = '2017-06-12';

Period::create($startDateTime, $endDateTime);

自一个日期时间以来

Period::since(Carbon::create(2017));

至一个日期时间

Period::upto(Carbon::createFromDate(2018, 6, 1));

自过去以来

使用Carbon::today()作为起始日期时间减去给定的单位。

Period::pastDays(int $days);
Period::pastWeeks(int $weeks);
Period::pastMonths(int $months);
Period::pastYears(int $years);

自子以来

使用Carbon::now()作为起始日期时间减去给定的单位。

Period::subSeconds(int $seconds);
Period::subMinutes(int $minutes);
Period::subHours(int $hours);
Period::subDays(int $days);
Period::subWeeks(int $weeks);
Period::subMonths(int $months);
Period::subYears(int $years);

获取总唯一访问量

如果您只想检索唯一的视图数，您可以直接在链中添加unique方法。

views($post)
    ->unique()
    ->count();

按访问量排序模型

Viewable特质为您模型添加了两个作用域：orderByViews和orderByUniqueViews。

按访问量排序

Post::orderByViews()->get(); // descending
Post::orderByViews('asc')->get(); // ascending

按唯一访问量排序

Post::orderByUniqueViews()->get(); // descending
Post::orderByUniqueViews('asc')->get(); // ascending

按指定时期的访问量排序

Post::orderByViews('asc', Period::pastDays(3))->get();  // descending
Post::orderByViews('desc', Period::pastDays(3))->get(); // ascending

当然，您也可以使用唯一视图变体

Post::orderByUniqueViews('asc', Period::pastDays(3))->get();  // descending
Post::orderByUniqueViews('desc', Period::pastDays(3))->get(); // ascending

按指定集合的访问量排序

Post::orderByViews('asc', null, 'custom-collection')->get();  // descending
Post::orderByViews('desc', null, 'custom-collection')->get(); // ascending

Post::orderByUniqueViews('asc', null, 'custom-collection')->get();  // descending
Post::orderByUniqueViews('desc', null, 'custom-collection')->get(); // ascending

获取可查看类型的访问量

如果您想知道特定可查看类型的视图数，您需要像这样将一个空的Eloquent模型传递给views助手

views(new Post())->count();

您还可以传递一个完全限定的类名。然后，包将从这个应用程序容器中解析出一个实例。

views(Post::class)->count();
views('App\Post')->count();

查看集合

如果您为同一可查看类型有不同的视图类型，您可能希望将它们存储在其自己的集合中。

views($post)
    ->collection('customCollection')
    ->record();

要检索特定集合中的视图数，您可以使用相同的collection方法。

views($post)
    ->collection('customCollection')
    ->count();

删除时移除访问量

要自动删除可查看Eloquent模型上的所有视图，您可以在模型定义中将removeViewsOnDelete属性设置为true。

protected $removeViewsOnDelete = true;

缓存访问量

在某些场景中，缓存视图数可能具有挑战性。例如，周期可能是动态的，这使得缓存变得不可能。这就是为什么您可以利用内置的缓存功能。

要缓存视图数，只需将remember方法添加到链中。默认生命周期是永远。

示例

views($post)->remember()->count();
views($post)->period(Period::create('2018-01-24', '2018-05-22'))->remember()->count();
views($post)->period(Period::upto('2018-11-10'))->unique()->remember()->count();
views($post)->period(Period::pastMonths(2))->remember()->count();
views($post)->period(Period::subHours(6))->remember()->count();

// Cache for 3600 seconds
views($post)->remember(3600)->count();

// Cache until the defined DateTime
views($post)->remember(now()->addWeeks(2))->count();

// Cache forever
views($post)->remember()->count();

优化

基准

数据库索引

默认的views迁移文件已经为viewable_id和viewable_type添加了两个索引。

如果您有足够的存储空间，您可以添加另一个索引到visitor列。根据视图的数量，这可能会在某些情况下加快查询速度。

缓存

缓存视图数可能对应用程序的性能产生重大影响。您可以在这里阅读有关缓存视图数的文档

使用remember方法只会缓存由count方法制作的视图数。orderByViews和orderByUnique查询作用域不使用这些值，因为它们只向查询构建器添加了一些东西。为了优化这些查询，您可以在可查看数据库表中添加一个或多个具有这些计数的额外列。

示例：我们想要根据唯一视图数对博客文章进行排序。首先可能想到的是使用orderByUniqueViews查询作用域。

$posts = Post::latest()->orderByUniqueViews()->paginate(20);

当您存储了很多视图时，这个查询会相当慢。为了加快速度，您可以在posts表中添加例如一个unique_views_count列。我们将不得不定期更新这个列的唯一视图数。这可以通过使用计划的Laravel命令轻松实现。

可能还有更快的方法来做这件事，但这样的命令可能像

$posts = Post::all();

foreach($posts as $post) {
    $post->unique_views_count = views($post)->unique()->count();
}

待更新！Laravel有一个很好的块和光标功能，可能会派上用场。

扩展

如果您想用自己的实现扩展或替换核心类之一，您可以覆盖它们

CyrildeWit\EloquentViewable\Views
CyrildeWit\EloquentViewable\View
CyrildeWit\EloquentViewable\Visitor
CyrildeWit\EloquentViewable\CrawlerDetectAdapter

注意：别忘了所有自定义类都必须实现它们原始的接口

自定义访客信息

Visitor 类负责向 Views 构建器提供有关当前访客的信息。以下信息提供

一个唯一的标识符（存储在cookie中）
IP地址
检查Do Not Track头
检查爬虫

默认的 Visitor 类从请求中获取其信息。因此，当您通过RESTful API使用 Views 构建器时，可能会遇到一些问题。要解决这个问题，您需要提供有关访客的自己的数据。

您可以在全局或局部覆盖 Visitor 类。

创建自己的 `Visitor` 类

在您的Laravel应用程序中创建自己的 Visitor 类并实现 CyrildeWit\EloquentViewable\Contracts\Visitor 接口。创建接口所需的方法。

或者，您可以扩展本包附带默认的 Visitor 类。

全局

只需将您的自定义 Visitor 实现绑定到 CyrildeWit\EloquentViewable\Contracts\Visitor 合同。

$this->app->bind(
    \CyrildeWit\EloquentViewable\Contracts\Visitor::class,
    \App\Services\Views\Visitor::class
);

局部

您也可以使用 Views 构建器上的 useVisitor 设置器方法设置访客实例。

use App\Services\Views\Visitor;

views($post)
    ->useVisitor(new Visitor()) // or app(Visitor::class)
    ->record();

使用您自己的 `Views` Eloquent模型

将您的自定义 Views 实现绑定到 \CyrildeWit\EloquentViewable\Contracts\Views。

更改以下代码片段，并将其放置在服务提供者（例如 AppServiceProvider）的 register 方法中。

$this->app->bind(
    \CyrildeWit\EloquentViewable\Contracts\Views::class,
    \App\Services\Views\Views::class
);

使用您自己的 `View` Eloquent模型

将您的自定义 View 实现绑定到 \CyrildeWit\EloquentViewable\Contracts\View。

更改以下代码片段，并将其放置在服务提供者（例如 AppServiceProvider）的 register 方法中。

$this->app->bind(
    \CyrildeWit\EloquentViewable\Contracts\View::class,
    \App\Models\View::class
);

使用自定义爬虫检测器

绑定您的自定义 CrawlerDetector 实现到 \CyrildeWit\EloquentViewable\Contracts\CrawlerDetector。

更改以下代码片段，并将其放置在服务提供者（例如 AppServiceProvider）的 register 方法中。

$this->app->singleton(
    \CyrildeWit\EloquentViewable\Contracts\CrawlerDetector::class,
    \App\Services\Views\CustomCrawlerDetectorAdapter::class
);

向 `Views` 类添加宏

use CyrildeWit\EloquentViewable\Views;

Views::macro('countAndRemember', function () {
    return $this->remember()->count();
});

现在您可以使用这个简写方式

views($post)->countAndRemember();

Views::forViewable($post)->countAndRemember();

升级

请参阅UPGRADING以获取详细的升级指南。

变更日志

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

贡献

请参阅CONTRIBUTING以获取详细信息。

致谢

Cyril de Wit - 初始工作 - cyrildewit

请参阅参与此项目的贡献者列表。

有用的资源

在Laravel中实现页面查看计数器 - Stidges

替代方案

随时添加更多替代方案！

许可证

本项目采用MIT许可证 - 请参阅LICENSE文件以获取详细信息。

cyrildewit / eloquent-viewable

维护者

详细信息

README

概述

特性

文档

目录

入门

要求

版本信息

安装

手动注册服务提供者

使用

准备您的模型

记录访问量

设置冷却时间

工作原理

检索访问量

获取总访问量

获取特定时期的访问量

两个日期时间之间

自一个日期时间以来

至一个日期时间

自过去以来

自子以来

获取总唯一访问量

按访问量排序模型

按访问量排序

按唯一访问量排序

按指定时期的访问量排序

按指定集合的访问量排序

获取可查看类型的访问量

查看集合

删除时移除访问量

缓存访问量

优化

基准

数据库索引

缓存

扩展

自定义访客信息

创建自己的 Visitor 类

全局

局部

使用您自己的 Views Eloquent模型

使用您自己的 View Eloquent模型

使用自定义爬虫检测器

向 Views 类添加宏

升级

变更日志

贡献

致谢

替代方案

许可证

创建自己的 `Visitor` 类

使用您自己的 `Views` Eloquent模型

使用您自己的 `View` Eloquent模型

向 `Views` 类添加宏